From 84f74b8317abce8e49ad1dbef50c4c309d83f154 Mon Sep 17 00:00:00 2001 From: Dean Ganczarski Date: Thu, 21 Nov 2024 14:31:29 -0500 Subject: [PATCH] - Remove top row html tags from modelcenter-api-md docs - Remove top of page navigation additions from modelcenter-java-api-md docs --- .../ComponentPlugIn_8odl.md | 135 +- .../modelcenter-api-md/ModelCenter_8odl.md | 4891 +++++----- .../PHXDataExplorer_8odl.md | 551 +- .../modelcenter-api-md/PHXDataHistory_8odl.md | 937 +- .../modelcenter-api-md/PlugInMetaData_8odl.md | 135 +- .../TradeStudyPlugIn_8odl.md | 619 +- .../classModelCenter_1_1Application.md | 31 +- ...ssPHXDATAEXPLORERLib_1_1PHXDataExplorer.md | 31 +- ...TAEXPLORERLib_1_1PHXDataExplorerPointer.md | 31 +- ...STORYLib_1_1DataHistoryVariableMetadata.md | 31 +- ...lassPHXDATAHISTORYLib_1_1PHXDataHistory.md | 31 +- ...assTradeStudyPlugIn_1_1TradeStudyPlugIn.md | 31 +- ...ssTradeStudyPlugIn_1_1TradeStudyPlugIn2.md | 31 +- .../modelcenter-api-md/class_contents.md | 16 +- .../modelcenter-api-md/class_index.md | 32 +- .../modelcenter-api-md/deprecated.md | 131 +- .../dir_254da5db084e40f61f0f3ecf2de92ae0.md | 29 +- .../dir_3deb6222fdd4eb7b0f76591cf78ec6d0.md | 29 +- .../dir_4c5da7dd69977c70a414920e45f0e4dd.md | 31 +- .../dir_6384486296a61296aa9794364431ed6d.md | 29 +- .../dir_b61c1eebc2b964146e7860adc8b8cd2e.md | 29 +- .../dir_cb6cf9700ae02fb10e39761559b5fdeb.md | 41 +- .../modelcenter-api-md/dir_contents.md | 20 +- .../dir_e61251abb0949c61ea8ea7dc5fba4af2.md | 29 +- .../dir_f4b71a0ee7c6b8122721a969fd158e55.md | 29 +- .../dir_f8085194870fe60668985a445c75a643.md | 29 +- .../modelcenter-api-md/dir_index.md | 30 +- .../modelcenter-api-md/file_contents.md | 14 +- .../modelcenter-api-md/file_index.md | 36 +- .../modelcenter-api-md/global_contents.md | 3060 +++---- .../modelcenter-api-md/global_index.md | 3184 +++---- .../modelcenter-api-md/index.md | 40 +- ...faceComponentPlugIn_1_1IComponentPlugIn.md | 279 +- .../interfaceModelCenter_1_1IAddToModel.md | 1773 ++-- .../interfaceModelCenter_1_1IArray.md | 2773 +++--- .../interfaceModelCenter_1_1IAssemblies.md | 153 +- .../interfaceModelCenter_1_1IAssembly.md | 1299 ++- .../interfaceModelCenter_1_1IBooleanArray.md | 2673 +++--- ...nterfaceModelCenter_1_1IBooleanVariable.md | 1655 ++-- .../interfaceModelCenter_1_1ICachePin.md | 331 +- .../interfaceModelCenter_1_1IComponent.md | 1351 ++- .../interfaceModelCenter_1_1IComponents.md | 153 +- ...erfaceModelCenter_1_1ICustomDesignPoint.md | 189 +- .../interfaceModelCenter_1_1IDataCollector.md | 1673 ++-- .../interfaceModelCenter_1_1IDataMonitor.md | 1617 ++-- .../interfaceModelCenter_1_1IDoubleArray.md | 3305 ++++--- ...interfaceModelCenter_1_1IDoubleVariable.md | 2245 +++-- .../interfaceModelCenter_1_1IFeature.md | 73 +- .../interfaceModelCenter_1_1IFileArray.md | 3009 ++++--- ...interfaceModelCenter_1_1IFileSystemInfo.md | 365 +- .../interfaceModelCenter_1_1IFileVariable.md | 2093 +++-- ...terfaceModelCenter_1_1IGeometryVariable.md | 1615 ++-- ...terfaceModelCenter_1_1IGlobalParameters.md | 341 +- .../interfaceModelCenter_1_1IGroup.md | 305 +- .../interfaceModelCenter_1_1IGroups.md | 153 +- .../interfaceModelCenter_1_1IIfComponent.md | 1525 ++-- .../interfaceModelCenter_1_1IIntegerArray.md | 3305 ++++--- ...nterfaceModelCenter_1_1IIntegerVariable.md | 2245 +++-- .../interfaceModelCenter_1_1IJobManager.md | 1677 ++-- .../interfaceModelCenter_1_1ILogger.md | 617 +- .../interfaceModelCenter_1_1ILoginCallback.md | 245 +- .../interfaceModelCenter_1_1IModelCenter.md | 7913 ++++++++--------- ...terfaceModelCenter_1_1INetworkLocations.md | 241 +- ...interfaceModelCenter_1_1IObjectVariable.md | 5275 ++++++----- .../interfaceModelCenter_1_1IPHXFormat.md | 677 +- .../interfaceModelCenter_1_1IRefArrayProp.md | 309 +- .../interfaceModelCenter_1_1IRefProp.md | 285 +- ...interfaceModelCenter_1_1IReferenceArray.md | 2989 ++++--- ...erfaceModelCenter_1_1IReferenceVariable.md | 1921 ++-- ...nterfaceModelCenter_1_1IScriptComponent.md | 1517 ++-- ...interfaceModelCenter_1_1IShowHelpEvents.md | 87 +- .../interfaceModelCenter_1_1IStringArray.md | 2755 +++--- ...interfaceModelCenter_1_1IStringVariable.md | 1735 ++-- ...terfaceModelCenter_1_1ITradeStudyEvents.md | 195 +- .../interfaceModelCenter_1_1IVariable.md | 2147 +++-- ...faceModelCenter_1_1IVariableDescription.md | 375 +- .../interfaceModelCenter_1_1IVariableLink.md | 229 +- .../interfaceModelCenter_1_1IVariableLinks.md | 153 +- .../interfaceModelCenter_1_1IVariables.md | 153 +- .../interfaceModelCenter_1_1IVizContainer.md | 335 +- ...EXPLORERLib_1_1IDataExplorerFacadeOwner.md | 31 +- ...ePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md | 115 +- ...cePHXDATAEXPLORERLib_1_1IPHXDEKeepalive.md | 31 +- ...AEXPLORERLib_1_1IPHXDataExplorerPointer.md | 73 +- ...cePHXDATAEXPLORERLib_1_1IPageVisibility.md | 291 +- ...HXDATAEXPLORERLib_1_1__DPHXDataExplorer.md | 3011 ++++--- ...EXPLORERLib_1_1__DPHXDataExplorerEvents.md | 31 +- ...terfacePHXDATAHISTORYLib_1_1IDHVariable.md | 1121 ++- ...rfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md | 295 +- ...erfacePHXDATAHISTORYLib_1_1ISaveContext.md | 455 +- ...STORYLib_1_1PHXDataExplorerExportPlugIn.md | 103 +- ...DATAHISTORYLib_1_1PHXDataExplorerPlugIn.md | 727 +- ...ePHXDATAHISTORYLib_1_1__DPHXDataHistory.md | 4601 +++++----- ...TAHISTORYLib_1_1__DPHXDataHistoryEvents.md | 397 +- ...AHISTORYLib_1_1__DPHXDataHistoryToModel.md | 395 +- ...erfacePlugInMetaData_1_1IPlugInMetaData.md | 253 +- ...faceTradeStudyPlugIn_1_1ICombinedPlugIn.md | 51 +- ...TradeStudyPlugIn_1_1ITradeStudy3JobInfo.md | 353 +- ...deStudyPlugIn_1_1ITradeStudy3JobManager.md | 987 +- ...adeStudyPlugIn_1_1ITradeStudy3JobResult.md | 549 +- ...TradeStudyPlugIn_1_1ITradeStudyCallback.md | 323 +- ...ceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md | 243 +- ...eTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md | 541 +- ...eTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md | 497 +- ...tudyPlugIn_1_1IVariableMetaDataProvider.md | 157 +- .../interfaceTradeStudyPlugIn_1_1IWindowed.md | 79 +- .../modelcenter-api-md/interface_contents.md | 150 +- .../modelcenter-api-md/interface_index.md | 172 +- .../namespaceComponentPlugIn.md | 121 +- .../namespaceModelCenter.md | 827 +- .../namespacePHXDATAEXPLORERLib.md | 137 +- .../namespacePHXDATAHISTORYLib.md | 311 +- .../namespacePlugInMetaData.md | 121 +- .../namespaceTradeStudyPlugIn.md | 143 +- .../modelcenter-api-md/namespace_contents.md | 14 +- .../modelcenter-api-md/namespace_index.md | 36 +- .../modelcenter-api-md/page_contents.md | 4 +- .../modelcenter-api-md/page_index.md | 8 +- ...ib_1_1DataHistoryVariableMetadataStruct.md | 677 +- ...HISTORYLib_1_1DataHistoryVariableStruct.md | 237 +- .../modelcenter-api-md/struct_contents.md | 6 +- .../modelcenter-api-md/struct_index.md | 10 +- .../modelcenter-java-api-md/index.md | 22 +- .../-a-w-t-exception-handler.md | 10 +- .../-a-w-t-exception-handler/handle.md | 10 +- .../-a-w-t-exception-handler/index.md | 44 +- .../-a-w-t-exception-handler/register.md | 10 +- .../-p-h-x-j-o-g-l/-p-h-x-j-o-g-l.md | 14 +- .../-p-h-x-j-o-g-l/create-list.md | 10 +- .../-p-h-x-j-o-g-l/get-exts.md | 10 +- .../-p-h-x-j-o-g-l/index.md | 38 +- .../-p-h-x-j-o-g-l/load-scripts.md | 10 +- .../index.md | 18 +- .../-logger/-logger.md | 14 +- .../-logger/debug.md | 42 +- .../-logger/error.md | 42 +- .../-logger/index.md | 68 +- .../-logger/info.md | 42 +- .../-logger/is-debug-enabled.md | 34 +- .../-logger/is-error-enabled.md | 34 +- .../-logger/is-info-enabled.md | 34 +- .../-logger/is-warn-enabled.md | 34 +- .../-logger/warn.md | 42 +- .../index.md | 16 +- .../-beanshell-util/-beanshell-util.md | 10 +- .../-beanshell-util/index.md | 46 +- .../-beanshell-util/run-script.md | 52 +- .../-logger-updater/-logger-updater.md | 30 +- .../-logger-updater/index.md | 56 +- .../-logger-updater/is-reset-resistant.md | 22 +- .../-logger-updater/on-level-change.md | 10 +- .../-logger-updater/on-reset.md | 30 +- .../-logger-updater/on-start.md | 30 +- .../-logger-updater/on-stop.md | 30 +- .../-logger-updater/stop.md | 14 +- .../-p-h-x-c-o-m-object-holder.md | 10 +- .../-p-h-x-c-o-m-object-holder/get-object.md | 10 +- .../-p-h-x-c-o-m-object-holder/index.md | 40 +- .../-p-h-x-c-o-m-object-holder/release.md | 10 +- .../set-object-main.md | 10 +- .../set-object-other.md | 10 +- .../-p-h-x-c-o-m-object/disable-g-c.md | 14 +- .../-p-h-x-c-o-m-object/index.md | 164 +- .../-p-h-x-c-o-m-object/release-objects.md | 18 +- .../-p-h-x-c-o-m-object/release.md | 30 +- .../set-reference-debug-mode.md | 14 +- .../-p-h-x-equation-parser.md | 14 +- .../-p-h-x-equation-parser/index.md | 34 +- .../-p-h-x-equation-parser/parse-equation.md | 10 +- .../-p-h-x-i-o-console/action-performed.md | 10 +- .../-p-h-x-i-o-console/dispose.md | 10 +- .../-p-h-x-i-o-console/index.md | 40 +- .../-p-h-x-i-o-console/is-showing.md | 10 +- .../-p-h-x-i-o-console/show.md | 10 +- .../-p-h-x-jar-location.md | 14 +- .../-p-h-x-jar-location/get-class-location.md | 38 +- .../-p-h-x-jar-location/index.md | 42 +- .../-p-h-x-m-c-jar-loader.md | 42 +- .../-p-h-x-m-c-jar-loader/class-exists.md | 10 +- .../-p-h-x-m-c-jar-loader/index.md | 96 +- .../-p-h-x-plug-in-launcher.md | 10 +- .../-p-h-x-plug-in-launcher/class-exists.md | 52 +- .../-p-h-x-plug-in-launcher/clean-up.md | 14 +- .../construct-model-center.md | 42 +- .../disable-i-o-console.md | 46 +- .../get-dummy-frame.md | 26 +- .../-p-h-x-plug-in-launcher/index.md | 62 +- .../launch-component-plug-in.md | 56 +- .../launch-data-collector-plug-in.md | 58 +- .../launch-plug-in-meta-data.md | 44 +- .../launch-trade-study-plug-in.md | 56 +- .../action-performed.md | 10 +- .../-p-h-x-reference-monitor/index.md | 54 +- .../item-state-changed.md | 10 +- .../-p-h-x-reference-monitor/show-monitor.md | 10 +- .../-p-h-x-reference-monitor/value-changed.md | 10 +- .../window-activated.md | 10 +- .../-p-h-x-reference-monitor/window-closed.md | 10 +- .../window-closing.md | 10 +- .../window-deactivated.md | 10 +- .../window-deiconified.md | 10 +- .../window-iconified.md | 10 +- .../-p-h-x-reference-monitor/window-opened.md | 10 +- .../-p-h-x-u-r-l-class-loader.md | 18 +- .../-p-h-x-u-r-l-class-loader/add-u-r-l2.md | 30 +- .../get-resource-as-stream.md | 34 +- .../-p-h-x-u-r-l-class-loader/get-resource.md | 34 +- .../-p-h-x-u-r-l-class-loader/index.md | 98 +- .../-p-h-x-u-r-l-class-loader/load-class.md | 50 +- .../-value-holder/-value-holder.md | 24 +- .../-value-holder/index.md | 46 +- .../-value-holder/value.md | 14 +- .../com.phoenix_int.ModelCenter.util/index.md | 38 +- .../-add-to-model/-add-to-model.md | 14 +- .../-add-to-model/add-input.md | 86 +- .../-add-to-model/add-input2.md | 88 +- .../-add-to-model/add-method.md | 44 +- .../-add-to-model/add-output.md | 86 +- .../-add-to-model/add-output2.md | 88 +- .../-add-to-model/add-to-model.md | 26 +- .../-add-to-model/add-to-model2.md | 34 +- .../-add-to-model/add-to-model3.md | 10 +- .../-add-to-model/clear-busy-flag.md | 26 +- .../-add-to-model/get-auto-run.md | 34 +- .../-add-to-model/get-component.md | 26 +- .../-add-to-model/get-prevalidate-inputs.md | 34 +- .../-add-to-model/get-prog-i-d.md | 26 +- .../-add-to-model/get-reg-i-d.md | 26 +- .../-add-to-model/index.md | 102 +- .../-add-to-model/new-instance.md | 34 +- .../-add-to-model/set-author.md | 42 +- .../-add-to-model/set-auto-run.md | 42 +- .../set-component-requirements.md | 42 +- .../-add-to-model/set-description.md | 42 +- .../-add-to-model/set-help-u-r-l.md | 42 +- .../-add-to-model/set-icon.md | 42 +- .../-add-to-model/set-keywords.md | 42 +- .../-add-to-model/set-prevalidate-inputs.md | 42 +- .../-add-to-model/set-version.md | 42 +- .../-add-to-model/update-component.md | 26 +- .../-array/from-string.md | 44 +- .../-array/get-auto-size.md | 34 +- .../-array/get-dimensions.md | 22 +- .../-array/get-length.md | 80 +- .../-array/get-num-dimensions.md | 34 +- .../-array/get-size.md | 80 +- .../-array/index.md | 138 +- .../-array/set-auto-size.md | 42 +- .../-array/set-dimensions.md | 474 +- .../-array/set-length.md | 82 +- .../-array/set-num-dimensions.md | 42 +- .../-array/set-size.md | 82 +- .../-array/to-string-absolute.md | 50 +- .../-array/to-string.md | 50 +- .../-assembly/-a-s-s-e-m-b-l-y.md | 14 +- .../-assembly/-f-o-r_-e-a-c-h.md | 26 +- .../-assembly/-i-f.md | 14 +- .../-assembly/-l-o-o-p.md | 14 +- .../-assembly/-p-a-r-a-l-l-e-l.md | 14 +- .../-assembly/-s-e-q-u-e-n-c-e.md | 14 +- .../-assembly/add-assembly.md | 98 +- .../-assembly/add-assembly2.md | 106 +- .../-assembly/add-variable.md | 52 +- .../-assembly/convert-to-submodel.md | 14 +- .../-assembly/delete-variable.md | 42 +- .../-assembly/get-assembly-type.md | 34 +- .../-assembly/get-assembly.md | 96 +- .../-assembly/get-component.md | 96 +- .../-assembly/get-full-name.md | 34 +- .../-assembly/get-group.md | 96 +- .../-assembly/get-icon-i-d.md | 22 +- .../-assembly/get-index-in-parent.md | 22 +- .../-assembly/get-metadata.md | 50 +- .../-assembly/get-name.md | 34 +- .../-assembly/get-num-assemblies.md | 34 +- .../-assembly/get-num-components.md | 34 +- .../-assembly/get-num-groups.md | 34 +- .../-assembly/get-num-variables.md | 34 +- .../-assembly/get-parent-assembly.md | 34 +- .../-assembly/get-position-x.md | 34 +- .../-assembly/get-position-y.md | 34 +- .../-assembly/get-user-data.md | 26 +- .../-assembly/get-variable.md | 96 +- .../-assembly/index.md | 116 +- .../-assembly/rename.md | 30 +- .../-assembly/set-icon-i-d.md | 30 +- .../-assembly/set-metadata.md | 50 +- .../-assembly/set-user-data.md | 42 +- .../-boolean-array/get-description.md | 34 +- .../-boolean-array/get-value-absolute.md | 600 +- .../-boolean-array/get-value.md | 600 +- .../-boolean-array/index.md | 116 +- .../-boolean-array/set-description.md | 42 +- .../-boolean-array/set-value.md | 534 +- .../-boolean-variable/get-description.md | 34 +- .../-boolean-variable/get-value-absolute.md | 34 +- .../-boolean-variable/get-value.md | 34 +- .../-boolean-variable/index.md | 96 +- .../-boolean-variable/set-description.md | 42 +- .../-boolean-variable/set-value.md | 42 +- .../-cache-pin/checkin-on-flush.md | 42 +- .../-cache-pin/get-local-path.md | 34 +- .../-cache-pin/get-url.md | 34 +- .../-cache-pin/index.md | 42 +- .../-cache-pin/is-valid.md | 34 +- .../-cache-pin/release-pin.md | 34 +- .../-completed-run-data.md | 40 +- .../get-end-sequence-number.md | 14 +- .../-completed-run-data/get-error-i-ds.md | 22 +- .../-completed-run-data/get-error-messages.md | 22 +- .../get-next-sequence-number.md | 22 +- .../-completed-run-data/get-run-i-ds.md | 22 +- .../get-variable-values.md | 22 +- .../-completed-run-data/index.md | 56 +- ...m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md | 10 +- ...p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md | 10 +- .../-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md | 10 +- ...-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md | 22 +- .../-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md | 10 +- .../-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md | 10 +- ...m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md | 10 +- ...-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md | 10 +- ...m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md | 10 +- .../-component/download-values.md | 26 +- .../-component/get-associated-files.md | 34 +- .../-component/get-full-name.md | 34 +- .../-component/get-group.md | 96 +- .../-component/get-index-in-parent.md | 22 +- .../-component/get-metadata.md | 38 +- .../-component/get-name.md | 34 +- .../-component/get-num-groups.md | 34 +- .../-component/get-num-variables.md | 34 +- .../-component/get-parent-assembly.md | 34 +- .../-component/get-position-x.md | 34 +- .../-component/get-position-y.md | 34 +- .../-component/get-source.md | 22 +- .../-component/get-type.md | 22 +- .../-component/get-user-data.md | 26 +- .../-component/get-variable.md | 96 +- .../-component/index.md | 134 +- .../-component/invalidate.md | 26 +- .../-component/invoke-method.md | 42 +- .../-component/reconnect.md | 26 +- .../-component/rename.md | 30 +- .../-component/run.md | 26 +- .../-component/set-associated-files.md | 42 +- .../-component/set-metadata.md | 38 +- .../-component/set-user-data.md | 42 +- .../-component/show.md | 14 +- .../-custom-design-point/add-variable.md | 56 +- .../-custom-design-point/get-i-d2.md | 34 +- .../-custom-design-point/index.md | 46 +- .../-custom-design-point/run-failed.md | 42 +- .../-d-h-variable/-d-h-variable.md | 36 +- .../-d-h-variable/get-enum-alias.md | 50 +- .../-d-h-variable/get-enum-aliases.md | 34 +- .../-d-h-variable/get-enum-value.md | 50 +- .../-d-h-variable/get-enum-values.md | 34 +- .../-d-h-variable/get-equation.md | 34 +- .../-d-h-variable/get-format.md | 34 +- .../-d-h-variable/get-lower-bound.md | 34 +- .../-d-h-variable/get-meta-data.md | 34 +- .../-d-h-variable/get-name.md | 34 +- .../-d-h-variable/get-num-enum-alias.md | 34 +- .../-d-h-variable/get-num-enum-values.md | 34 +- .../-d-h-variable/get-type.md | 34 +- .../-d-h-variable/get-units.md | 34 +- .../-d-h-variable/get-upper-bound.md | 34 +- .../-d-h-variable/index.md | 106 +- .../-d-h-variable/is-design-var.md | 34 +- .../-d-h-variable/is-input.md | 34 +- .../-d-h-variable/is-numeric.md | 34 +- .../-d-h-variable/remove-metadata.md | 42 +- .../-d-h-variable/set-design-var.md | 42 +- .../-d-h-variable/set-enum-aliases.md | 42 +- .../-d-h-variable/set-enum-values.md | 42 +- .../-d-h-variable/set-equation.md | 42 +- .../-d-h-variable/set-format.md | 42 +- .../-d-h-variable/set-input.md | 42 +- .../-d-h-variable/set-lower-bound.md | 42 +- .../-d-h-variable/set-meta-data.md | 26 +- .../-d-h-variable/set-name.md | 42 +- .../-d-h-variable/set-numeric.md | 42 +- .../-d-h-variable/set-type.md | 42 +- .../-d-h-variable/set-units.md | 42 +- .../-d-h-variable/set-upper-bound.md | 42 +- .../-data-collector/-data-collector.md | 30 +- .../-data-collector/add-custom.md | 44 +- .../-data-collector/create-empty-runs.md | 14 +- .../-data-collector/enable-carpet-plot-tab.md | 18 +- .../-data-collector/enable-graph-tab.md | 42 +- .../enable-main-effects-tab.md | 14 +- .../-data-collector/end-runs.md | 26 +- .../-data-collector/export-to-c-s-v.md | 42 +- .../-data-collector/from-string.md | 42 +- .../-data-collector/get-data-explorer.md | 34 +- .../-data-collector/get-error-i-d.md | 50 +- .../-data-collector/get-error-message.md | 50 +- .../-data-collector/get-num-failed-runs.md | 34 +- .../-data-collector/get-num-runs.md | 34 +- .../-data-collector/get-num-variables.md | 34 +- .../-data-collector/get-value.md | 100 +- .../get-variable-description.md | 96 +- .../-data-collector/hide.md | 26 +- .../-data-collector/index.md | 114 +- .../-data-collector/is-valid.md | 100 +- .../-data-collector/is-visible.md | 26 +- .../new-custom-design-point.md | 14 +- .../-data-collector/new-instance.md | 34 +- .../-data-collector/save.md | 50 +- .../-data-collector/select-x.md | 42 +- .../-data-collector/select-y.md | 42 +- .../-data-collector/set-custom-run.md | 14 +- .../-data-collector/set-num-expected-runs.md | 26 +- .../-data-collector/show.md | 26 +- .../-data-collector/start-runs.md | 26 +- .../store-current-design-point.md | 26 +- .../store-custom-design-point.md | 14 +- .../-data-collector/to-string.md | 22 +- .../-p-h-x-d-e-keepalive/index.md | 28 +- .../-data-explorer/add-page.md | 46 +- .../add-runs-to-comparison-list.md | 42 +- .../-data-explorer/add-to-comparison-list.md | 42 +- .../-data-explorer/from-x-m-l-file.md | 82 +- .../-data-explorer/from-x-m-l.md | 82 +- .../get-associated-model-file-u-u-i-d.md | 34 +- .../get-associated-model-file.md | 34 +- .../-data-explorer/get-author.md | 34 +- .../-data-explorer/get-creation-date.md | 34 +- .../-data-explorer/get-da-x-format.md | 38 +- .../-data-explorer/get-da-x-type.md | 34 +- .../-data-explorer/get-data-history.md | 26 +- .../-data-explorer/get-description.md | 34 +- .../-data-explorer/get-display-name.md | 34 +- .../-data-explorer/get-file-uri.md | 34 +- .../-data-explorer/get-h-w-n-d.md | 10 +- .../-data-explorer/get-keepalive.md | 14 +- .../-data-explorer/get-model-center.md | 26 +- .../-data-explorer/get-num-pages.md | 34 +- .../-data-explorer/get-page-type.md | 50 +- .../-data-explorer/get-selected-page.md | 34 +- .../-data-explorer/get-trade-study-setup.md | 34 +- .../-data-explorer/get-trade-study-type.md | 34 +- .../-data-explorer/hide.md | 10 +- .../ignore-default-plot-setup.md | 34 +- .../-data-explorer/index.md | 166 +- .../invoke-insert-page-g-u-i.md | 26 +- .../-data-explorer/invoke-menu-item.md | 42 +- .../-data-explorer/is-menu-item-checked.md | 50 +- .../-data-explorer/is-menu-item-enabled.md | 50 +- .../-data-explorer/is-visible.md | 10 +- .../-data-explorer/move-page.md | 44 +- .../-data-explorer/multi-delete.md | 42 +- .../-data-explorer/multi-page-copy.md | 42 +- .../-data-explorer/multi-page-cut.md | 42 +- .../-data-explorer/new-instance.md | 34 +- .../-data-explorer/page-copy.md | 42 +- .../-data-explorer/page-cut.md | 42 +- .../-data-explorer/page-paste.md | 26 +- .../remove-from-comparison-list.md | 42 +- .../-data-explorer/remove-page.md | 42 +- .../-data-explorer/select-page.md | 42 +- .../set-associated-model-file-u-u-i-d.md | 42 +- .../set-associated-model-file.md | 42 +- .../-data-explorer/set-author.md | 42 +- .../-data-explorer/set-creation-date.md | 42 +- .../-data-explorer/set-description.md | 42 +- .../-data-explorer/set-display-name.md | 42 +- .../-data-explorer/set-file-uri.md | 42 +- .../-data-explorer/set-geom-viewer-run-i-d.md | 44 +- .../-data-explorer/set-trade-study-setup.md | 42 +- .../-data-explorer/set-trade-study-type.md | 42 +- .../-data-explorer/setup-plots-post.md | 26 +- .../-data-explorer/setup-plots-pre.md | 26 +- .../-data-explorer/show-geom-tooltip.md | 26 +- .../-data-explorer/show-geom-viewer.md | 26 +- .../-data-explorer/show.md | 10 +- .../-data-explorer/to-x-m-l-file.md | 82 +- .../-data-explorer/to-x-m-l.md | 80 +- .../update-comparison-view-hint.md | 42 +- .../-data-explorer/update-geom-viewer-hint.md | 42 +- .../-data-explorer/update-thumb-hint.md | 42 +- .../-data-history-variable-metadata-struct.md | 10 +- .../custom-metadata.md | 14 +- .../enum-aliases.md | 14 +- .../enum-values.md | 14 +- .../equation.md | 14 +- .../file-name.md | 14 +- .../format.md | 14 +- .../geom-script.md | 14 +- .../get-custom-metadata-names.md | 22 +- .../index.md | 90 +- .../is-binary.md | 14 +- .../is-design-var.md | 14 +- .../is-input.md | 14 +- .../is-numeric.md | 14 +- .../lower-bound.md | 14 +- .../name.md | 14 +- .../type.md | 14 +- .../units.md | 14 +- .../upper-bound.md | 14 +- .../--index--.md | 14 +- .../-data-history-variable-struct.md | 10 +- .../-data-history-variable-struct/index.md | 46 +- .../is-modified.md | 14 +- .../-data-history-variable-struct/is-valid.md | 14 +- .../-data-history-variable-struct/metadata.md | 14 +- .../var-value.md | 14 +- .../-data-history/-data-history.md | 40 +- .../-data-history/add-variable-structs.md | 32 +- .../-data-history/add-variable.md | 26 +- .../-data-history/create-variable.md | 34 +- .../-data-history/delete-run.md | 42 +- .../-data-history/delete-variable.md | 46 +- .../-data-history/end-runs.md | 26 +- .../-data-history/from-x-m-l-file.md | 44 +- .../-data-history/from-x-m-l.md | 44 +- .../get-center-link-job-connector.md | 42 +- .../-data-history/get-center-link-queue.md | 42 +- .../get-center-link-run-matrix-i-d.md | 42 +- .../-data-history/get-center-link-server.md | 42 +- .../-data-history/get-completed-run-data.md | 54 +- .../-data-history/get-data-explorer.md | 26 +- .../get-data-history-to-model.md | 26 +- .../-data-history/get-error-i-d.md | 50 +- .../-data-history/get-error-message.md | 50 +- .../-data-history/get-formatted-value.md | 100 +- .../-data-history/get-highlighted-runs.md | 34 +- .../-data-history/get-num-custom-vars.md | 34 +- .../-data-history/get-num-design-variables.md | 34 +- .../-data-history/get-num-expected-runs.md | 34 +- .../-data-history/get-num-failed-runs.md | 34 +- .../-data-history/get-num-non-empty-runs.md | 34 +- .../-data-history/get-num-runs.md | 34 +- .../-data-history/get-num-variables.md | 34 +- .../-data-history/get-run-name.md | 50 +- .../-data-history/get-setting-run.md | 34 +- .../-data-history/get-suggested-count-from.md | 34 +- .../get-suggested-dependent-vars.md | 34 +- .../get-suggested-independant-var.md | 42 +- .../get-suggested-independent-var.md | 34 +- .../-data-history/get-unique-i-d.md | 34 +- .../-data-history/get-value.md | 100 +- .../-data-history/get-variable-values.md | 96 +- .../-data-history/get-variable.md | 88 +- .../-data-history/highlight.md | 46 +- .../-data-history/index.md | 168 +- .../-data-history/insert-run.md | 42 +- .../-data-history/is-highlighted.md | 50 +- .../-data-history/is-modified.md | 56 +- .../-data-history/is-running.md | 34 +- .../-data-history/is-valid.md | 100 +- .../-data-history/new-instance.md | 34 +- .../set-data-history-to-model.md | 14 +- .../-data-history/set-error.md | 46 +- .../-data-history/set-formatted-result.md | 96 +- .../-data-history/set-highlighted-runs.md | 42 +- .../-data-history/set-num-expected-runs.md | 42 +- .../-data-history/set-result.md | 96 +- .../-data-history/set-run-name.md | 44 +- .../-data-history/set-run-values.md | 48 +- .../-data-history/set-setting-run.md | 26 +- .../-data-history/set-suggested-count-from.md | 42 +- .../set-suggested-dependent-vars.md | 42 +- .../set-suggested-independant-var.md | 50 +- .../set-suggested-independent-var.md | 42 +- .../-data-history/set-variable-values.md | 96 +- .../-data-history/start-runs.md | 26 +- .../-data-history/to-c-s-v-file.md | 46 +- .../-data-history/to-c-s-v.md | 52 +- .../-data-history/to-x-m-l-file.md | 82 +- .../-data-history/to-x-m-l.md | 80 +- .../-data-monitor/add-item.md | 40 +- .../-data-monitor/add-unlinked-item.md | 38 +- .../-data-monitor/get-auto-delete.md | 22 +- .../-data-monitor/get-col-width.md | 30 +- .../-data-monitor/get-display-full-names.md | 22 +- .../-data-monitor/get-display-units.md | 22 +- .../-data-monitor/get-height.md | 10 +- .../-data-monitor/get-link.md | 38 +- .../-data-monitor/get-name.md | 38 +- .../-data-monitor/get-title.md | 10 +- .../-data-monitor/get-width.md | 10 +- .../-data-monitor/get-x.md | 10 +- .../-data-monitor/get-y.md | 10 +- .../-data-monitor/index.md | 80 +- .../-data-monitor/is-renamed.md | 38 +- .../-data-monitor/is-valid.md | 10 +- .../-data-monitor/remove-item.md | 30 +- .../-data-monitor/remove-link.md | 30 +- .../-data-monitor/set-auto-delete.md | 30 +- .../-data-monitor/set-col-width.md | 32 +- .../-data-monitor/set-display-full-names.md | 30 +- .../-data-monitor/set-display-units.md | 30 +- .../-data-monitor/set-link.md | 40 +- .../-data-monitor/set-location.md | 10 +- .../-data-monitor/set-name.md | 32 +- .../-data-monitor/set-size.md | 10 +- .../-data-monitor/set-title.md | 10 +- .../-double-array/clear-lower-bound.md | 26 +- .../-double-array/clear-upper-bound.md | 26 +- .../-double-array/from-formatted-string.md | 44 +- .../-double-array/get-description.md | 34 +- .../-double-array/get-enum-aliases.md | 34 +- .../-double-array/get-enum-values.md | 34 +- .../-double-array/get-format.md | 34 +- .../-double-array/get-lower-bound.md | 34 +- .../-double-array/get-units.md | 34 +- .../-double-array/get-upper-bound.md | 34 +- .../-double-array/get-value-absolute.md | 600 +- .../-double-array/get-value.md | 600 +- .../-double-array/has-lower-bound.md | 34 +- .../-double-array/has-upper-bound.md | 34 +- .../-double-array/index.md | 154 +- .../-double-array/set-description.md | 42 +- .../-double-array/set-enum-aliases.md | 42 +- .../-double-array/set-enum-values.md | 42 +- .../-double-array/set-format.md | 42 +- .../-double-array/set-lower-bound.md | 42 +- .../-double-array/set-units.md | 42 +- .../-double-array/set-upper-bound.md | 42 +- .../-double-array/set-value.md | 534 +- .../to-formatted-string-absolute.md | 50 +- .../-double-array/to-formatted-string.md | 50 +- .../-double-variable/clear-lower-bound.md | 26 +- .../-double-variable/clear-upper-bound.md | 26 +- .../-double-variable/from-formatted-string.md | 26 +- .../-double-variable/get-description.md | 34 +- .../-double-variable/get-enum-aliases.md | 34 +- .../-double-variable/get-enum-values.md | 34 +- .../-double-variable/get-format.md | 34 +- .../-double-variable/get-lower-bound.md | 34 +- .../-double-variable/get-units.md | 34 +- .../-double-variable/get-upper-bound.md | 34 +- .../-double-variable/get-value-absolute.md | 34 +- .../-double-variable/get-value.md | 34 +- .../-double-variable/has-lower-bound.md | 34 +- .../-double-variable/has-upper-bound.md | 34 +- .../-double-variable/index.md | 134 +- .../-double-variable/set-description.md | 42 +- .../-double-variable/set-enum-aliases.md | 42 +- .../-double-variable/set-enum-values.md | 42 +- .../-double-variable/set-format.md | 42 +- .../-double-variable/set-lower-bound.md | 42 +- .../-double-variable/set-units.md | 42 +- .../-double-variable/set-upper-bound.md | 42 +- .../-double-variable/set-value.md | 42 +- .../to-formatted-string-absolute.md | 34 +- .../-double-variable/to-formatted-string.md | 34 +- .../-feature/checkin.md | 26 +- .../-feature/index.md | 42 +- .../-file-array/from-file.md | 160 +- .../-file-array/get-description.md | 34 +- .../-file-array/get-file-extension.md | 178 +- .../-file-array/get-is-binary.md | 34 +- .../-file-array/get-save-with-model.md | 34 +- .../-file-array/index.md | 128 +- .../-file-array/set-description.md | 42 +- .../-file-array/set-file-extension.md | 160 +- .../-file-array/set-is-binary.md | 42 +- .../-file-array/set-save-with-model.md | 42 +- .../-file-array/to-file-absolute.md | 166 +- .../-file-array/to-file.md | 166 +- .../-file-system-info/get-base-name.md | 26 +- .../-file-system-info/get-exists.md | 26 +- .../-file-system-info/get-is-valid.md | 26 +- .../-file-system-info/get-is-writable.md | 26 +- .../-file-system-info/get-url.md | 26 +- .../-file-system-info/index.md | 42 +- .../-file-variable/from-file.md | 42 +- .../-file-variable/get-description.md | 34 +- .../-file-variable/get-direct-transfer.md | 34 +- .../-file-variable/get-file-extension.md | 34 +- .../-file-variable/get-is-binary.md | 34 +- .../-file-variable/get-save-with-model.md | 34 +- .../-file-variable/index.md | 118 +- .../-file-variable/read-file.md | 42 +- .../-file-variable/set-description.md | 42 +- .../-file-variable/set-direct-transfer.md | 42 +- .../-file-variable/set-file-extension.md | 42 +- .../-file-variable/set-is-binary.md | 42 +- .../-file-variable/set-save-with-model.md | 42 +- .../-file-variable/to-file-absolute.md | 82 +- .../-file-variable/to-file.md | 82 +- .../-file-variable/write-file-absolute.md | 42 +- .../-file-variable/write-file.md | 42 +- .../-format/double-to-editable-string.md | 50 +- .../-format/double-to-string.md | 50 +- .../-format/get-format.md | 34 +- .../-format/index.md | 58 +- .../-format/long-to-editable-string.md | 50 +- .../-format/long-to-string.md | 50 +- .../-format/set-format.md | 42 +- .../-format/string-to-double.md | 50 +- .../-format/string-to-long.md | 50 +- .../-format/string-to-string.md | 50 +- .../-format2/-format2.md | 14 +- .../-format2/_set-format.md | 42 +- .../-format2/double-to-editable-string.md | 50 +- .../-format2/double-to-string.md | 50 +- .../-format2/index.md | 60 +- .../-format2/long-to-editable-string.md | 50 +- .../-format2/long-to-string.md | 50 +- .../-format2/string-to-double.md | 50 +- .../-format2/string-to-long.md | 50 +- .../-format2/string-to-string.md | 50 +- .../-geometry-variable/get-description.md | 34 +- .../-geometry-variable/get-value.md | 34 +- .../-geometry-variable/index.md | 94 +- .../-geometry-variable/set-description.md | 42 +- .../-geometry-variable/set-value.md | 42 +- .../-global-parameters/get-count.md | 14 +- .../-global-parameters/get-value.md | 56 +- .../-global-parameters/index.md | 50 +- .../-global-parameters/remove.md | 56 +- .../set-export-to-remote-components.md | 56 +- .../-global-parameters/set-value.md | 56 +- .../-group/get-full-name.md | 34 +- .../-group/get-group.md | 96 +- .../-group/get-icon-i-d.md | 22 +- .../-group/get-name.md | 34 +- .../-group/get-num-groups.md | 34 +- .../-group/get-num-variables.md | 34 +- .../-group/get-variable.md | 96 +- .../-group/index.md | 56 +- .../-group/set-icon-i-d.md | 30 +- .../-i-component-plug-in/construct.md | 44 +- .../-i-component-plug-in/from-string.md | 42 +- .../-i-component-plug-in/index.md | 34 +- .../-i-component-plug-in/on-end.md | 26 +- .../-i-component-plug-in/run.md | 26 +- .../-i-component-plug-in/show.md | 34 +- .../-i-data-collector-plug-in/construct.md | 46 +- .../-i-data-collector-plug-in/from-string.md | 42 +- .../-i-data-collector-plug-in/index.md | 30 +- .../-i-data-collector-plug-in/show.md | 34 +- .../-i-data-explorer-plug-in/construct.md | 42 +- .../-i-data-explorer-plug-in/data-changed.md | 32 +- .../-i-data-explorer-plug-in/export-image.md | 32 +- .../-i-data-explorer-plug-in/from-string.md | 42 +- .../get-page-title.md | 22 +- .../get-required-license.md | 14 +- .../-i-data-explorer-plug-in/get-thumbnail.md | 38 +- .../-i-data-explorer-plug-in/index.md | 46 +- .../invoke-menu-item.md | 30 +- .../-i-data-explorer-plug-in/on-end.md | 14 +- .../progress-meter-stop.md | 14 +- .../variables-changed.md | 14 +- .../can-rerun-runs.md | 40 +- .../can-save-to-model.md | 40 +- .../close-data-history.md | 42 +- .../-i-data-history-to-model/index.md | 34 +- .../-i-data-history-to-model/rerun-runs.md | 32 +- .../-i-data-history-to-model/save-to-model.md | 32 +- .../-i-holder/get-full-name.md | 22 +- .../-i-holder/get-name.md | 22 +- .../-i-holder/index.md | 48 +- .../-i-login-callback/index.md | 38 +- .../-i-login-callback/login-succeeded.md | 48 +- .../request-auth-credentials.md | 58 +- .../-i-login-callback/verify-ssl-warning.md | 50 +- .../-h-t-m-l-viewer-wait-for-close.md | 14 +- .../-i-model-center/-message-box.md | 42 +- .../-i-model-center/add-icon.md | 38 +- .../-i-model-center/add-new-macro.md | 32 +- .../-i-model-center/auto-link.md | 32 +- .../-i-model-center/break-link.md | 42 +- .../-i-model-center/checkout.md | 50 +- .../-i-model-center/checkout2.md | 52 +- .../-i-model-center/close-h-t-m-l-viewer.md | 14 +- .../-i-model-center/close-model.md | 26 +- .../create-and-init-component.md | 60 +- .../create-assembly-variable.md | 42 +- .../-i-model-center/create-assembly.md | 78 +- .../-i-model-center/create-component.md | 92 +- .../-i-model-center/create-data-collector.md | 54 +- .../-i-model-center/create-data-explorer.md | 34 +- .../create-data-history-variable.md | 34 +- .../-i-model-center/create-data-monitor.md | 44 +- .../-i-model-center/create-job-manager.md | 126 +- .../-i-model-center/create-link.md | 44 +- .../-i-model-center/create-plug-in-frame.md | 58 +- .../-i-model-center/create-trade-study.md | 30 +- .../-i-model-center/destroy-plug-in-frame.md | 30 +- .../-i-model-center/dump-com-debug.md | 26 +- .../-i-model-center/get-active-job-manager.md | 22 +- .../-i-model-center/get-app-name.md | 34 +- .../-i-model-center/get-assembly-style.md | 38 +- .../-i-model-center/get-assembly.md | 50 +- .../-i-model-center/get-component.md | 50 +- .../get-data-collector-for-data-explorer.md | 50 +- .../-i-model-center/get-data-collector.md | 10 +- .../-i-model-center/get-data-explorer.md | 38 +- .../-i-model-center/get-data-monitor.md | 40 +- .../-i-model-center/get-file-system-info.md | 50 +- .../-i-model-center/get-formatter.md | 14 +- .../-i-model-center/get-frame.md | 22 +- .../-i-model-center/get-global-parameters.md | 14 +- .../-i-model-center/get-halt-status.md | 34 +- .../-i-model-center/get-is-interactive.md | 14 +- .../-i-model-center/get-last-error-message.md | 34 +- .../-i-model-center/get-licensing-path.md | 14 +- .../-i-model-center/get-links.md | 38 +- .../-i-model-center/get-logger.md | 34 +- .../get-macro-script-language.md | 38 +- .../-i-model-center/get-macro-script.md | 38 +- .../-i-model-center/get-model-center-path.md | 26 +- .../-i-model-center/get-model-directory.md | 14 +- .../-i-model-center/get-model-file-name.md | 34 +- .../-i-model-center/get-model.md | 34 +- .../-i-model-center/get-preference.md | 38 +- .../-i-model-center/get-process-i-d.md | 26 +- .../-i-model-center/get-run-only-mode.md | 34 +- .../-i-model-center/get-screen-updating.md | 34 +- .../get-trade-study-filters.md | 34 +- .../-i-model-center/get-value-absolute.md | 50 +- .../-i-model-center/get-value.md | 50 +- .../-i-model-center/get-variable-meta-data.md | 50 +- .../-i-model-center/get-variable.md | 50 +- .../-i-model-center/get-version.md | 50 +- .../gui-close-all-multiplexers.md | 34 +- .../-i-model-center/gui-load-file.md | 50 +- .../-i-model-center/gui-save-model.md | 26 +- .../-i-model-center/halt.md | 14 +- .../-i-model-center/hide-plug-in-frame.md | 30 +- .../-i-model-center/index.md | 258 +- .../-i-model-center/internal-licensing.md | 14 +- .../-i-model-center/invoke-help.md | 42 +- .../-i-model-center/is-ok-to-close.md | 14 +- .../launch-data-collector-plug-in.md | 44 +- .../-i-model-center/launch-h-t-m-l-viewer.md | 14 +- .../-i-model-center/launch-macro-editor.md | 30 +- .../-i-model-center/launch-trade-study.md | 30 +- .../-i-model-center/load-file.md | 82 +- .../-i-model-center/load-model.md | 82 +- .../-i-model-center/move-component.md | 46 +- .../-i-model-center/new-instance.md | 34 +- .../-i-model-center/new-model.md | 64 +- .../-i-model-center/parallel-instance.md | 14 +- .../-i-model-center/release.md | 30 +- .../-i-model-center/remove-component.md | 42 +- .../-i-model-center/remove-data-monitor.md | 40 +- .../-i-model-center/run-ant-file.md | 14 +- .../-i-model-center/run-macro.md | 38 +- .../-i-model-center/run-macro2.md | 38 +- .../-i-model-center/run.md | 30 +- .../-i-model-center/save-model-as.md | 42 +- .../-i-model-center/save-model.md | 26 +- .../-i-model-center/save-trade-study.md | 46 +- .../save-versioned-model-as.md | 46 +- .../-i-model-center/save-versioned-model.md | 26 +- .../-i-model-center/set-assembly-style.md | 72 +- .../-i-model-center/set-icon-plug-in-frame.md | 32 +- .../-i-model-center/set-login-callback.md | 42 +- .../set-macro-script-language.md | 32 +- .../-i-model-center/set-macro-script.md | 32 +- .../-i-model-center/set-password.md | 42 +- .../-i-model-center/set-preference.md | 32 +- .../-i-model-center/set-run-only-mode.md | 34 +- .../-i-model-center/set-scheduler.md | 42 +- .../-i-model-center/set-screen-updating.md | 42 +- .../-i-model-center/set-user-name.md | 42 +- .../-i-model-center/set-value.md | 44 +- .../show-file-browse-dialog.md | 106 +- .../-i-model-center/show-file-save-dialog.md | 60 +- .../-i-model-center/show-plug-in-frame.md | 30 +- .../-i-model-center/start-g-u-i-mode.md | 26 +- .../-i-model-center/trade-study-end.md | 26 +- .../-i-model-center/trade-study-start.md | 26 +- .../-i-plug-in-meta-data/get-author.md | 34 +- .../-i-plug-in-meta-data/get-description.md | 34 +- .../-i-plug-in-meta-data/get-help-u-r-l.md | 34 +- .../-i-plug-in-meta-data/get-icon-location.md | 34 +- .../-i-plug-in-meta-data/get-keywords.md | 34 +- .../-i-plug-in-meta-data/get-version.md | 34 +- .../-i-plug-in-meta-data/index.md | 36 +- .../get-comparison-info-h-t-m-l-string.md | 50 +- .../get-run-info-h-t-m-l-string.md | 50 +- .../-i-run-data-action/index.md | 32 +- .../-i-run-data-action/pass-h-t-m-l-event.md | 46 +- .../-i-run-data-action/update-highlight.md | 14 +- .../data-collector-created.md | 32 +- .../-i-trade-study-callback/index.md | 32 +- .../-i-trade-study-callback/run-ended.md | 30 +- .../-i-trade-study-callback/run-starting.md | 38 +- .../trade-study-closed.md | 30 +- .../-i-trade-study-plug-in/construct.md | 44 +- .../-i-trade-study-plug-in/from-string.md | 42 +- .../-i-trade-study-plug-in/index.md | 42 +- .../-i-trade-study-plug-in/show.md | 34 +- .../add-analyzer-variable.md | 32 +- .../clear-analyzer-variables.md | 14 +- .../get-save-all-analyzer-variables.md | 14 +- .../get-trade-study-callback.md | 26 +- .../-i-trade-study-plug-in2/index.md | 56 +- .../-i-trade-study-plug-in2/on-end.md | 26 +- .../set-save-all-analyzer-variables.md | 14 +- .../set-trade-study-callback.md | 42 +- .../get-job-manager.md | 26 +- .../-i-trade-study-plug-in3/index.md | 56 +- .../set-job-manager.md | 26 +- .../-i-trade-study3-job-info/get-num-runs.md | 14 +- .../get-num-variables.md | 14 +- .../get-variable-display-name.md | 50 +- .../get-variable-equation.md | 50 +- .../-i-trade-study3-job-info/index.md | 60 +- .../is-design-variable.md | 52 +- .../-i-trade-study3-job-info/is-input.md | 52 +- .../add-variable.md | 48 +- .../can-new-job.md | 22 +- .../-i-trade-study3-job-manager/clear.md | 26 +- .../get-data-history.md | 14 +- .../get-meta-data-provider.md | 22 +- .../get-num-threads.md | 22 +- .../get-run-in-parallel.md | 22 +- .../get-supports-parallel-execution.md | 22 +- .../get-validate-all.md | 22 +- .../-i-trade-study3-job-manager/index.md | 80 +- .../-i-trade-study3-job-manager/new-job.md | 44 +- .../run-job-async.md | 36 +- .../set-data-history.md | 42 +- .../-i-trade-study3-job-manager/set-input.md | 50 +- .../set-num-threads.md | 44 +- .../set-run-in-parallel.md | 42 +- .../set-run-inputs.md | 50 +- .../set-validate-all.md | 42 +- .../set-variable-inputs.md | 50 +- .../cancel-async.md | 14 +- .../get-data-history.md | 14 +- .../-i-trade-study3-job-result/index.md | 54 +- .../-i-trade-study3-job-result/is-canceled.md | 14 +- .../-i-trade-study3-job-result/is-running.md | 14 +- .../wait-for-completion.md | 26 +- .../-i-variable-holder/get-group.md | 96 +- .../-i-variable-holder/get-num-groups.md | 34 +- .../-i-variable-holder/get-num-variables.md | 34 +- .../-i-variable-holder/get-variable.md | 96 +- .../-i-variable-holder/index.md | 64 +- .../get-all-variable-meta-data.md | 50 +- .../get-variable-meta-data.md | 50 +- .../-i-variable-meta-data-provider/index.md | 36 +- .../-if-component/get-branch-condition.md | 50 +- .../-if-component/get-branch-name.md | 50 +- .../-if-component/get-exclusive.md | 34 +- .../-if-component/get-num-branches.md | 34 +- .../get-run-last-branch-by-default.md | 34 +- .../-if-component/index.md | 136 +- .../-if-component/rename-branch.md | 44 +- .../-if-component/set-branch-condition.md | 44 +- .../-if-component/set-exclusive.md | 42 +- .../set-run-last-branch-by-default.md | 42 +- .../-integer-array/clear-lower-bound.md | 26 +- .../-integer-array/clear-upper-bound.md | 26 +- .../-integer-array/from-formatted-string.md | 44 +- .../-integer-array/get-description.md | 34 +- .../-integer-array/get-enum-aliases.md | 34 +- .../-integer-array/get-enum-values.md | 34 +- .../-integer-array/get-format.md | 34 +- .../-integer-array/get-lower-bound.md | 34 +- .../-integer-array/get-units.md | 34 +- .../-integer-array/get-upper-bound.md | 34 +- .../-integer-array/get-value-absolute.md | 600 +- .../-integer-array/get-value.md | 600 +- .../-integer-array/has-lower-bound.md | 34 +- .../-integer-array/has-upper-bound.md | 34 +- .../-integer-array/index.md | 154 +- .../-integer-array/set-description.md | 42 +- .../-integer-array/set-enum-aliases.md | 42 +- .../-integer-array/set-enum-values.md | 42 +- .../-integer-array/set-format.md | 42 +- .../-integer-array/set-lower-bound.md | 42 +- .../-integer-array/set-units.md | 42 +- .../-integer-array/set-upper-bound.md | 42 +- .../-integer-array/set-value.md | 534 +- .../to-formatted-string-absolute.md | 50 +- .../-integer-array/to-formatted-string.md | 50 +- .../-integer-variable/clear-lower-bound.md | 26 +- .../-integer-variable/clear-upper-bound.md | 26 +- .../from-formatted-string.md | 26 +- .../-integer-variable/get-description.md | 34 +- .../-integer-variable/get-enum-aliases.md | 34 +- .../-integer-variable/get-enum-values.md | 34 +- .../-integer-variable/get-format.md | 34 +- .../-integer-variable/get-lower-bound.md | 34 +- .../-integer-variable/get-units.md | 34 +- .../-integer-variable/get-upper-bound.md | 34 +- .../-integer-variable/get-value-absolute.md | 34 +- .../-integer-variable/get-value.md | 34 +- .../-integer-variable/has-lower-bound.md | 34 +- .../-integer-variable/has-upper-bound.md | 34 +- .../-integer-variable/index.md | 134 +- .../-integer-variable/set-description.md | 42 +- .../-integer-variable/set-enum-aliases.md | 42 +- .../-integer-variable/set-enum-values.md | 42 +- .../-integer-variable/set-format.md | 42 +- .../-integer-variable/set-lower-bound.md | 42 +- .../-integer-variable/set-units.md | 42 +- .../-integer-variable/set-upper-bound.md | 42 +- .../-integer-variable/set-value.md | 42 +- .../to-formatted-string-absolute.md | 34 +- .../-integer-variable/to-formatted-string.md | 34 +- .../-java-object-repository.md | 10 +- .../get-run-data-action.md | 38 +- .../-java-object-repository/get.md | 40 +- .../-java-object-repository/index.md | 40 +- .../-java-object-repository/put.md | 34 +- .../-java-object-repository/release.md | 52 +- .../-job-manager/add-input.md | 44 +- .../-job-manager/add-output.md | 44 +- .../-job-manager/add-rerun.md | 42 +- .../-job-manager/clear-cache.md | 26 +- .../-job-manager/enable-cache.md | 50 +- .../-job-manager/get-input-label.md | 38 +- .../-job-manager/get-input.md | 38 +- .../-job-manager/get-num-inputs.md | 22 +- .../-job-manager/get-num-outputs.md | 22 +- .../-job-manager/get-num-runs.md | 26 +- .../-job-manager/get-num-threads.md | 22 +- .../-job-manager/get-output-label.md | 38 +- .../-job-manager/get-output.md | 38 +- .../-job-manager/get-run-in-parallel.md | 22 +- .../-job-manager/get-run-index.md | 52 +- .../-job-manager/get-validate-all.md | 26 +- .../-job-manager/halt.md | 30 +- .../-job-manager/index.md | 92 +- .../-job-manager/resume.md | 30 +- .../-job-manager/set-custom-metadata.md | 46 +- .../-job-manager/set-input.md | 46 +- .../-job-manager/set-num-runs.md | 42 +- .../-job-manager/set-num-threads.md | 30 +- .../-job-manager/set-run-in-parallel.md | 30 +- .../-job-manager/set-validate-all.md | 42 +- .../-job-manager/submit.md | 364 +- .../-job-manager/wait-for-job-completion.md | 26 +- .../-model-center-exception.md | 22 +- .../-model-center-exception/index.md | 84 +- ...s-s-e-m-b-l-y_-t-y-p-e_-a-s-s-e-m-b-l-y.md | 10 +- ...-s-s-e-m-b-l-y_-t-y-p-e_-f-o-r_-e-a-c-h.md | 10 +- .../-a-s-s-e-m-b-l-y_-t-y-p-e_-i-f.md | 10 +- ...s-s-e-m-b-l-y_-t-y-p-e_-p-a-r-a-l-l-e-l.md | 10 +- ...s-s-e-m-b-l-y_-t-y-p-e_-s-e-q-u-e-n-c-e.md | 10 +- .../-assembly-style-info/height.md | 10 +- .../-assembly-style-info/index.md | 30 +- .../-assembly-style-info/style.md | 10 +- .../-assembly-style-info/width.md | 10 +- .../-assembly-style/-auto-n-squared/index.md | 14 +- .../-assembly-style/-classic/index.md | 14 +- .../-assembly-style/-collapsed/index.md | 14 +- .../-assembly-style/-expanded/index.md | 14 +- .../-assembly-style/-n-squared/index.md | 14 +- .../-model-center/-assembly-style/index.md | 48 +- .../-model-center/-assembly-style/value-of.md | 34 +- .../-model-center/-assembly-style/values.md | 22 +- .../-c-o-n-n_-e-r-r_-e-r-r-o-r.md | 10 +- .../-c-o-n-n_-e-r-r_-i-g-n-o-r-e.md | 10 +- .../-c-o-n-n_-e-r-r_-u-s-e-d-i-a-l-o-g.md | 10 +- .../-h-t-m-l-viewer-wait-for-close.md | 14 +- .../-m-o-d-e-l_-t-y-p-e_-d-a-t-a.md | 10 +- .../-m-o-d-e-l_-t-y-p-e_-p-r-o-c-e-s-s.md | 10 +- .../-model-center/-message-box.md | 42 +- .../-model-center/-model-center.md | 88 +- .../-version-status/-do-not-version/index.md | 14 +- .../-do-versioning-if-possible/index.md | 14 +- .../-version-status/-do-versioning/index.md | 14 +- .../-model-center/-version-status/index.md | 44 +- .../-model-center/-version-status/value-of.md | 34 +- .../-model-center/-version-status/values.md | 22 +- .../-model-center/add-icon.md | 38 +- .../-model-center/add-new-macro.md | 32 +- .../allow-bring-window-to-front.md | 26 +- .../-model-center/auto-link.md | 32 +- .../-model-center/break-link.md | 42 +- .../-model-center/checkout.md | 50 +- .../-model-center/checkout2.md | 52 +- .../-model-center/close-h-t-m-l-viewer.md | 14 +- .../-model-center/close-model.md | 26 +- .../-model-center/close.md | 34 +- .../create-and-init-component.md | 60 +- .../-model-center/create-assembly-variable.md | 42 +- .../-model-center/create-assembly.md | 78 +- .../-model-center/create-component.md | 92 +- .../-model-center/create-data-collector.md | 54 +- .../-model-center/create-data-explorer.md | 34 +- .../create-data-history-variable.md | 34 +- .../-model-center/create-data-monitor.md | 44 +- .../-model-center/create-job-manager.md | 126 +- .../-model-center/create-link.md | 44 +- .../-model-center/create-plug-in-frame.md | 58 +- .../-model-center/create-trade-study.md | 30 +- .../-model-center/destroy-plug-in-frame.md | 30 +- .../-model-center/dump-com-debug.md | 26 +- .../-model-center/get-active-job-manager.md | 22 +- .../-model-center/get-app-name.md | 34 +- .../-model-center/get-assembly-style.md | 38 +- .../-model-center/get-assembly.md | 50 +- .../-model-center/get-component.md | 50 +- .../get-data-collector-for-data-explorer.md | 50 +- .../-model-center/get-data-collector.md | 10 +- .../-model-center/get-data-explorer.md | 38 +- .../-model-center/get-data-monitor.md | 40 +- .../-model-center/get-file-system-info.md | 50 +- .../-model-center/get-formatter.md | 14 +- .../-model-center/get-frame.md | 22 +- .../-model-center/get-global-parameters.md | 14 +- .../-model-center/get-halt-status.md | 34 +- .../-model-center/get-is-interactive.md | 14 +- .../-model-center/get-last-error-message.md | 34 +- .../-model-center/get-licensing-path.md | 14 +- .../-model-center/get-links.md | 38 +- .../-model-center/get-logger.md | 34 +- .../get-macro-script-language.md | 38 +- .../-model-center/get-macro-script.md | 38 +- .../-model-center/get-macro-timeout.md | 38 +- .../-model-center/get-model-center-path.md | 26 +- .../-model-center/get-model-directory.md | 14 +- .../-model-center/get-model-file-name.md | 34 +- .../-model-center/get-model.md | 34 +- .../-model-center/get-preference.md | 38 +- .../-model-center/get-process-i-d.md | 26 +- .../-model-center/get-run-only-mode.md | 34 +- .../-model-center/get-screen-updating.md | 34 +- .../-model-center/get-trade-study-filters.md | 34 +- .../-model-center/get-value-absolute.md | 50 +- .../-model-center/get-value.md | 50 +- .../-model-center/get-variable-meta-data.md | 50 +- .../-model-center/get-variable.md | 50 +- .../-model-center/get-version.md | 50 +- .../-model-center/get-x-m-l-extension.md | 14 +- .../gui-close-all-multiplexers.md | 14 +- .../-model-center/gui-load-file.md | 50 +- .../-model-center/gui-save-model.md | 26 +- .../-model-center/halt.md | 14 +- .../-model-center/hide-plug-in-frame.md | 30 +- .../-model-center/index.md | 372 +- .../-model-center/internal-licensing.md | 14 +- .../-model-center/invoke-help.md | 42 +- .../-model-center/is-ok-to-close.md | 14 +- .../launch-data-collector-plug-in.md | 44 +- .../-model-center/launch-h-t-m-l-viewer.md | 14 +- .../-model-center/launch-macro-editor.md | 30 +- .../-model-center/launch-trade-study.md | 30 +- .../-model-center/load-file.md | 82 +- .../-model-center/load-model.md | 82 +- .../-model-center/move-component.md | 46 +- .../-model-center/new-instance.md | 34 +- .../-model-center/new-model.md | 64 +- .../-model-center/parallel-instance.md | 14 +- .../-model-center/remove-component.md | 42 +- .../-model-center/remove-data-monitor.md | 40 +- .../-model-center/run-ant-file.md | 14 +- .../-model-center/run-macro.md | 38 +- .../-model-center/run-macro2.md | 38 +- .../-model-center/run.md | 30 +- .../-model-center/save-model-as.md | 42 +- .../-model-center/save-model.md | 26 +- .../-model-center/save-trade-study.md | 46 +- .../-model-center/save-versioned-model-as.md | 46 +- .../-model-center/save-versioned-model.md | 26 +- .../-model-center/set-assembly-style.md | 72 +- .../-model-center/set-icon-plug-in-frame.md | 32 +- .../-model-center/set-login-callback.md | 42 +- .../set-macro-script-language.md | 32 +- .../-model-center/set-macro-script.md | 32 +- .../-model-center/set-macro-timeout.md | 32 +- .../-model-center/set-password.md | 42 +- .../-model-center/set-preference.md | 32 +- .../-model-center/set-run-only-mode.md | 34 +- .../-model-center/set-scheduler.md | 42 +- .../-model-center/set-screen-updating.md | 42 +- .../-model-center/set-user-name.md | 42 +- .../-model-center/set-value.md | 44 +- .../-model-center/set-x-m-l-extension.md | 14 +- .../-model-center/show-file-browse-dialog.md | 106 +- .../-model-center/show-file-save-dialog.md | 60 +- .../-model-center/show-plug-in-frame.md | 30 +- .../-model-center/start-g-u-i-mode.md | 26 +- .../-model-center/trade-study-end.md | 26 +- .../-model-center/trade-study-start.md | 26 +- .../-object-variable/call-method.md | 50 +- .../-object-variable/delete-all-members.md | 26 +- .../-object-variable/delete-member.md | 42 +- .../-object-variable/from-file.md | 44 +- .../-object-variable/from-x-m-l.md | 42 +- ...get-boolean-array-member-value-absolute.md | 100 +- .../get-boolean-array-member-value.md | 100 +- .../get-boolean-member-value-absolute.md | 50 +- .../get-boolean-member-value.md | 50 +- .../-object-variable/get-class-u-r-l.md | 34 +- .../-object-variable/get-description.md | 34 +- .../get-double-array-member-value-absolute.md | 100 +- .../get-double-array-member-value.md | 100 +- .../get-double-member-value-absolute.md | 50 +- .../get-double-member-value.md | 50 +- .../-object-variable/get-file-extension.md | 42 +- .../-object-variable/get-file-name.md | 42 +- .../-object-variable/get-index-str.md | 72 +- .../get-int-array-member-value-absolute.md | 100 +- .../get-int-array-member-value.md | 100 +- .../get-int-member-value-absolute.md | 50 +- .../-object-variable/get-int-member-value.md | 50 +- .../-object-variable/get-is-binary.md | 42 +- .../get-member-description.md | 50 +- .../-object-variable/get-member-dimensions.md | 42 +- .../get-member-enum-aliases.md | 50 +- .../get-member-enum-values.md | 50 +- .../-object-variable/get-member-index.md | 50 +- .../-object-variable/get-member-length.md | 52 +- .../-object-variable/get-member-list.md | 50 +- .../get-member-lower-bound.md | 50 +- .../get-member-num-dimensions.md | 42 +- .../-object-variable/get-member-property.md | 52 +- .../-object-variable/get-member-type.md | 42 +- .../-object-variable/get-member-units.md | 50 +- .../get-member-upper-bound.md | 42 +- .../get-member-value-absolute-as-string.md | 50 +- .../get-member-value-as-string.md | 50 +- .../-object-variable/get-method-list.md | 34 +- .../get-string-array-member-value-absolute.md | 100 +- .../get-string-array-member-value.md | 100 +- .../get-string-member-value-absolute.md | 50 +- .../get-string-member-value.md | 50 +- .../has-member-lower-bound.md | 50 +- .../has-member-upper-bound.md | 50 +- .../-object-variable/has-member.md | 50 +- .../-object-variable/index.md | 236 +- .../-object-variable/is-non-strict-type.md | 34 +- .../-object-variable/is-numeric-member.md | 50 +- .../-object-variable/reinitialize.md | 26 +- .../set-boolean-array-member-value.md | 88 +- .../set-boolean-member-value.md | 44 +- .../-object-variable/set-description.md | 42 +- .../set-double-array-member-value.md | 88 +- .../set-double-member-value.md | 44 +- .../-object-variable/set-file-extension.md | 42 +- .../-object-variable/set-file-name.md | 42 +- .../set-int-array-member-value.md | 88 +- .../-object-variable/set-int-member-value.md | 44 +- .../-object-variable/set-is-binary.md | 42 +- .../set-member-description.md | 44 +- .../-object-variable/set-member-dimensions.md | 494 +- .../set-member-enum-aliases.md | 44 +- .../set-member-enum-values.md | 44 +- .../set-member-from-string.md | 46 +- .../-object-variable/set-member-length.md | 46 +- .../set-member-lower-bound.md | 44 +- .../-object-variable/set-member-property.md | 46 +- .../-object-variable/set-member-units.md | 44 +- .../set-member-upper-bound.md | 44 +- .../set-member-value-from-string.md | 44 +- .../set-string-array-member-value.md | 88 +- .../set-string-member-value.md | 44 +- .../-object-variable/to-file-absolute.md | 46 +- .../-object-variable/to-file.md | 46 +- .../-object-variable/to-x-m-l.md | 30 +- .../-p-h-x-java-com-object-stored/index.md | 22 +- .../release-c-o-m-objects.md | 26 +- .../-ref-array-prop/get-description.md | 34 +- .../-ref-array-prop/get-enum-values.md | 34 +- .../-ref-array-prop/get-is-input.md | 34 +- .../-ref-array-prop/get-name.md | 34 +- .../-ref-array-prop/get-title.md | 34 +- .../-ref-array-prop/get-type.md | 34 +- .../-ref-array-prop/index.md | 60 +- .../-ref-array-prop/set-description.md | 42 +- .../-ref-array-prop/set-enum-values.md | 42 +- .../-ref-array-prop/set-is-input.md | 42 +- .../-ref-array-prop/set-title.md | 42 +- .../-ref-prop/get-description.md | 34 +- .../-ref-prop/get-enum-values.md | 34 +- .../-ref-prop/get-is-input.md | 34 +- .../-ref-prop/get-name.md | 34 +- .../-ref-prop/get-title.md | 34 +- .../-ref-prop/get-type.md | 34 +- .../-ref-prop/index.md | 60 +- .../-ref-prop/set-description.md | 42 +- .../-ref-prop/set-enum-values.md | 42 +- .../-ref-prop/set-is-input.md | 42 +- .../-ref-prop/set-title.md | 42 +- .../-reference-array/create-ref-prop.md | 44 +- .../get-num-referenced-variables.md | 50 +- .../get-ref-prop-value-absolute.md | 44 +- .../-reference-array/get-ref-prop-value.md | 44 +- .../-reference-array/get-reference.md | 50 +- .../get-referenced-variable.md | 98 +- .../-reference-array/get-value-absolute.md | 50 +- .../-reference-array/get-value.md | 50 +- .../-reference-array/index.md | 128 +- .../-reference-array/set-ref-prop-value.md | 46 +- .../-reference-array/set-reference.md | 44 +- .../-reference-array/set-value.md | 44 +- .../-reference-variable/create-ref-prop.md | 44 +- .../get-num-referenced-variables.md | 34 +- .../get-ref-prop-value-absolute.md | 42 +- .../-reference-variable/get-ref-prop-value.md | 42 +- .../-reference-variable/get-reference.md | 34 +- .../get-referenced-variable.md | 80 +- .../-reference-variable/get-value.md | 34 +- .../-reference-variable/index.md | 106 +- .../-reference-variable/set-ref-prop-value.md | 44 +- .../-reference-variable/set-reference.md | 42 +- .../-reference-variable/set-value.md | 42 +- .../-save-context/close.md | 26 +- .../-save-context/get-save-location.md | 34 +- .../-save-context/index.md | 52 +- .../-save-context/restore-file-stream.md | 50 +- .../-save-context/restore-file.md | 52 +- .../-save-context/save-file-stream.md | 50 +- .../-save-context/save-file.md | 52 +- .../-script-component/add-variable.md | 34 +- .../-script-component/get-forward-schedule.md | 34 +- .../-script-component/get-language.md | 34 +- .../-script-component/get-prevalidate.md | 34 +- .../-script-component/get-source-script.md | 26 +- .../-script-component/get-timeout.md | 34 +- .../-script-component/index.md | 146 +- .../-script-component/remove-variable.md | 26 +- .../-script-component/set-forward-schedule.md | 42 +- .../-script-component/set-language.md | 42 +- .../-script-component/set-prevalidate.md | 42 +- .../-script-component/set-source-from-file.md | 42 +- .../set-source-from-string.md | 42 +- .../-script-component/set-timeout.md | 42 +- .../-script-component/set-variables.md | 26 +- .../-string-array/get-description.md | 34 +- .../-string-array/get-enum-aliases.md | 34 +- .../-string-array/get-enum-values.md | 34 +- .../-string-array/get-value-absolute.md | 600 +- .../-string-array/get-value.md | 600 +- .../-string-array/index.md | 124 +- .../-string-array/set-description.md | 42 +- .../-string-array/set-enum-aliases.md | 42 +- .../-string-array/set-enum-values.md | 42 +- .../-string-array/set-value.md | 534 +- .../-string-variable/get-description.md | 34 +- .../-string-variable/get-enum-aliases.md | 34 +- .../-string-variable/get-enum-values.md | 34 +- .../-string-variable/get-value-absolute.md | 34 +- .../-string-variable/get-value.md | 34 +- .../-string-variable/index.md | 104 +- .../-string-variable/set-description.md | 42 +- .../-string-variable/set-enum-aliases.md | 42 +- .../-string-variable/set-enum-values.md | 42 +- .../-string-variable/set-value.md | 42 +- .../-trade-study/from-string.md | 42 +- .../-trade-study/index.md | 58 +- .../-trade-study/show.md | 34 +- .../-trade-study/to-string.md | 22 +- .../-trade-study2/add-analyzer-variable.md | 44 +- .../-trade-study2/clear-analyzer-variables.md | 26 +- .../-trade-study2/from-string.md | 42 +- .../get-save-all-analyzer-variables.md | 26 +- .../-trade-study2/get-trade-study-callback.md | 26 +- .../-trade-study2/index.md | 72 +- .../-trade-study2/on-end.md | 26 +- .../set-save-all-analyzer-variables.md | 26 +- .../-trade-study2/set-trade-study-callback.md | 42 +- .../-trade-study2/show.md | 34 +- .../-trade-study2/to-string.md | 22 +- .../-trade-study3/get-job-manager.md | 10 +- .../-trade-study3/index.md | 64 +- .../-trade-study3/set-job-manager.md | 10 +- .../-variable-description/-i-n-p-u-t.md | 10 +- .../-variable-description/-o-u-t-p-u-t.md | 10 +- .../-variable-description/get-equation.md | 34 +- .../-variable-description/get-full-name.md | 34 +- .../-variable-description/get-name.md | 34 +- .../-variable-description/get-state.md | 34 +- .../-variable-description/get-type.md | 34 +- .../-variable-description/get-units.md | 34 +- .../-variable-description/index.md | 70 +- .../-variable-description/is-custom.md | 34 +- .../-variable-description/is-numeric.md | 34 +- .../-variable-link/break-link.md | 26 +- .../-variable-link/get-l-h-s.md | 34 +- .../-variable-link/get-r-h-s.md | 34 +- .../-variable-link/index.md | 50 +- .../-variable-link/resume-link.md | 26 +- .../-variable-link/suspend-link.md | 26 +- .../-variable-links/get-count.md | 34 +- .../-variable-links/get-item.md | 96 +- .../-variable-links/has-next.md | 22 +- .../-variable-links/index.md | 54 +- .../-variable-links/next.md | 34 +- .../-variable-links/remove.md | 26 +- .../-variable-links/reset-iterator.md | 14 +- .../get-all-variable-meta-data.md | 50 +- .../get-variable-meta-data.md | 50 +- .../-variable-meta-data-provider/index.md | 44 +- .../-metadata-access/-private/index.md | 10 +- .../-metadata-access/-public/index.md | 10 +- .../-metadata-access/-read-only/index.md | 10 +- .../-variable/-metadata-access/index.md | 56 +- .../-variable/-metadata-access/value-of.md | 34 +- .../-variable/-metadata-access/value.md | 10 +- .../-variable/-metadata-access/values.md | 22 +- .../-metadata-type/-boolean/index.md | 10 +- .../-variable/-metadata-type/-double/index.md | 10 +- .../-variable/-metadata-type/-long/index.md | 10 +- .../-variable/-metadata-type/-string/index.md | 10 +- .../-variable/-metadata-type/-xml/index.md | 10 +- .../-variable/-metadata-type/index.md | 60 +- .../-variable/-metadata-type/value-of.md | 34 +- .../-variable/-metadata-type/value.md | 10 +- .../-variable/-metadata-type/values.md | 22 +- .../-variable/dependent-links.md | 14 +- .../-variable/from-string.md | 26 +- .../-variable/get-direct-dependents.md | 38 +- .../-variable/get-direct-precedents.md | 38 +- .../-variable/get-full-name.md | 34 +- .../-variable/get-has-changed.md | 34 +- .../-variable/get-hide.md | 34 +- .../-variable/get-metadata.md | 38 +- .../-variable/get-name.md | 34 +- .../-variable/get-owning-component.md | 14 +- .../-variable/get-type.md | 72 +- .../-variable/index.md | 144 +- .../-variable/invalidate.md | 26 +- .../-variable/is-input-to-component.md | 34 +- .../-variable/is-input-to-model.md | 34 +- .../-variable/is-input.md | 54 +- .../-variable/is-valid.md | 34 +- .../-variable/precedent-links.md | 14 +- .../-variable/set-has-changed.md | 42 +- .../-variable/set-hide.md | 42 +- .../-variable/set-metadata.md | 38 +- .../-variable/to-string-absolute.md | 34 +- .../-variable/to-string.md | 34 +- .../-variable/validate.md | 26 +- .../-variables/get-count.md | 34 +- .../-variables/get-item.md | 96 +- .../-variables/has-next.md | 22 +- .../-variables/index.md | 54 +- .../-variables/next.md | 34 +- .../-variables/remove.md | 26 +- .../-variables/reset-iterator.md | 14 +- .../-variant/-b-o-o-l-e-a-n.md | 10 +- .../-variant/-b-o-o-l-e-a-n_-a-r-r-a-y.md | 10 +- .../-variant/-d-i-s-p-a-t-c-h.md | 10 +- .../-variant/-d-o-u-b-l-e.md | 10 +- .../-variant/-d-o-u-b-l-e_-a-r-r-a-y.md | 10 +- .../-variant/-i-n-t.md | 10 +- .../-variant/-i-n-t_-a-r-r-a-y.md | 10 +- .../-variant/-l-o-n-g.md | 10 +- .../-variant/-l-o-n-g_-a-r-r-a-y.md | 10 +- .../-variant/-r-e-f-e-r-e-n-c-e.md | 10 +- .../-variant/-s-t-r-i-n-g.md | 10 +- .../-variant/-s-t-r-i-n-g_-a-r-r-a-y.md | 10 +- .../-variant/-u-n-k-n-o-w-n.md | 10 +- .../-variant/-variant.md | 32 +- .../-variant/boolean-array-value.md | 10 +- .../-variant/boolean-value.md | 10 +- .../-variant/double-array-value.md | 10 +- .../-variant/double-value.md | 10 +- .../-variant/get-type.md | 10 +- .../-variant/get-value.md | 10 +- .../-variant/index.md | 106 +- .../-variant/int-array-value.md | 10 +- .../-variant/int-value.md | 10 +- .../-variant/long-array-value.md | 10 +- .../-variant/long-value.md | 10 +- .../-variant/string-array-value.md | 10 +- .../-variant/string-value.md | 10 +- .../-variant/to-string.md | 10 +- .../com.phoenix_int.ModelCenter/index.md | 158 +- .../mc_api/package-list | 3284 +++---- 1465 files changed, 81549 insertions(+), 84344 deletions(-) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/ComponentPlugIn_8odl.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/ComponentPlugIn_8odl.md index ae11c26fcc..d7032c47e0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/ComponentPlugIn_8odl.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/ComponentPlugIn_8odl.md @@ -1,69 +1,68 @@ - -# File ComponentPlugIn.odl - -![][IDL] - -**Location**: `ModelCenter/src/InterfaceDLL\_ComponentPlugIn/ComponentPlugIn.odl` - - - - - -## Classes - -* [ComponentPlugIn::IComponentPlugIn](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn) - -## Namespaces - -* [ComponentPlugIn](namespaceComponentPlugIn.md#namespaceComponentPlugIn) - -## Source - -``` -// ComponentPlugIn.odl : type library source for ComponentPlugIn.dll - -// This file will be processed by the MIDL compiler to produce the -// type library (ComponentPlugIn.tlb). - -[ uuid(58B97B6D-BD2D-47F5-9305-C83E3337A120), version(1.0) ] -library ComponentPlugIn -{ - importlib("stdole32.tlb"); - importlib("stdole2.tlb"); - - - - - // Primary dispatch interface for PHXCOMComponentPlugIn - - [ uuid(BDE1B2FF-1745-438C-B7CE-F671BE78BE01) ] - dispinterface IComponentPlugIn - { - properties: - // NOTE - ClassWizard will maintain property information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_PROP(PHXCOMComponentPlugIn) - //}}AFX_ODL_PROP - - methods: - // NOTE - ClassWizard will maintain method information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_METHOD(PHXCOMComponentPlugIn) - [id(1)] void construct(IDispatch* modelCenter, IDispatch* addToModel, [defaultvalue(NULL)]IDispatch* dataCollector); - [id(2)] boolean show(); - [id(3)] BSTR toString(); - [id(4)] void fromString(BSTR setupString); - [id(5)] void run(); - [id(6)] void onEnd(); - //}}AFX_ODL_METHOD - - }; - - //{{AFX_APPEND_ODL}} - //}}AFX_APPEND_ODL}} -}; -``` - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# File ComponentPlugIn.odl + +![][IDL] + +**Location**: `ModelCenter/src/InterfaceDLL\_ComponentPlugIn/ComponentPlugIn.odl` + + + + + +## Classes + +* [ComponentPlugIn::IComponentPlugIn](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn) + +## Namespaces + +* [ComponentPlugIn](namespaceComponentPlugIn.md#namespaceComponentPlugIn) + +## Source + +``` +// ComponentPlugIn.odl : type library source for ComponentPlugIn.dll + +// This file will be processed by the MIDL compiler to produce the +// type library (ComponentPlugIn.tlb). + +[ uuid(58B97B6D-BD2D-47F5-9305-C83E3337A120), version(1.0) ] +library ComponentPlugIn +{ + importlib("stdole32.tlb"); + importlib("stdole2.tlb"); + + + + + // Primary dispatch interface for PHXCOMComponentPlugIn + + [ uuid(BDE1B2FF-1745-438C-B7CE-F671BE78BE01) ] + dispinterface IComponentPlugIn + { + properties: + // NOTE - ClassWizard will maintain property information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_PROP(PHXCOMComponentPlugIn) + //}}AFX_ODL_PROP + + methods: + // NOTE - ClassWizard will maintain method information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_METHOD(PHXCOMComponentPlugIn) + [id(1)] void construct(IDispatch* modelCenter, IDispatch* addToModel, [defaultvalue(NULL)]IDispatch* dataCollector); + [id(2)] boolean show(); + [id(3)] BSTR toString(); + [id(4)] void fromString(BSTR setupString); + [id(5)] void run(); + [id(6)] void onEnd(); + //}}AFX_ODL_METHOD + + }; + + //{{AFX_APPEND_ODL}} + //}}AFX_APPEND_ODL}} +}; +``` + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/ModelCenter_8odl.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/ModelCenter_8odl.md index bb37b2ba43..d379a0ffcd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/ModelCenter_8odl.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/ModelCenter_8odl.md @@ -1,2447 +1,2446 @@ - -# File ModelCenter.odl - -![][IDL] - -**Location**: `ModelCenter/src/ModelCenter.odl` - - - - - -## Classes - -* [ModelCenter::IAddToModel](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel) -* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) -* [ModelCenter::IAssemblies](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies) -* [ModelCenter::IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) -* [ModelCenter::IBooleanArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray) -* [ModelCenter::IBooleanVariable](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable) -* [ModelCenter::IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) -* [ModelCenter::IComponents](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents) -* [ModelCenter::IIfComponent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent) -* [ModelCenter::IScriptComponent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent) -* [ModelCenter::ICustomDesignPoint](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint) -* [ModelCenter::IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) -* [ModelCenter::IDoubleArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray) -* [ModelCenter::IDoubleVariable](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable) -* [ModelCenter::IObjectVariable](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable) -* [ModelCenter::IFeature](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature) -* [ModelCenter::IFileArray](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray) -* [ModelCenter::IFileVariable](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable) -* [ModelCenter::IGeometryVariable](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable) -* [ModelCenter::IGroup](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup) -* [ModelCenter::IGroups](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups) -* [ModelCenter::IIntegerArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray) -* [ModelCenter::IIntegerVariable](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable) -* [ModelCenter::IJobManager](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager) -* [ModelCenter::IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) -* [ModelCenter::ILoginCallback](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback) -* [ModelCenter::ITradeStudyEvents](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents) -* [ModelCenter::IShowHelpEvents](interfaceModelCenter_1_1IShowHelpEvents.md#interfaceModelCenter_1_1IShowHelpEvents) -* [ModelCenter::Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) -* [ModelCenter::INetworkLocations](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations) -* [ModelCenter::IRefArrayProp](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp) -* [ModelCenter::IReferenceArray](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray) -* [ModelCenter::IReferenceVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable) -* [ModelCenter::IRefProp](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp) -* [ModelCenter::IStringArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray) -* [ModelCenter::IStringVariable](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable) -* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) -* [ModelCenter::IVariableDescription](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription) -* [ModelCenter::IVariableLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink) -* [ModelCenter::IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) -* [ModelCenter::IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) -* [ModelCenter::IPHXFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat) -* [ModelCenter::IDataMonitor](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor) -* [ModelCenter::IGlobalParameters](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters) -* [ModelCenter::ILogger](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger) -* [ModelCenter::ICachePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin) -* [ModelCenter::IFileSystemInfo](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo) -* [ModelCenter::IVizContainer](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer) - -## Namespaces - -* [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) - -## Source - -``` -// ModelCenter.odl : type library source for ModelCenter.exe - -// This file will be processed by the MIDL compiler to produce the type library (ModelCenter.tlb). - -// Change STKAnalyzer Library GUID, CLSID, and progId for every release no matter major or minor releases, to support -// Independency from different releases. This value is unique for each release and must match the LIBID_PHXModelCenter -// value in ModelCenter.cpp and ModelCenterTypeLibrary/dummy.cpp -#if defined(STKOEM) -[uuid(F7548BF3-FB88-43F0-BEC0-D199070AF13C), version(1.0), - helpstring("Phoenix Integration - STKAnalyzer") ] -#else -[ uuid(757DD9B4-E5E1-11d2-81A3-0060975E6478), version(1.0), - helpstring("Phoenix Integration - ModelCenter") ] -#endif -library ModelCenter -{ - importlib("stdole32.tlb"); - - // -------------------------------------------------------------- General Enumerations - - // DO NOT CHANGE THE NUMERIC CONSTANTS! - // (The Java API relies on them staying constant.) - - typedef enum - { - METADATA_TYPE_STRING = 0, - METADATA_TYPE_DOUBLE = 1, - METADATA_TYPE_LONG = 2, - METADATA_TYPE_BOOLEAN = 3, - METADATA_TYPE_XML = 4, - METADATA_TYPE_FORCE_TO_32_BITS = 65536 - } MetadataType; - - typedef enum - { - METADATA_ACCESS_PRIVATE = 0, - METADATA_ACCESS_READONLY = 1, - METADATA_ACCESS_PUBLIC = 2, - METADATA_ACCESS_FORCE_TO_32_BITS = 65536 - } MetadataAccess; - - typedef enum - { - TS_FORMAT_PXTZ = 0, - - TS_FORMAT_PXT_COMPRESSED = 1, - - TS_FORMAT_PXT_UNCOMPRESSED = 2, - - TS_FORMAT_TSTUDY = 3 - } TradeStudyFormat; - - // -------------------------------------------------------------- IAddToModel - [ uuid(6B3DCC47-6475-411C-977E-337F73A43771), - helpstring("AddToModel object") ] - dispinterface IAddToModel - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - [id(7)] boolean prevalidateInputs; - [id(8)] boolean autoRun; - - methods: - [id(1)] void addToModel(); - [id(2)] void updateComponent(); - [id(3)] IDispatch* getComponent(); - [id(4)] BSTR getRegID(); - [id(5)] IDispatch* addInput(BSTR name, BSTR type, [optional]VARIANT value); - [id(6)] IDispatch* addOutput(BSTR name, BSTR type, [optional]VARIANT value); - [id(9)] BSTR getProgID(); - [id(10)] void setAuthor(BSTR author); - [id(11)] void setDescription(BSTR description); - [id(12)] void setVersion(BSTR version); - [id(13)] void setHelpURL(BSTR helpURL); - [id(14)] void setKeywords(BSTR keywords); - [id(15)] void clearBusyFlag(); - [id(16)] boolean addToModel2(); - [id(17)] void setComponentRequirements(BSTR compReq); - [id(18)] void setIcon(BSTR iconFile); - [id(19)] void addMethod(BSTR name, [optional]VARIANT displayName); - [id(20)] IDispatch* addInput2(BSTR name, BSTR type, BSTR classURL, [optional]VARIANT value); - [id(21)] IDispatch* addOutput2(BSTR name, BSTR type, BSTR classURL, [optional]VARIANT value); - [id(22)] BSTR addToModel3(BSTR suggestedName); - }; - - // -------------------------------------------------------------- IArray - [ uuid(6CBF1A48-679A-11D3-A518-00A024B5452E), - helpstring("Array base class") ] - dispinterface IArray - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // inherited from IVariable - [id(17)] boolean hasChanged; - [id(18)] boolean hide; - [id(22)] LPDISPATCH OwningComponent; - - // our properties - [id(1001)] long size; - [id(1005)] boolean autoSize; - [id(1006)] long numDimensions; - [id(1010)] long length; - - methods: - // inherited from IVariable - [id(1)] boolean isValid(); - [id(2)] void validate(); - [id(3)] BSTR getName(); - [id(4)] BSTR getFullName(); - [id(5)] BSTR getType(); - [id(6)] boolean isInput(); - [id(7)] BSTR toString(); - [id(8)] void fromString(BSTR value); - [id(9)] BSTR toStringAbsolute(); - [id(10)] void invalidate(); - [id(11)] LPDISPATCH directPrecedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(12)] LPDISPATCH directDependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(13)] LPDISPATCH precedentLinks( - [optional]VARIANT reserved); - [id(14)] LPDISPATCH dependentLinks( - [optional]VARIANT reserved); - [id(15)] LPDISPATCH precedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(16)] LPDISPATCH dependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(19)] boolean isInputToComponent(); - [id(20)] boolean isInputToModel(); - [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); - [id(23)] VARIANT getMetadata(BSTR name); - - // our methods - - [id(1002)] BSTR toStringEx(long index); - [id(1003)] void fromStringEx(BSTR value, long index); - [id(1004)] BSTR toStringAbsoluteEx(long index); - [id(1007)] long getLength( [optional] VARIANT dim); - [id(1008)] void setLength(long length, [optional] VARIANT dim); - [id(1009)] void setDimensions( long d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(1011)] long getSize( [optional] VARIANT dim); - [id(1012)] void setSize(long length, [optional] VARIANT dim); - [id(1013)] VARIANT getDimensions(); - }; - - // -------------------------------------------------------------- IAssemblies - [ uuid(0D132C3C-CA70-11D5-A008-0010A4C22C0F), - helpstring("Assemblies object") ] - dispinterface IAssemblies - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - [id(1)] VARIANT Count; - - methods: - [id(2)] VARIANT Item(VARIANT id); - }; - - // -------------------------------------------------------------- IAssembly - typedef enum - { - DO_VERSIONING = 0, - DO_NOT_VERSION = 1, - DO_VERSIONING_IF_POSSIBLE = 2 - } VersionStatus; - - [ uuid(0D132C36-CA70-11D5-A008-0010A4C22C0F), - helpstring("Assembly") ] - dispinterface IAssembly - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - [id(1)] VARIANT Variables; - [id(2)] VARIANT Groups; - [id(3)] VARIANT Assemblies; - [id(4)] VARIANT Components; - [id(9)] int iconID; - [id(15)] int IndexInParent; - [id(16)] LPDISPATCH ParentAssembly; - [id(17)] BSTR AssemblyType; - - [id(18)] VARIANT userData; - - methods: - [id(5)] BSTR getName(); - [id(6)] BSTR getFullName(); - [id(7)] IDispatch* addAssembly(BSTR name, [optional]VARIANT assemblyType); - [id(8)] IDispatch* addVariable(BSTR name, BSTR type); - [id(10)] int getPositionX(); - [id(11)] int getPositionY(); - [id(12)] void rename(BSTR name); - [id(13)] void deleteVariable(BSTR name); - [id(14)] LPDISPATCH addAssembly2(BSTR name, VARIANT xPos, VARIANT yPos, [optional]VARIANT assemblyType); - [id(19)] void convertToSubmodel(BSTR fileName, VersionStatus versionStatus, BSTR checkinMessage); - [id(20)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); - [id(21)] VARIANT getMetadata(BSTR name); - }; - - // -------------------------------------------------------------- IBooleanArray - [ uuid(6CBF1A4F-679A-11D3-A518-00A024B5452E), - helpstring("Boolean variable array") ] - dispinterface IBooleanArray - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // inherited from IVariable - [id(17)] boolean hasChanged; - [id(18)] boolean hide; - [id(22)] LPDISPATCH OwningComponent; - - // inherited from IArray - [id(1001)] long size; - [id(1006)] long numDimensions; - - // our properties - [id(2002)] BSTR description; - - methods: - // inherited from IVariable - [id(1)] boolean isValid(); - [id(2)] void validate(); - [id(3)] BSTR getName(); - [id(4)] BSTR getFullName(); - [id(5)] BSTR getType(); - [id(6)] boolean isInput(); - [id(7)] BSTR toString(); - [id(8)] void fromString(BSTR value); - [id(9)] BSTR toStringAbsolute(); - [id(10)] void invalidate(); - [id(11)] LPDISPATCH directPrecedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(12)] LPDISPATCH directDependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(13)] LPDISPATCH precedentLinks( - [optional]VARIANT reserved); - [id(14)] LPDISPATCH dependentLinks( - [optional]VARIANT reserved); - [id(15)] LPDISPATCH precedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(16)] LPDISPATCH dependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(19)] boolean isInputToComponent(); - [id(20)] boolean isInputToModel(); - [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); - [id(23)] VARIANT getMetadata(BSTR name); - - // inherited from IArray - [id(1002)] BSTR toStringEx(long index); - [id(1003)] void fromStringEx(BSTR value, long index); - [id(1004)] BSTR toStringAbsoluteEx(long index); - [id(1007)] long getLength( [optional] VARIANT dim); - [id(1008)] void setLength(long length, [optional] VARIANT dim); - [id(1009)] void setDimensions( long d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - - // our methods - [id(2001), propget] boolean value(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(2001), propput] void value(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10, - BOOL newValue); - [id(2003)] boolean getValue(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(2004)] void setValue(BOOL value, VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(2005)] VARIANT getArray(); - [id(2006)] void setArray( VARIANT array ); - [id(2007)] boolean getValueAbsolute(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - }; - - // -------------------------------------------------------------- IBooleanVariable - [ uuid(985910EA-C34D-11D2-A4E8-00A024B5452E), - helpstring("Boolean variable") ] - dispinterface IBooleanVariable - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // inherited from IVariable - [id(17)] boolean hasChanged; - [id(18)] boolean hide; - [id(22)] LPDISPATCH OwningComponent; - - // our properties - [id(1001)] boolean value; - [id(1004)] boolean valueAbsolute; - [id(1002)] BSTR description; - - methods: - // inherited from IVariable - [id(1)] boolean isValid(); - [id(2)] void validate(); - [id(3)] BSTR getName(); - [id(4)] BSTR getFullName(); - [id(5)] BSTR getType(); - [id(6)] boolean isInput(); - [id(7)] BSTR toString(); - [id(8)] void fromString(BSTR value); - [id(9)] BSTR toStringAbsolute(); - [id(10)] void invalidate(); - [id(11)] LPDISPATCH directPrecedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(12)] LPDISPATCH directDependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(13)] LPDISPATCH precedentLinks( - [optional]VARIANT reserved); - [id(14)] LPDISPATCH dependentLinks( - [optional]VARIANT reserved); - [id(15)] LPDISPATCH precedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(16)] LPDISPATCH dependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(19)] boolean isInputToComponent(); - [id(20)] boolean isInputToModel(); - [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); - [id(23)] VARIANT getMetadata(BSTR name); - - // our methods - [id(1003)] void setInitialValue(BOOL value); - - }; - - // -------------------------------------------------------------- IComponent - [ uuid(526AC1E1-D718-11D3-A544-00A024B5452E), - helpstring("Component") ] - dispinterface IComponent - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - [id(5)] VARIANT Variables; - [id(6)] VARIANT Groups; - [id(11)] VARIANT userData; - [id(15)] VARIANT AssociatedFiles; - [id(18)] int IndexInParent; - [id(19)] LPDISPATCH ParentAssembly; - - methods: - [id(1)] BSTR getName(); - [id(2)] BSTR getFullName(); - [id(3)] void run(); - [id(4)] BSTR getSource(); - [id(7)] void invokeMethod(BSTR method); - [id(8)] void invalidate(); - [id(9)] void reconnect(); - [id(10)] void downloadValues(); - [id(12)] LPDISPATCH getVariable(BSTR name); - [id(13)] int getPositionX(); - [id(14)] int getPositionY(); - [id(16)] void rename(BSTR name); - [id(17)] BSTR getType(); - [id(20)] void show(); - [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); - [id(22)] VARIANT getMetadata(BSTR name); - }; - - // -------------------------------------------------------------- IComponents - [ uuid(712469FD-A1E9-4450-BE93-457ED13A91F1), - helpstring("Components object") ] - dispinterface IComponents - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - [id(1)] VARIANT Count; - - methods: - [id(2)] VARIANT Item(VARIANT id); - }; - - // -------------------------------------------------------------- IIfComponent - [ uuid(897c0864-810e-444a-b648-f6f08c639bc3), - helpstring("If component") ] - dispinterface IIfComponent - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - //inherited from IComponent - [id(5)] VARIANT Variables; - [id(6)] VARIANT Groups; - [id(11)] VARIANT userData; - [id(15)] VARIANT AssociatedFiles; - [id(18)] int IndexInParent; - [id(19)] LPDISPATCH ParentAssembly; - - //our properties - [id(1001)] boolean exclusive; - [id(1002)] boolean runLastBranchByDefault; - - methods: - - //inherited from IComponent - [id(1)] BSTR getName(); - [id(2)] BSTR getFullName(); - [id(3)] void run(); - [id(4)] BSTR getSource(); - [id(7)] void invokeMethod(BSTR method); - [id(8)] void invalidate(); - [id(9)] void reconnect(); - [id(10)] void downloadValues(); - [id(12)] LPDISPATCH getVariable(BSTR name); - [id(13)] int getPositionX(); - [id(14)] int getPositionY(); - [id(16)] void rename(BSTR name); - [id(17)] BSTR getType(); - [id(20)] void show(); - - //our methods - [id(1003)] int getNumBranches(); - [id(1004)] BSTR getBranchCondition( int index ); - [id(1005)] void setBranchCondition( int index, BSTR condition ); - [id(1006)] BSTR getBranchName( int index ); - [id(1007)] void renameBranch( int index, BSTR name ); - }; - - // -------------------------------------------------------------- IScriptComponent - [ uuid(126c0864-810e-535a-b648-f6f08c548bc3), - helpstring("Script component") ] - dispinterface IScriptComponent - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - //inherited from IComponent - [id(5)] VARIANT Variables; - [id(6)] VARIANT Groups; - [id(11)] VARIANT userData; - [id(15)] VARIANT AssociatedFiles; - [id(18)] int IndexInParent; - [id(19)] LPDISPATCH ParentAssembly; - - [id(1001)] BSTR language; - [id(1002)] double timeout; - [id(1003)] boolean forwardSchedule; - [id(1004)] boolean prevalidate; - - methods: - - //inherited from IComponent - [id(1)] BSTR getName(); - [id(2)] BSTR getFullName(); - [id(3)] void run(); - [id(4)] BSTR getSource(); - [id(7)] void invokeMethod(BSTR method); - [id(8)] void invalidate(); - [id(9)] void reconnect(); - [id(10)] void downloadValues(); - [id(12)] LPDISPATCH getVariable(BSTR name); - [id(13)] int getPositionX(); - [id(14)] int getPositionY(); - [id(16)] void rename(BSTR name); - [id(17)] BSTR getType(); - [id(20)] void show(); - - //our methods - [id(1010)] void setSourceFromString(BSTR script); - [id(1011)] void setSourceFromFile(BSTR file); - [id(1012)] LPDISPATCH addVariable(BSTR name, BSTR type, BSTR state); - [id(1013)] void removeVariable(BSTR name); - [id(1014)] void setVariables(VARIANT inputs, BSTR outputs); - [id(1015)] BSTR getSourceScript(); - }; - - // -------------------------------------------------------------- ICustomDesignPoint - [ uuid(214FB734-840B-4BC1-A063-1D2DFA0C6D0A), - helpstring("Data Collector Custom Design Point object") ] - dispinterface ICustomDesignPoint - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // properties go here - - methods: - [id(1)] void addVariable(BSTR name, BSTR equation, BOOL isNumeric, - BOOL isValid, BOOL isInput,BSTR type, - BSTR units, BSTR value); - [id(2)] void runFailed(BSTR reason); - }; - - // -------------------------------------------------------------- IDataCollector - [ uuid(1539CF41-7B1A-11D3-A526-00A024B5452E), - helpstring("Data Collector object") ] - dispinterface IDataCollector - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // properties go here - [id(30)] BOOL isVisible; - - methods: - [id(1)] void storeCurrentDesignPoint(); - [id(2)] void enableGraphTab(BOOL flag); - [id(3)] void show(); - [id(4)] void addCustom(BSTR variable, BSTR label); - [id(5)] void selectX(BSTR name); - [id(6)] void selectY(BSTR name); - [id(7)] void setNumExpectedRuns(long numRuns); - [id(8)] void startRuns(); - [id(9)] void endRuns(); - [id(10)] long getNumFailedRuns(); - [id(11)] int getErrorID( long run ); - [id(12)] BSTR getErrorMessage( long run ); - [id(13)] long getNumRuns(); - [id(14)] long getNumVariables(); - [id(15)] VARIANT getValue( VARIANT index, long run ); - [id(16)] IDispatch* getVariableDescription( VARIANT index ); - [id(17)] BOOL isValid( VARIANT index, long run ); - [id(18)] void save(BSTR fileName, BSTR displayName, BSTR description, BSTR author, BOOL saveModel); - [id(19)] void exportToCSV(BSTR fileName); - [id(20)] BSTR toString(); - [id(21)] void fromString(BSTR str); - [id(22)] void enableCarpetPlotTab(BSTR var1, BSTR var2, BSTR plotVar); - [id(23)] void storeCustomDesignPoint(IDispatch* customDesignPoint); - [id(24)] void createEmptyRuns(long numEmptyRuns); - [id(25)] void setCustomRun(long index,IDispatch* customDesignPoint); - [id(26)] IDispatch* newCustomDesignPoint(); - [id(27)] void enableMainEffectsTab(); - [id(28)] IDispatch* getDataExplorer(); - [id(29)] void hide(); - }; - - // -------------------------------------------------------------- IDoubleArray - [ uuid(514D1080-6A11-11D3-A518-00A024B5452E), - helpstring("Double variable array") ] - dispinterface IDoubleArray - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // inherited from IVariable - [id(17)] boolean hasChanged; - [id(18)] boolean hide; - [id(22)] LPDISPATCH OwningComponent; - - // inherited from IArray - [id(1001)] long size; - [id(1006)] long numDimensions; - - // our properties - [id(2002)] double lowerBound; - [id(2003)] double upperBound; - [id(2004)] BSTR description; - [id(2005)] BSTR units; - [id(2006)] BSTR enumAliases; - [id(2007)] BSTR enumValues; - [id(2014)] BSTR format; - - methods: - // inherited from IVariable - [id(1)] boolean isValid(); - [id(2)] void validate(); - [id(3)] BSTR getName(); - [id(4)] BSTR getFullName(); - [id(5)] BSTR getType(); - [id(6)] boolean isInput(); - [id(7)] BSTR toString(); - [id(8)] void fromString(BSTR value); - [id(9)] BSTR toStringAbsolute(); - [id(10)] void invalidate(); - [id(11)] LPDISPATCH directPrecedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(12)] LPDISPATCH directDependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(13)] LPDISPATCH precedentLinks( - [optional]VARIANT reserved); - [id(14)] LPDISPATCH dependentLinks( - [optional]VARIANT reserved); - [id(15)] LPDISPATCH precedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(16)] LPDISPATCH dependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(19)] boolean isInputToComponent(); - [id(20)] boolean isInputToModel(); - [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); - [id(23)] VARIANT getMetadata(BSTR name); - - // inherited from IArray - [id(1002)] BSTR toStringEx(long index); - [id(1003)] void fromStringEx(BSTR value, long index); - [id(1004)] BSTR toStringAbsoluteEx(long index); - [id(1007)] long getLength( [optional] VARIANT dim); - [id(1008)] void setLength(long length, [optional] VARIANT dim); - [id(1009)] void setDimensions( long d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - - // our methods - [id(2001), propget] double value(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(2001), propput] void value(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10, - double newValue); - [id(2008)] boolean hasLowerBound(); - [id(2009)] boolean hasUpperBound(); - [id(2010)] double getValue(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(2011)] void setValue(double value, VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(2012)] VARIANT getArray(); - [id(2013)] void setArray( VARIANT array ); - [id(2015)] BSTR toFormattedStringEx(long index); - [id(2016)] void fromFormattedStringEx(BSTR value, long index); - [id(2017)] BSTR toFormattedStringAbsoluteEx(long index); - [id(2018)] void clearUpperBound(); - [id(2019)] void clearLowerBound(); - [id(2020)] double getValueAbsolute(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - }; - - // -------------------------------------------------------------- IDoubleVariable - [ uuid(985910E7-C34D-11D2-A4E8-00A024B5452E), - helpstring("Double variable") ] - dispinterface IDoubleVariable - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // inherited from IVariable - [id(17)] boolean hasChanged; - [id(18)] boolean hide; - [id(22)] LPDISPATCH OwningComponent; - - // our properties - [id(1001)] double value; - [id(1017)] double valueAbsolute; - [id(1002)] double lowerBound; - [id(1003)] double upperBound; - [id(1004)] BSTR units; - [id(1005)] BSTR description; - [id(1006)] BSTR enumValues; - [id(1007)] BSTR enumAliases; - [id(1011)] BSTR format; - - methods: - // inherited from IVariable - [id(1)] boolean isValid(); - [id(2)] void validate(); - [id(3)] BSTR getName(); - [id(4)] BSTR getFullName(); - [id(5)] BSTR getType(); - [id(6)] boolean isInput(); - [id(7)] BSTR toString(); - [id(8)] void fromString(BSTR value); - [id(9)] BSTR toStringAbsolute(); - [id(10)] void invalidate(); - [id(11)] LPDISPATCH directPrecedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(12)] LPDISPATCH directDependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(13)] LPDISPATCH precedentLinks( - [optional]VARIANT reserved); - [id(14)] LPDISPATCH dependentLinks( - [optional]VARIANT reserved); - [id(15)] LPDISPATCH precedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(16)] LPDISPATCH dependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(19)] boolean isInputToComponent(); - [id(20)] boolean isInputToModel(); - [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); - [id(23)] VARIANT getMetadata(BSTR name); - - // our methods - [id(1008)] void setInitialValue(double value); - [id(1009)] boolean hasLowerBound(); - [id(1010)] boolean hasUpperBound(); - [id(1012)] BSTR toFormattedString(); - [id(1013)] void fromFormattedString(BSTR value); - [id(1014)] BSTR toFormattedStringAbsolute(); - [id(1015)] void clearUpperBound(); - [id(1016)] void clearLowerBound(); - - }; - - // -------------------------------------------------------------- IObjectVariable - [ uuid(989FF781-95F2-4cfa-A10E-57D169BDD0F3), - helpstring("Object variable") ] - dispinterface IObjectVariable - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // inherited from IVariable - [id(17)] boolean hasChanged; - [id(18)] boolean hide; - [id(22)] LPDISPATCH OwningComponent; - - // our properties - [id(1001)] BSTR value; - [id(1002)] BSTR description; - - methods: - // inherited from IVariable - [id(1)] boolean isValid(); - [id(2)] void validate(); - [id(3)] BSTR getName(); - [id(4)] BSTR getFullName(); - [id(5)] BSTR getType(); - [id(6)] boolean isInput(); - [id(7)] BSTR toString(); - [id(8)] void fromString(BSTR value); - [id(9)] BSTR toStringAbsolute(); - [id(10)] void invalidate(); - [id(11)] LPDISPATCH directPrecedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(12)] LPDISPATCH directDependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(13)] LPDISPATCH precedentLinks( - [optional]VARIANT reserved); - [id(14)] LPDISPATCH dependentLinks( - [optional]VARIANT reserved); - [id(15)] LPDISPATCH precedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(16)] LPDISPATCH dependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(19)] boolean isInputToComponent(); - [id(20)] boolean isInputToModel(); - [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); - [id(23)] VARIANT getMetadata(BSTR name); - - // our methods - [id(1011)] BSTR getClassURL(); - [id(1012)] VARIANT getMemberValue(BSTR member); - [id(1013)] VARIANT getMemberValueAbsolute(BSTR member); - [id(1014)] void setMemberValue(BSTR member, BSTR value); - [id(1015)] void setMember(BSTR member, BSTR value, BSTR type); - [id(1016)] void deleteMember(BSTR member); - [id(1017)] void deleteAllMembers(); - [id(1018)] VARIANT callMethod(BSTR method); - [id(1019)] boolean isNonStrictType(); - [id(1020)] BSTR toXML(); - [id(1021)] void fromXML(BSTR str); - [id(1022)] boolean hasMember(BSTR member); - [id(1023)] boolean isNumericMember(BSTR member); - [id(1024)] void reinitialize(); - [id(1025)] long getMemberLength(BSTR member, [optional] VARIANT dim); - [id(1026)] void setMemberLength(BSTR member, long length, [optional] VARIANT dim); - [id(1027)] void setMemberDimensions( BSTR member, - long d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(1028)] long getMemberNumDimensions( BSTR member ); - [id(1029)] VARIANT getMemberDimensions( BSTR member ); - [id(1030)] BSTR getMemberType(BSTR member); - [id(1031)] boolean hasMemberLowerBound(BSTR member); - [id(1032)] boolean hasMemberUpperBound(BSTR member); - [id(1033)] double getMemberLowerBound(BSTR member); - [id(1034)] void setMemberLowerBound(BSTR member, double lowerBound); - [id(1035)] double getMemberUpperBound(BSTR member); - [id(1036)] void setMemberUpperBound(BSTR member, double upperBound); - [id(1037)] BSTR getMemberEnumValues(BSTR member); - [id(1038)] void setMemberEnumValues(BSTR member, BSTR enumValues); - [id(1039)] BSTR getMemberEnumAliases(BSTR member); - [id(1040)] void setMemberEnumAliases(BSTR member, BSTR enumAliases); - [id(1041)] BSTR getMemberDescription(BSTR member); - [id(1042)] void setMemberDescription(BSTR member, BSTR description); - [id(1043)] BSTR getMemberUnits(BSTR member); - [id(1044)] void setMemberUnits(BSTR member, BSTR units); - [id(1045)] BSTR getMemberProperty(BSTR member, BSTR propertyName); - [id(1046)] void setMemberProperty(BSTR member, BSTR propertyName, BSTR propertyValue); - [id(1047)] VARIANT getMemberList(BSTR member); - [id(1048)] VARIANT getMethodList(); - [id(1049)] void toFile(BSTR member, BSTR fileName, VARIANT encoding); - [id(1050)] void fromFile(BSTR member, BSTR fileName); - [id(1051)] void toFileAbsolute(BSTR member, BSTR fileName, VARIANT encoding); - [id(1052)] boolean getIsBinary(BSTR member); - [id(1053)] void setIsBinary(BSTR member, boolean isBinary); - [id(1054)] BSTR getFileName(BSTR member); - [id(1055)] void setFileName(BSTR member, BSTR fileName); - [id(1056)] BSTR getFileExtension(BSTR member); - [id(1057)] void setFileExtension(BSTR member, BSTR fileExtension); - [id(1101)] VARIANT getArrayMemberValueAbsolute(BSTR member, VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(1102)] VARIANT getArrayMemberValue(BSTR member, VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(1103)] void setArrayMemberValue(BSTR member, BSTR value, VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(1104)] VARIANT getArrayMemberAbsolute(BSTR member); - [id(1105)] VARIANT getArrayMember(BSTR member); - [id(1106)] void setArrayMember( BSTR member, VARIANT array ); - - - }; - // -------------------------------------------------------------- IFeature - [ uuid(22D5CD66-AF6F-48F7-AC03-80095DE85C94), - helpstring("FlexLM Feature") ] - dispinterface IFeature - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // properties go here - - methods: - [id(1)] void checkin(); - }; - - // -------------------------------------------------------------- IFileArray - [ uuid(14F18BD0-5BD9-4fcc-B084-7D95360631BE), - helpstring("File variable array") ] - dispinterface IFileArray - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // inherited from IVariable - [id(17)] boolean hasChanged; - [id(18)] boolean hide; - [id(22)] LPDISPATCH OwningComponent; - - // inherited from IArray - [id(1001)] long size; - [id(1006)] long numDimensions; - - // our properties - [id(2002)] boolean isBinary; - [id(2003)] BSTR description; - [id(2013)] boolean saveWithModel; - //NOT SUPPORTED [id(2014)] boolean directTransfer; - - methods: - // inherited from IVariable - [id(1)] boolean isValid(); - [id(2)] void validate(); - [id(3)] BSTR getName(); - [id(4)] BSTR getFullName(); - [id(5)] BSTR getType(); - [id(6)] boolean isInput(); - [id(7)] BSTR toString(); - [id(8)] void fromString(BSTR value); - [id(9)] BSTR toStringAbsolute(); - [id(10)] void invalidate(); - [id(11)] LPDISPATCH directPrecedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(12)] LPDISPATCH directDependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(13)] LPDISPATCH precedentLinks( - [optional]VARIANT reserved); - [id(14)] LPDISPATCH dependentLinks( - [optional]VARIANT reserved); - [id(15)] LPDISPATCH precedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(16)] LPDISPATCH dependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(19)] boolean isInputToComponent(); - [id(20)] boolean isInputToModel(); - [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); - [id(23)] VARIANT getMetadata(BSTR name); - - // inherited from IArray - [id(1002)] BSTR toStringEx(long index); - [id(1003)] void fromStringEx(BSTR value, long index); - [id(1004)] BSTR toStringAbsoluteEx(long index); - [id(1007)] long getLength( [optional] VARIANT dim); - [id(1008)] void setLength(long length, [optional] VARIANT dim); - [id(1009)] void setDimensions( long d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - - // our methods - [id(2001), propget] BSTR value(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(2001), propput] void value(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10, - BSTR newValue); - [id(2004)] BSTR getFileExtension(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(2005)] void setFileExtension(BSTR value, VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(2006), propget] BSTR fileExtension(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(2006), propput] void fileExtension(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10, - BSTR newValue); - [id(2007)] void toFile(BSTR fileName, VARIANT encoding, VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(2008)] void fromFile(BSTR fileName, VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(2011)] void toFileAbsolute(BSTR fileName, VARIANT encoding, VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - - - }; - - // -------------------------------------------------------------- IFileVariable - [ uuid(A79BA2F2-C8C2-11d5-A008-0010A4C22C0F), - helpstring("File variable") ] - dispinterface IFileVariable - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // inherited from IVariable - [id(17)] boolean hasChanged; - [id(18)] boolean hide; - [id(22)] LPDISPATCH OwningComponent; - - // our properties - [id(1001)] BSTR value; - [id(1002)] boolean isBinary; - [id(1003)] BSTR fileExtension; - [id(1010)] BSTR description; - [id(1011)] boolean saveWithModel; - [id(1012)] boolean directTransfer; - - methods: - // inherited from IVariable - [id(1)] boolean isValid(); - [id(2)] void validate(); - [id(3)] BSTR getName(); - [id(4)] BSTR getFullName(); - [id(5)] BSTR getType(); - [id(6)] boolean isInput(); - [id(7)] BSTR toString(); - [id(8)] void fromString(BSTR value); - [id(9)] BSTR toStringAbsolute(); - [id(10)] void invalidate(); - [id(11)] LPDISPATCH directPrecedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(12)] LPDISPATCH directDependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(13)] LPDISPATCH precedentLinks( - [optional]VARIANT reserved); - [id(14)] LPDISPATCH dependentLinks( - [optional]VARIANT reserved); - [id(15)] LPDISPATCH precedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(16)] LPDISPATCH dependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(19)] boolean isInputToComponent(); - [id(20)] boolean isInputToModel(); - [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); - [id(23)] VARIANT getMetadata(BSTR name); - - // our methods - [id(1004)] void toFile(BSTR fileName, [optional] VARIANT encoding); - [id(1005)] void fromFile(BSTR fileName); - [id(1006)] void writeFile(BSTR fileName); - [id(1007)] void readFile(BSTR fileName); - [id(1008)] void toFileAbsolute(BSTR fileName, [optional] VARIANT encoding); - [id(1009)] void writeFileAbsolute(BSTR fileName); - }; - - // -------------------------------------------------------------- IGeometryVariable - [ uuid(E45A67F4-C367-11D2-A4E8-00A024B5452E), - helpstring("Geometry variable") ] - dispinterface IGeometryVariable - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // inherited from IVariable - [id(17)] boolean hasChanged; - [id(18)] boolean hide; - [id(22)] LPDISPATCH OwningComponent; - - // our properties - [id(1001)] BSTR value; - [id(1002)] BSTR description; - - methods: - // inherited from IVariable - [id(1)] boolean isValid(); - [id(2)] void validate(); - [id(3)] BSTR getName(); - [id(4)] BSTR getFullName(); - [id(5)] BSTR getType(); - [id(6)] boolean isInput(); - [id(7)] BSTR toString(); - [id(8)] void fromString(BSTR value); - [id(9)] BSTR toStringAbsolute(); - [id(10)] void invalidate(); - [id(11)] LPDISPATCH directPrecedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(12)] LPDISPATCH directDependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(13)] LPDISPATCH precedentLinks( - [optional]VARIANT reserved); - [id(14)] LPDISPATCH dependentLinks( - [optional]VARIANT reserved); - [id(15)] LPDISPATCH precedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(16)] LPDISPATCH dependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(19)] boolean isInputToComponent(); - [id(20)] boolean isInputToModel(); - [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); - [id(23)] VARIANT getMetadata(BSTR name); - - // our methods - [id(1003)] void setInitialValue(BSTR value); - }; - - // -------------------------------------------------------------- IGroup - [ uuid(0D132C39-CA70-11D5-A008-0010A4C22C0F), - helpstring("Group") ] - dispinterface IGroup - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - [id(1)] VARIANT Variables; - [id(2)] VARIANT Groups; - [id(5)] int iconID; - - methods: - [id(3)] BSTR getName(); - [id(4)] BSTR getFullName(); - }; - - // -------------------------------------------------------------- IGroups - [ uuid(0D132C3F-CA70-11D5-A008-0010A4C22C0F), - helpstring("Groups object") ] - dispinterface IGroups - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - [id(1)] VARIANT Count; - - methods: - [id(2)] VARIANT Item(VARIANT id); - }; - - // -------------------------------------------------------------- IIntegerArray - [ uuid(6CBF1A44-679A-11D3-A518-00A024B5452E), - helpstring("Integer variable array") ] - dispinterface IIntegerArray - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // inherited from IVariable - [id(17)] boolean hasChanged; - [id(18)] boolean hide; - [id(22)] LPDISPATCH OwningComponent; - - // inherited from IArray - [id(1001)] long size; - [id(1006)] long numDimensions; - - // our properties - [id(2002)] long lowerBound; - [id(2003)] long upperBound; - [id(2004)] BSTR description; - [id(2005)] BSTR units; - [id(2006)] BSTR enumAliases; - [id(2007)] BSTR enumValues; - [id(2014)] BSTR format; - - methods: - // inherited from IVariable - [id(1)] boolean isValid(); - [id(2)] void validate(); - [id(3)] BSTR getName(); - [id(4)] BSTR getFullName(); - [id(5)] BSTR getType(); - [id(6)] boolean isInput(); - [id(7)] BSTR toString(); - [id(8)] void fromString(BSTR value); - [id(9)] BSTR toStringAbsolute(); - [id(10)] void invalidate(); - [id(11)] LPDISPATCH directPrecedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(12)] LPDISPATCH directDependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(13)] LPDISPATCH precedentLinks( - [optional]VARIANT reserved); - [id(14)] LPDISPATCH dependentLinks( - [optional]VARIANT reserved); - [id(15)] LPDISPATCH precedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(16)] LPDISPATCH dependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(19)] boolean isInputToComponent(); - [id(20)] boolean isInputToModel(); - [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); - [id(23)] VARIANT getMetadata(BSTR name); - - // inherited from IArray - [id(1002)] BSTR toStringEx(long index); - [id(1003)] void fromStringEx(BSTR value, long index); - [id(1004)] BSTR toStringAbsoluteEx(long index); - [id(1007)] long getLength( [optional] VARIANT dim); - [id(1008)] void setLength(long length, [optional] VARIANT dim); - [id(1009)] void setDimensions( long d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - - // our methods - [id(2001), propget] long value(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(2001), propput] void value(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10, - long newValue); - [id(2008)] boolean hasLowerBound(); - [id(2009)] boolean hasUpperBound(); - [id(2010)] long getValue(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(2011)] void setValue(long value, VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(2012)] VARIANT getArray(); - [id(2013)] void setArray( VARIANT array ); - [id(2015)] BSTR toFormattedStringEx(long index); - [id(2016)] void fromFormattedStringEx(BSTR value, long index); - [id(2017)] BSTR toFormattedStringAbsoluteEx(long index); - [id(2018)] void clearUpperBound(); - [id(2019)] void clearLowerBound(); - [id(2020)] long getValueAbsolute(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - }; - - // -------------------------------------------------------------- IIntegerVariable - [ uuid(985910ED-C34D-11D2-A4E8-00A024B5452E), - helpstring("Integer variable") ] - dispinterface IIntegerVariable - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // inherited from IVariable - [id(17)] boolean hasChanged; - [id(18)] boolean hide; - [id(22)] LPDISPATCH OwningComponent; - - // our properties - [id(1001)] long value; - [id(1017)] long valueAbsolute; - [id(1002)] long lowerBound; - [id(1003)] long upperBound; - [id(1004)] BSTR units; - [id(1005)] BSTR description; - [id(1006)] BSTR enumValues; - [id(1007)] BSTR enumAliases; - [id(1011)] BSTR format; - - methods: - // inherited from IVariable - [id(1)] boolean isValid(); - [id(2)] void validate(); - [id(3)] BSTR getName(); - [id(4)] BSTR getFullName(); - [id(5)] BSTR getType(); - [id(6)] boolean isInput(); - [id(7)] BSTR toString(); - [id(8)] void fromString(BSTR value); - [id(9)] BSTR toStringAbsolute(); - [id(10)] void invalidate(); - [id(11)] LPDISPATCH directPrecedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(12)] LPDISPATCH directDependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(13)] LPDISPATCH precedentLinks( - [optional]VARIANT reserved); - [id(14)] LPDISPATCH dependentLinks( - [optional]VARIANT reserved); - [id(15)] LPDISPATCH precedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(16)] LPDISPATCH dependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(19)] boolean isInputToComponent(); - [id(20)] boolean isInputToModel(); - [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); - [id(23)] VARIANT getMetadata(BSTR name); - - // our methods - [id(1008)] void setInitialValue(long value); - [id(1009)] boolean hasLowerBound(); - [id(1010)] boolean hasUpperBound(); - [id(1012)] BSTR toFormattedString(); - [id(1013)] void fromFormattedString(BSTR value); - [id(1014)] BSTR toFormattedStringAbsolute(); - [id(1015)] void clearUpperBound(); - [id(1016)] void clearLowerBound(); - }; - - // -------------------------------------------------------------- IJobManager - [ uuid(0C0D84B7-8376-4A71-AD4F-862AAD1BCE51), - helpstring("Job Manager object") ] - dispinterface IJobManager - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // properties go here - - [id(28)] boolean wasHalted; - - methods: - [id(1)] void addInput( BSTR name, BSTR label ); - [id(2)] void setInput( long run, BSTR name, BSTR value ); - [id(3)] void addOutput( BSTR name, BSTR label ); - [id(4)] boolean getValidateAll(); - [id(5)] void setValidateAll( boolean flag ); - [id(6)] long getNumRuns(); - [id(7)] void setNumRuns( long numRuns ); - [id(8)] void submit( IDispatch* dataCollector, [optional]VARIANT description, [optional]VARIANT fireAndForget); - [id(9)] void waitForJobCompletion(); - [id(10)] void addRerun( long run ); - [id(11)] void halt( boolean halt ); - [id(12)] long getNumInputs(); - [id(13)] long getNumOutputs(); - [id(14)] BSTR getInput( long index ); - [id(15)] BSTR getOutput( long index ); - [id(16)] BSTR getInputLabel( long index ); - [id(17)] BSTR getOutputLabel( long index ); - [id(18)] long getNumThreads(); - [id(19)] boolean getRunInParallel(); - [id(20)] void setNumThreads(long numThreads); - [id(21)] void setRunInParallel(boolean runInParallel); - [id(22)] boolean enableCache(boolean enable); - [id(23)] void clearCache(); - [id(24)] long getRunIndex(VARIANT names, VARIANT values); - - [id(27)] void resume(IDispatch* dataHistory); - - - [id(29)] void setCustomMetadata(BSTR name, BSTR key, BSTR value); - - }; - - // -------------------------------------------------------------- IModelCenter - - typedef enum { - ASSEMBLY_STYLE_COLLAPSED = 0, - ASSEMBLY_STYLE_EXPANDED = 1, - ASSEMBLY_STYLE_CLASSIC = 100, - ASSEMBLY_STYLE_N_SQUARED = 101, - ASSEMBLY_STYLE_AUTO_N_SQUARED = 102, - ASSEMBLY_STYLE_FORCE_32_BITS = 65536 - } AssemblyStyle; - - [ uuid(BAACE1AA-EFDC-11D1-A4AD-00A024B5452E), - helpstring("ModelCenter main object") ] - dispinterface IModelCenter //NRS: This is IID_IPHXCOMClient in the code - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - [id(15)] BSTR modelDirectory; - [id(18)] boolean screenUpdating; - [id(25)] BSTR modelFileName; - [id(65)] BSTR appName; - [id(72)] BSTR appFullPath; - [id(82)] BOOL IsInteractive; - [id(102)] unsigned long ProcessID; - - methods: - [id(1)] BSTR getLastErrorMessage(); - [id(2)] void loadFile(BSTR fileName, [optional]VARIANT onConnectError); - [id(3)] void setValue(BSTR varName, BSTR value); - [id(4)] VARIANT getValue(BSTR varName); - [id(5)] void createComponent(BSTR serverPath, BSTR name, BSTR parent, [optional]VARIANT xPos, [optional]VARIANT yPos); - [id(6)] void createLink(BSTR variable, BSTR equation); - [id(7)] void newModel([optional]VARIANT modelType); - [id(8)] void saveModel(); - [id(9)] void saveModelAs(BSTR fileName); - [id(10)] void closeModel(); - [id(11)] void loadModel(BSTR fileName, [optional]VARIANT onConnectError); - [id(12)] IDispatch* getVariable(BSTR name); - [id(13)] IDispatch* getComponent(BSTR name); - [id(14)] void exit(); - [id(16)] IDispatch* createDataCollector(BSTR tradeStudyType, BSTR setup); - [id(17)] void tradeStudyEnd(); - [id(19)] IDispatch* createJobManager([optional]VARIANT showProgressDialog); - [id(20)] void tradeStudyStart(); - [id(21)] boolean getHaltStatus(); - [id(22)] IDispatch* getModel(); - [id(23)] void MessageBox(BSTR msg,[optional]VARIANT force); - [id(24)] VARIANT getValueAbsolute(BSTR varName); - [id(26)] void setScheduler(BSTR scheduler); - [id(27)] void removeComponent(BSTR name); - [id(28)] void breakLink(BSTR variable); - [id(29)] long getHWND(); - [id(30)] IDispatch* checkout(BSTR feature); - [id(40)] IDispatch* checkout2(BSTR feature, BSTR productRelease); - [id(31)] VARIANT runMacro(BSTR macro, [optional]VARIANT useMCObject); - [id(32)] IDispatch* createAssembly(BSTR name, BSTR parent, [optional]VARIANT assemblyType); - [id(33)] IDispatch* createAssemblyVariable(BSTR name, BSTR type, BSTR parent); - [id(34), propget] long version(long index); - [id(35)] void autoLink(BSTR srcComp, BSTR destComp); - [id(36)] LPDISPATCH getLinks([optional]VARIANT reserved); - [id(37)] BSTR getModelUUID(); - [id(38)] IDispatch* getFormatter(BSTR format); - [id(39)] void invokeHelp( long pageID ); - [id(41)] void launchTradeStudy(BSTR type, [optional]VARIANT setup); - [id(42)] long createPlugInFrame(BSTR name, BSTR title, BSTR reserved, LPDISPATCH plugIn, [optional]VARIANT showFavorites, [optional]VARIANT defaultHeight, [optional]VARIANT defaultWidth); - [id(43)] void setAlternateParentFrame(long hwnd); - [id(44)] void displayAboutBox(); - [id(45)] void halt(); - [id(46)] void displayPreferencesDialog(); - [id(47)] void run(BSTR variableArray); - [id(48)] IDispatch* getDataMonitor(BSTR component, VARIANT index); - [id(49)] IDispatch* createDataMonitor(BSTR component, BSTR name, int x, int y); - [id(50)] boolean isOkToClose(); - [id(51)] short addIcon(BSTR iconFile); - [id(52)] boolean removeDataMonitor(BSTR component, VARIANT index); - [id(53)] void destroyPlugInFrame(long hwnd); - [id(54)] void showPlugInFrame(long hwnd); - [id(55)] void hidePlugInFrame(long hwnd); - [id(56)] void setIconPlugInFrame(long hwnd, BSTR iconFile); - [id(57)] void setUserName(BSTR userName); - [id(58)] void setPassword(BSTR password); - [id(59)] long launchHTMLViewer(BSTR url, boolean popup); - [id(60)] void runAntFile(BSTR fileName); - [id(61)] IDispatch* getGlobalParameters(); - [id(62)] boolean closeHTMLViewer(long hwnd); - [id(63)] void HTMLViewerWaitForClose(long hwnd); - [id(64)] long HTMLViewerGetMyHWND(); - [id(66)] IDispatch* getActiveJobManager(); - [id(67)] VARIANT getPreference(BSTR pref); - [id(68)] void internalLicensing(BSTR,long); - [id(69)] BSTR getModelCenterPath(); - [id(70)] void transformAVPoint(int x, int y, boolean screen, VARIANT* tx, VARIANT* ty); - [id(71)] IDispatch* getDataExplorer(int index); - [id(73)] IDispatch* getDataCollector(int index); - [id(74)] IDispatch* parallelInstance(); - [id(75)] IDispatch* getLogger(); - [id(76)] IDispatch* unAssociatedInstance(); - [id(77)] long createPlugInFrame2(BSTR name, BSTR title, BSTR reserved, LPDISPATCH plugIn, [optional]VARIANT showFavorites, [optional]VARIANT defaultHeight, [optional]VARIANT defaultWidth, [optional]VARIANT minimumHeight, [optional]VARIANT minimumWidth); - [id(78)] void configureLogging(boolean enableLogging); - [id(79)] void moveComponent(BSTR component, BSTR parent, [optional]VARIANT index); - [id(80)] void setXMLExtension(BSTR xml); - [id(81)] BSTR getXMLExtension(BSTR nodeName, BSTR attributeName, BSTR attributeValue); - [id(83)] void setAssemblyStyle(BSTR assemblyName, AssemblyStyle style, [optional]VARIANT width, [optional]VARIANT height); - [id(84)] AssemblyStyle getAssemblyStyle(BSTR assemblyName, int *width, int *height); - [id(85)] IDispatch* getAssembly(BSTR name); - [id(86)] IDispatch* createAndInitComponent(BSTR serverPath, BSTR name, BSTR parent, BSTR initString, [optional]VARIANT xPos, [optional]VARIANT yPos); - [id(87)] BSTR getLicensingPath(); - - [id(89)] BSTR getMacroScript(BSTR macroName); - [id(90)] void setMacroScript(BSTR macroName, BSTR script); - [id(91)] BSTR getMacroScriptLanguage(BSTR macroName); - [id(92)] void setMacroScriptLanguage(BSTR macroName, BSTR language); - [id(93)] void addNewMacro(BSTR macroName, boolean isAppMacro); - [id(94)] void launchMacroEditor(BSTR macroName); - [id(95)] void startGUIMode([optional]VARIANT showDialogs); - [id(96)] long getNumUnitCategories(); - [id(97)] BSTR getUnitCategoryName(long index); - [id(98)] long getNumUnits(BSTR category); - [id(99)] BSTR getUnitName(BSTR category, long index); - [id(100)] IDispatch* createTradeStudy(BSTR type, [optional]VARIANT setup); - - [id(101)] void setPreference(BSTR pref, BSTR value); - - [id(103)] IDispatch* getNetworkLocations(); - [id(104)] void saveVersionedModel(VersionStatus versionStatus, BSTR checkinMessage); - [id(105)] void saveVersionedModelAs(BSTR fileName, VersionStatus versionStatus, BSTR checkinMessage); - - [id(106)] LPDISPATCH getVariableMetaData(BSTR name); - - [id(107)] void dumpComDebug(); - - [id(108)] BSTR showFileBrowseDialog(BSTR title, [optional]VARIANT filters, [optional]VARIANT initialUri, [optional]VARIANT hwnd); - - [id(115)] BSTR showFileSaveDialog(BSTR title, int *selectedFilter, [optional]VARIANT initialFilename, [optional]VARIANT filters, [optional]VARIANT initialUri, [optional]VARIANT hwnd); - - [id(109)] void setLoginCallback(IDispatch* callback); - - [id(110)] IDispatch* createDataHistoryVariable(); - - [id(111)] boolean getRunOnlyMode(); - - [id(112)] void setRunOnlyMode(boolean shouldBeInRunOnly); - - [id(113)] IDispatch* createDataExplorer(BSTR tradeStudyType, BSTR setup); - - [id(114)] IDispatch* getFileSystemInfo(BSTR url); - - [id(116)] SAFEARRAY(BSTR) getTradeStudyFilters(); - - [id(117)] void saveTradeStudy(BSTR uri, int format, LPDISPATCH dataExplorer); - - [id(118)] IDispatch* getDataCollectorForDataExplorer(LPDISPATCH dataExplorer); - - [id(119)] void launchDataCollectorPlugIn(BSTR plugInName, LPDISPATCH dataExplorer); - - [id(120)] boolean guiLoadFile(BSTR fileName); - - [id(121)] void guiSaveModel(); - - [id(122)] double getMacroTimeout(BSTR macroName); - - [id(123)] void setMacroTimeout(BSTR macroName, double timeout); - - [id(124)] boolean guiCloseAllMultiplexers(); - - // NOTE: When adding new methods, do NOT reuse the numbers below for non-STK builds. The IDs must be unique in all - // build configurations. Hopefully, 350 is sufficient padding that this will never have a collision. -#ifndef DOXYGEN_SHOULD_SKIP_THIS -#ifdef STKOEM - - [id(350)] long createSTKTree(); - - [id(351)] void destroySTKTree(long hwnd); - -#endif // STKOEM -#endif // DOXYGEN_SHOULD_SKIP_THIS - }; - - [ uuid(3C596B3E-0B8A-4B07-87D5-E9C165F858FB), - helpstring("Dispatch interface for ILoginCallback") ] - dispinterface ILoginCallback - { - properties: - methods: - [id(1)] boolean requestAuthCredentials(BSTR uri, boolean isFailedAttempt, VARIANT* username, VARIANT* password, VARIANT* savePassword); - - [id(2)] void loginSucceeded(BSTR uri, BSTR username, BSTR password, boolean savePassword); - - [id(3)] boolean verifySslWarning(BSTR msg); - }; - - [ uuid(F2C901DF-0E2D-4715-9DE9-E69206ADF0C0), - helpstring("Trade Study Run events") ] - dispinterface ITradeStudyEvents - { - properties: - methods: - [id(1)] void StartToolRun(); - [id(2)] void EndToolRun(); - [id(3)] void ToolClosed(BSTR type); - - [id(4)] void ModelXMLExtensionsChanged(); - } - - [ uuid(F154331D-C65C-41A6-84D5-7BB9A065279D), - helpstring("Show Help events")] - dispinterface IShowHelpEvents - { - properties: - methods: - [id(1)] void ShowHelp(long context); - } - -#ifndef DOXYGEN_SHOULD_SKIP_THIS - -// Change STKAnalyzer Library GUID, CLSID, and progId for every release no matter major or minor releases, to support -// Independency from different releases. This value is unique for each release and must match the LIBID_PHXModelCenter -// value in ModelCenter.cpp and ModelCenterTypeLibrary/dummy.cpp. Also update PHXComClient.h/cpp -#if defined(STKOEM) - - [uuid(5fD16F36-7345-41F2-A95E-1EF9FAEF5D60)] - coclass STK1200Application - { - [default] dispinterface IModelCenter; - [default, source] dispinterface ITradeStudyEvents; - [source] dispinterface IShowHelpEvents; - }; - -#elif defined(NODERUNNER) - - [ uuid(BAACE1AB-EFDC-11D1-A4AD-00A024B54530) ] - coclass Application - { - [default] dispinterface IModelCenter; - [default, source] dispinterface ITradeStudyEvents; - }; - -#else - - [ uuid(BAACE1AB-EFDC-11D1-A4AD-00A024B5452E) ] - coclass Application - { - [default] dispinterface IModelCenter; - [default, source] dispinterface ITradeStudyEvents; -[source] dispinterface IShowHelpEvents; - }; - -#endif -#endif - - typedef enum - { - CONN_ERR_ERROR = 3, - CONN_ERR_IGNORE = 1, - CONN_ERR_USEDIALOG = -1 - } OnConnectionErrorMode; - - // --------------------------------------------------------------- INetworkLocations - [ uuid(F036F767-ACF7-4128-823F-74E8B7E53EE9), - helpstring("Network Locations") ] - dispinterface INetworkLocations - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - - methods: - [id(1)] void add(BSTR address, BSTR username, BSTR password); - - [id(2)] boolean exists(BSTR address); - - [id(3)] void removeAddress(BSTR address); - }; - - // -------------------------------------------------------------- IRefArrayProp - [ uuid(5BFF8381-7802-11D3-A524-00A024B5452E), - helpstring("Reference variable array") ] - dispinterface IRefArrayProp - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - [id(1)] BSTR enumValues; - [id(2)] boolean isInput; - [id(3)] BSTR title; - [id(4)] BSTR description; - - methods: - [id(5)] BSTR getName(); - [id(6)] BSTR getType(); - }; - - // -------------------------------------------------------------- IReferenceArray - [ uuid(492AB501-6AA8-11D3-A519-00A024B5452E), - helpstring("Reference variable array") ] - dispinterface IReferenceArray - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // inherited from IVariable - [id(17)] boolean hasChanged; - [id(18)] boolean hide; - [id(22)] LPDISPATCH OwningComponent; - - // inherited from IArray - [id(1001)] long size; - [id(1006)] long numDimensions; - - // our properties - [id(2003)] boolean autoGrow; - - methods: - // inherited from IVariable - [id(1)] boolean isValid(); - [id(2)] void validate(); - [id(3)] BSTR getName(); - [id(4)] BSTR getFullName(); - [id(5)] BSTR getType(); - [id(6)] boolean isInput(); - [id(7)] BSTR toString(); - [id(8)] void fromString(BSTR value); - [id(9)] BSTR toStringAbsolute(); - [id(10)] void invalidate(); - [id(11)] LPDISPATCH directPrecedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(12)] LPDISPATCH directDependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(13)] LPDISPATCH precedentLinks( - [optional]VARIANT reserved); - [id(14)] LPDISPATCH dependentLinks( - [optional]VARIANT reserved); - [id(15)] LPDISPATCH precedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(16)] LPDISPATCH dependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(19)] boolean isInputToComponent(); - [id(20)] boolean isInputToModel(); - [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); - [id(23)] VARIANT getMetadata(BSTR name); - - // inherited from IArray - [id(1002)] BSTR toStringEx(long index); - [id(1003)] void fromStringEx(BSTR value, long index); - [id(1004)] BSTR toStringAbsoluteEx(long index); - [id(1007)] long getLength( [optional] VARIANT dim); - [id(1008)] void setLength(long length, [optional] VARIANT dim); - [id(1009)] void setDimensions( long d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - - // our methods - [id(2001), propget] double value(long index); - [id(2001), propput] void value(long index, double newValue); - [id(2002), propget] BSTR reference(long index); - [id(2002), propput] void reference(long index, BSTR newValue); - [id(2004)] double getValue(int index); - [id(2005)] double setValue(double value, int index); - [id(2008)] IDispatch* createRefProp(BSTR name, BSTR type); - [id(2009)] VARIANT getRefPropValue( BSTR name, int index ); - [id(2010)] void setRefPropValue( BSTR name, int index, BSTR value ); - [id(2011)] VARIANT getRefPropValueAbsolute( BSTR name, int index ); - [id(2012), propget] VARIANT referencedVariables(long index); - [id(2013), propget] VARIANT referencedVariable(long index); - [id(2014)] double getValueAbsolute(int index); - - }; - - // -------------------------------------------------------------- IReferenceVariable - [ uuid(4864FF03-3DE9-11D3-A50E-00A024B5452E), - helpstring("Reference variable") ] - dispinterface IReferenceVariable - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // inherited from IVariable - [id(17)] boolean hasChanged; - [id(18)] boolean hide; - [id(22)] LPDISPATCH OwningComponent; - - // our properties - [id(1001)] double value; - [id(1002)] BSTR reference; - [id(1009)] VARIANT referencedVariables; - [id(1010)] VARIANT referencedVariable; - - methods: - // inherited from IVariable - [id(1)] boolean isValid(); - [id(2)] void validate(); - [id(3)] BSTR getName(); - [id(4)] BSTR getFullName(); - [id(5)] BSTR getType(); - [id(6)] boolean isInput(); - [id(7)] BSTR toString(); - [id(8)] void fromString(BSTR value); - [id(9)] BSTR toStringAbsolute(); - [id(10)] void invalidate(); - [id(11)] LPDISPATCH directPrecedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(12)] LPDISPATCH directDependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(13)] LPDISPATCH precedentLinks( - [optional]VARIANT reserved); - [id(14)] LPDISPATCH dependentLinks( - [optional]VARIANT reserved); - [id(15)] LPDISPATCH precedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(16)] LPDISPATCH dependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(19)] boolean isInputToComponent(); - [id(20)] boolean isInputToModel(); - [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); - [id(23)] VARIANT getMetadata(BSTR name); - - // our methods - [id(1005)] IDispatch* createRefProp( BSTR name, BSTR type ); - [id(1006)] VARIANT getRefPropValue( BSTR name ); - [id(1007)] void setRefPropValue( BSTR name, BSTR value ); - [id(1008)] VARIANT getRefPropValueAbsolute( BSTR name ); - }; - - // -------------------------------------------------------------- IRefProp - [ uuid(D3F8D5D4-7769-11D3-A522-00A024B5452E), - helpstring("Reference property") ] - dispinterface IRefProp - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - [id(1)] BSTR enumValues; - [id(2)] boolean isInput; - [id(3)] BSTR title; - [id(4)] BSTR description; - - methods: - [id(5)] BSTR getName(); - [id(6)] BSTR getType(); - }; - - // -------------------------------------------------------------- IStringArray - [ uuid(6CBF1A4C-679A-11D3-A518-00A024B5452E), - helpstring("String variable array") ] - dispinterface IStringArray - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // inherited from IVariable - [id(17)] boolean hasChanged; - [id(18)] boolean hide; - [id(22)] LPDISPATCH OwningComponent; - - // inherited from IArray - [id(1001)] long size; - [id(1006)] long numDimensions; - - // our properties - [id(2002)] BSTR description; - [id(2003)] BSTR enumAliases; - [id(2004)] BSTR enumValues; - - methods: - // inherited from IVariable - [id(1)] boolean isValid(); - [id(2)] void validate(); - [id(3)] BSTR getName(); - [id(4)] BSTR getFullName(); - [id(5)] BSTR getType(); - [id(6)] boolean isInput(); - [id(7)] BSTR toString(); - [id(8)] void fromString(BSTR value); - [id(9)] BSTR toStringAbsolute(); - [id(10)] void invalidate(); - [id(11)] LPDISPATCH directPrecedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(12)] LPDISPATCH directDependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(13)] LPDISPATCH precedentLinks( - [optional]VARIANT reserved); - [id(14)] LPDISPATCH dependentLinks( - [optional]VARIANT reserved); - [id(15)] LPDISPATCH precedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(16)] LPDISPATCH dependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(19)] boolean isInputToComponent(); - [id(20)] boolean isInputToModel(); - [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); - [id(23)] VARIANT getMetadata(BSTR name); - - // inherited from IArray - [id(1002)] BSTR toStringEx(long index); - [id(1003)] void fromStringEx(BSTR value, long index); - [id(1004)] BSTR toStringAbsoluteEx(long index); - [id(1007)] long getLength( [optional] VARIANT dim); - [id(1008)] void setLength(long length, [optional] VARIANT dim); - [id(1009)] void setDimensions( long d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - - // our methods - [id(2001), propget] BSTR value(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(2001), propput] void value(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10, - BSTR newValue); - [id(2005)] BSTR getValue(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(2006)] void setValue(BSTR value, VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - [id(2007)] VARIANT getArray(); - [id(2008)] void setArray( VARIANT array ); - [id(2009)] BSTR getValueAbsolute(VARIANT d1, [optional] VARIANT d2, - [optional] VARIANT d3, [optional] VARIANT d4, - [optional] VARIANT d5, [optional] VARIANT d6, - [optional] VARIANT d7, [optional] VARIANT d8, - [optional] VARIANT d9, [optional] VARIANT d10); - }; - - // -------------------------------------------------------------- IStringVariable - [ uuid(985910E3-C34D-11D2-A4E8-00A024B5452E), - helpstring("String variable") ] - dispinterface IStringVariable - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // inherited from IVariable - [id(17)] boolean hasChanged; - [id(18)] boolean hide; - [id(22)] LPDISPATCH OwningComponent; - - // our properties - [id(1001)] BSTR value; - [id(1006)] BSTR valueAbsolute; - [id(1002)] BSTR description; - [id(1003)] BSTR enumValues; - [id(1004)] BSTR enumAliases; - - methods: - // inherited from IVariable - [id(1)] boolean isValid(); - [id(2)] void validate(); - [id(3)] BSTR getName(); - [id(4)] BSTR getFullName(); - [id(5)] BSTR getType(); - [id(6)] boolean isInput(); - [id(7)] BSTR toString(); - [id(8)] void fromString(BSTR value); - [id(9)] BSTR toStringAbsolute(); - [id(10)] void invalidate(); - [id(11)] LPDISPATCH directPrecedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(12)] LPDISPATCH directDependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(13)] LPDISPATCH precedentLinks( - [optional]VARIANT reserved); - [id(14)] LPDISPATCH dependentLinks( - [optional]VARIANT reserved); - [id(15)] LPDISPATCH precedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(16)] LPDISPATCH dependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(19)] boolean isInputToComponent(); - [id(20)] boolean isInputToModel(); - [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); - [id(23)] VARIANT getMetadata(BSTR name); - - // our methods - [id(1005)] void setInitialValue(BSTR value); - }; - - // -------------------------------------------------------------- IVariable - [ uuid(A0E042F1-B480-11D2-A4E6-00A024B5452E), - helpstring("Variable base class") ] - dispinterface IVariable - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - [id(17)] boolean hasChanged; - [id(18)] boolean hide; - [id(22)] LPDISPATCH OwningComponent; - - methods: - [id(1)] boolean isValid(); - [id(2)] void validate(); - [id(3)] BSTR getName(); - [id(4)] BSTR getFullName(); - [id(5)] BSTR getType(); - [id(6)] boolean isInput(); - [id(7)] BSTR toString(); - [id(8)] void fromString(BSTR value); - [id(9)] BSTR toStringAbsolute(); - [id(10)] void invalidate(); - [id(11)] LPDISPATCH directPrecedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(12)] LPDISPATCH directDependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(13)] LPDISPATCH precedentLinks( - [optional]VARIANT reserved); - [id(14)] LPDISPATCH dependentLinks( - [optional]VARIANT reserved); - [id(15)] LPDISPATCH precedents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(16)] LPDISPATCH dependents( - [optional]VARIANT followSuspended, - [optional]VARIANT reserved); - [id(19)] boolean isInputToComponent(); - [id(20)] boolean isInputToModel(); - [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); - [id(23)] VARIANT getMetadata(BSTR name); - }; - - - // -------------------------------------------------------------- IVariableDescription - [ uuid(EAE610F5-CC85-11D5-A008-0010A4C22C0F), - helpstring("Variable description") ] - dispinterface IVariableDescription - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - [id(1)] BSTR name; - [id(2)] BSTR fullName; - [id(3)] short state; - [id(4)] BSTR units; - [id(5)] boolean isCustom; - [id(6)] BSTR equation; - [id(7)] BSTR type; - [id(8)] boolean isNumeric; - - methods: - }; - - // -------------------------------------------------------------- IVariableLink - [ uuid(0F11CB29-B367-40ED-8F26-BD4A54DACF2A), - helpstring("VariableLink object") ] - dispinterface IVariableLink - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - [id(1)] BSTR LHS; - [id(2)] BSTR RHS; - - methods: - [id(3)] void suspendLink(); - [id(4)] void resumeLink(); - [id(5)] void breakLink(); - }; - - // -------------------------------------------------------------- IVariableLinks - [ uuid(C5B28059-9C9F-4EA3-9AB1-B9EDE06C4152), - helpstring("VariableLinks collection") ] - dispinterface IVariableLinks - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - [id(1)] VARIANT Count; - - methods: - [id(2)] VARIANT Item(VARIANT id); - }; - - // -------------------------------------------------------------- IVariables - [ uuid(CC3F2432-D179-4018-835F-34173613824B), - helpstring("Variables object") ] - dispinterface IVariables - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - [id(1)] VARIANT Count; - - methods: - [id(2)] VARIANT Item(VARIANT id); - }; - - // -------------------------------------------------------------- IPHXFormat - [ uuid(F7E774F5-A4CA-41D0-8F48-CC6B45043FB4) ] - dispinterface IPHXFormat - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // NOTE - ClassWizard will maintain property information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_PROP(PHXCOMFormat) - //}}AFX_ODL_PROP - - methods: - // NOTE - ClassWizard will maintain method information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_METHOD(PHXCOMFormat) - [id(1)] void setFormat(BSTR format); - [id(2)] long stringToLong(BSTR str); - [id(3)] double stringToDouble(BSTR str); - [id(4)] BSTR longToString(long val); - [id(5)] BSTR doubleToString(double val); - [id(6)] BSTR getFormat(); - [id(7)] BSTR stringToString(BSTR str); - [id(8)] BSTR longToEditableString(long val); - [id(9)] BSTR doubleToEditableString(double val); - //}}AFX_ODL_METHOD - - }; - - // -------------------------------------------------------------- IDataMonitor - [ uuid(B4009E4E-5E90-4b44-8687-143051AA7400), - helpstring("Data Monitor object") ] - dispinterface IDataMonitor - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // properties go here - - methods: - [id(1)] BSTR getName( long row ); - [id(2)] void setName( long row, BSTR name ); - [id(3)] boolean isRenamed( long row ); - [id(4)] BSTR getLink ( long row ); - [id(5)] boolean setLink( long row, BSTR link ); - [id(6)] int addItem( BSTR name, BSTR link ); - [id(7)] int addUnlinkedItem( BSTR name ); - [id(8)] void removeItem( long row ); - [id(9)] void removeLink( long row ); - [id(10)] boolean getDisplayFullNames( ); - [id(11)] void setDisplayFullNames( boolean ); - [id(12)] boolean getAutoDelete( ); - [id(13)] void setAutoDelete( boolean ); - [id(14)] boolean getDisplayUnits( ); - [id(15)] void setDisplayUnits( boolean ); - [id(16)] int getColWidth( long col ); - [id(17)] void setColWidth( long col, int width ); - [id(18)] boolean isValid( ); - [id(19)] BSTR getTitle( ); - [id(20)] void setTitle( BSTR title ); - [id(21)] int getWidth( ); - [id(22)] int getHeight( ); - [id(23)] void setSize( int width, int height ); - [id(24)] int getX( ); - [id(25)] int getY( ); - [id(26)] void setLocation( int x, int y); - }; - - - // Primary dispatch interface for PHXComGlobalParameters - - [ uuid(CBBF5B6F-ED70-463D-B1E6-6DAE10500A4E) ] - dispinterface IGlobalParameters - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // NOTE - ClassWizard will maintain property information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_PROP(PHXComGlobalParameters) - [id(1)] long count; - //}}AFX_ODL_PROP - - methods: - // NOTE - ClassWizard will maintain method information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_METHOD(PHXComGlobalParameters) - [id(4), propget] VARIANT item(VARIANT index); - [id(4), propput] void item(VARIANT index, VARIANT newValue); - [id(0), propget] VARIANT _item(VARIANT index); - [id(0), propput] void _item(VARIANT index, VARIANT newValue); - [id(2)] void setExportToRemoteComponents(VARIANT index, boolean bexport); - [id(3)] void Remove(VARIANT index); - //}}AFX_ODL_METHOD - - }; - - // -------------------------------------------------------------- ILogger - [ uuid(B478A93F-8BAC-43c5-9C4C-BD4AF8C9BAC1), - helpstring("Logger") ] - dispinterface ILogger - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // properties go here - - methods: - [id(9)] boolean isTraceEnabled(); - [id(1)] boolean isDebugEnabled(); - [id(2)] boolean isInfoEnabled(); - [id(3)] boolean isWarnEnabled(); - [id(4)] boolean isErrorEnabled(); - [id(10)] void trace(BSTR message); - [id(5)] void debug(BSTR message); - [id(6)] void info(BSTR message); - [id(7)] void warn(BSTR message); - [id(8)] void error(BSTR message); - }; - - // -------------------------------------------------------------- ICachePin - [ uuid(631F5771-6F41-495F-BF88-55368128C415), - helpstring("CachePin") ] - dispinterface ICachePin - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // properties go here - - [id(1)] BSTR Url; - [id(2)] BSTR LocalPath; - [id(3)] boolean IsValid; - - methods: - [id(4)] boolean releasePin(); - [id(5)] void checkinOnFlush(BSTR message); - }; - - - //{{AFX_APPEND_ODL}} - - // -------------------------------------------------------------- IFileSystemInfo - [uuid(3E645325-85F9-456B-B5B7-395C90825986), - helpstring("FileSystemInfo") ] - dispinterface IFileSystemInfo - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - - [id(1)] boolean isValid; - - [id(2)] boolean exists; - - [id(3)] boolean isWritable; - - [id(4)] BSTR baseName; - - [id(5)] BSTR url; - - methods: - [id(6)] LPDISPATCH pin(boolean forWrite, [optional] VARIANT forceCopy); - }; - //{{AFX_APPEND_ODL}} - -#ifndef DOXYGEN_SHOULD_SKIP_THIS - // -------------------------------------------------------------- IVizContainer - [uuid(D57D1AA5-B852-4EB1-991E-7433AF3E0006), - helpstring("VizContainer") ] - - dispinterface IVizContainer - { - - properties: - [id(1)] boolean Visible; - - [id(2)] long HWnd; - - [id(3)] IDispatch* DataExplorerPlugIn; - - [id(6)] IDispatch* DataExplorer; - - methods: - - [id(4)] void hide(); - - [id(5)] void show(); - - [id(7)] void fileSaved(); - - [id(8)] void showAt(long top, long left, long width, long height, [optional] VARIANT state); - }; - -#endif - -}; - - -``` - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# File ModelCenter.odl + +![][IDL] + +**Location**: `ModelCenter/src/ModelCenter.odl` + + + + + +## Classes + +* [ModelCenter::IAddToModel](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel) +* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) +* [ModelCenter::IAssemblies](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies) +* [ModelCenter::IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) +* [ModelCenter::IBooleanArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray) +* [ModelCenter::IBooleanVariable](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable) +* [ModelCenter::IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) +* [ModelCenter::IComponents](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents) +* [ModelCenter::IIfComponent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent) +* [ModelCenter::IScriptComponent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent) +* [ModelCenter::ICustomDesignPoint](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint) +* [ModelCenter::IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) +* [ModelCenter::IDoubleArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray) +* [ModelCenter::IDoubleVariable](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable) +* [ModelCenter::IObjectVariable](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable) +* [ModelCenter::IFeature](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature) +* [ModelCenter::IFileArray](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray) +* [ModelCenter::IFileVariable](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable) +* [ModelCenter::IGeometryVariable](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable) +* [ModelCenter::IGroup](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup) +* [ModelCenter::IGroups](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups) +* [ModelCenter::IIntegerArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray) +* [ModelCenter::IIntegerVariable](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable) +* [ModelCenter::IJobManager](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager) +* [ModelCenter::IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) +* [ModelCenter::ILoginCallback](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback) +* [ModelCenter::ITradeStudyEvents](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents) +* [ModelCenter::IShowHelpEvents](interfaceModelCenter_1_1IShowHelpEvents.md#interfaceModelCenter_1_1IShowHelpEvents) +* [ModelCenter::Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) +* [ModelCenter::INetworkLocations](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations) +* [ModelCenter::IRefArrayProp](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp) +* [ModelCenter::IReferenceArray](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray) +* [ModelCenter::IReferenceVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable) +* [ModelCenter::IRefProp](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp) +* [ModelCenter::IStringArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray) +* [ModelCenter::IStringVariable](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable) +* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) +* [ModelCenter::IVariableDescription](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription) +* [ModelCenter::IVariableLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink) +* [ModelCenter::IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) +* [ModelCenter::IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) +* [ModelCenter::IPHXFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat) +* [ModelCenter::IDataMonitor](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor) +* [ModelCenter::IGlobalParameters](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters) +* [ModelCenter::ILogger](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger) +* [ModelCenter::ICachePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin) +* [ModelCenter::IFileSystemInfo](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo) +* [ModelCenter::IVizContainer](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer) + +## Namespaces + +* [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) + +## Source + +``` +// ModelCenter.odl : type library source for ModelCenter.exe + +// This file will be processed by the MIDL compiler to produce the type library (ModelCenter.tlb). + +// Change STKAnalyzer Library GUID, CLSID, and progId for every release no matter major or minor releases, to support +// Independency from different releases. This value is unique for each release and must match the LIBID_PHXModelCenter +// value in ModelCenter.cpp and ModelCenterTypeLibrary/dummy.cpp +#if defined(STKOEM) +[uuid(F7548BF3-FB88-43F0-BEC0-D199070AF13C), version(1.0), + helpstring("Phoenix Integration - STKAnalyzer") ] +#else +[ uuid(757DD9B4-E5E1-11d2-81A3-0060975E6478), version(1.0), + helpstring("Phoenix Integration - ModelCenter") ] +#endif +library ModelCenter +{ + importlib("stdole32.tlb"); + + // -------------------------------------------------------------- General Enumerations + + // DO NOT CHANGE THE NUMERIC CONSTANTS! + // (The Java API relies on them staying constant.) + + typedef enum + { + METADATA_TYPE_STRING = 0, + METADATA_TYPE_DOUBLE = 1, + METADATA_TYPE_LONG = 2, + METADATA_TYPE_BOOLEAN = 3, + METADATA_TYPE_XML = 4, + METADATA_TYPE_FORCE_TO_32_BITS = 65536 + } MetadataType; + + typedef enum + { + METADATA_ACCESS_PRIVATE = 0, + METADATA_ACCESS_READONLY = 1, + METADATA_ACCESS_PUBLIC = 2, + METADATA_ACCESS_FORCE_TO_32_BITS = 65536 + } MetadataAccess; + + typedef enum + { + TS_FORMAT_PXTZ = 0, + + TS_FORMAT_PXT_COMPRESSED = 1, + + TS_FORMAT_PXT_UNCOMPRESSED = 2, + + TS_FORMAT_TSTUDY = 3 + } TradeStudyFormat; + + // -------------------------------------------------------------- IAddToModel + [ uuid(6B3DCC47-6475-411C-977E-337F73A43771), + helpstring("AddToModel object") ] + dispinterface IAddToModel + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + [id(7)] boolean prevalidateInputs; + [id(8)] boolean autoRun; + + methods: + [id(1)] void addToModel(); + [id(2)] void updateComponent(); + [id(3)] IDispatch* getComponent(); + [id(4)] BSTR getRegID(); + [id(5)] IDispatch* addInput(BSTR name, BSTR type, [optional]VARIANT value); + [id(6)] IDispatch* addOutput(BSTR name, BSTR type, [optional]VARIANT value); + [id(9)] BSTR getProgID(); + [id(10)] void setAuthor(BSTR author); + [id(11)] void setDescription(BSTR description); + [id(12)] void setVersion(BSTR version); + [id(13)] void setHelpURL(BSTR helpURL); + [id(14)] void setKeywords(BSTR keywords); + [id(15)] void clearBusyFlag(); + [id(16)] boolean addToModel2(); + [id(17)] void setComponentRequirements(BSTR compReq); + [id(18)] void setIcon(BSTR iconFile); + [id(19)] void addMethod(BSTR name, [optional]VARIANT displayName); + [id(20)] IDispatch* addInput2(BSTR name, BSTR type, BSTR classURL, [optional]VARIANT value); + [id(21)] IDispatch* addOutput2(BSTR name, BSTR type, BSTR classURL, [optional]VARIANT value); + [id(22)] BSTR addToModel3(BSTR suggestedName); + }; + + // -------------------------------------------------------------- IArray + [ uuid(6CBF1A48-679A-11D3-A518-00A024B5452E), + helpstring("Array base class") ] + dispinterface IArray + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // inherited from IVariable + [id(17)] boolean hasChanged; + [id(18)] boolean hide; + [id(22)] LPDISPATCH OwningComponent; + + // our properties + [id(1001)] long size; + [id(1005)] boolean autoSize; + [id(1006)] long numDimensions; + [id(1010)] long length; + + methods: + // inherited from IVariable + [id(1)] boolean isValid(); + [id(2)] void validate(); + [id(3)] BSTR getName(); + [id(4)] BSTR getFullName(); + [id(5)] BSTR getType(); + [id(6)] boolean isInput(); + [id(7)] BSTR toString(); + [id(8)] void fromString(BSTR value); + [id(9)] BSTR toStringAbsolute(); + [id(10)] void invalidate(); + [id(11)] LPDISPATCH directPrecedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(12)] LPDISPATCH directDependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(13)] LPDISPATCH precedentLinks( + [optional]VARIANT reserved); + [id(14)] LPDISPATCH dependentLinks( + [optional]VARIANT reserved); + [id(15)] LPDISPATCH precedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(16)] LPDISPATCH dependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(19)] boolean isInputToComponent(); + [id(20)] boolean isInputToModel(); + [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); + [id(23)] VARIANT getMetadata(BSTR name); + + // our methods + + [id(1002)] BSTR toStringEx(long index); + [id(1003)] void fromStringEx(BSTR value, long index); + [id(1004)] BSTR toStringAbsoluteEx(long index); + [id(1007)] long getLength( [optional] VARIANT dim); + [id(1008)] void setLength(long length, [optional] VARIANT dim); + [id(1009)] void setDimensions( long d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(1011)] long getSize( [optional] VARIANT dim); + [id(1012)] void setSize(long length, [optional] VARIANT dim); + [id(1013)] VARIANT getDimensions(); + }; + + // -------------------------------------------------------------- IAssemblies + [ uuid(0D132C3C-CA70-11D5-A008-0010A4C22C0F), + helpstring("Assemblies object") ] + dispinterface IAssemblies + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + [id(1)] VARIANT Count; + + methods: + [id(2)] VARIANT Item(VARIANT id); + }; + + // -------------------------------------------------------------- IAssembly + typedef enum + { + DO_VERSIONING = 0, + DO_NOT_VERSION = 1, + DO_VERSIONING_IF_POSSIBLE = 2 + } VersionStatus; + + [ uuid(0D132C36-CA70-11D5-A008-0010A4C22C0F), + helpstring("Assembly") ] + dispinterface IAssembly + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + [id(1)] VARIANT Variables; + [id(2)] VARIANT Groups; + [id(3)] VARIANT Assemblies; + [id(4)] VARIANT Components; + [id(9)] int iconID; + [id(15)] int IndexInParent; + [id(16)] LPDISPATCH ParentAssembly; + [id(17)] BSTR AssemblyType; + + [id(18)] VARIANT userData; + + methods: + [id(5)] BSTR getName(); + [id(6)] BSTR getFullName(); + [id(7)] IDispatch* addAssembly(BSTR name, [optional]VARIANT assemblyType); + [id(8)] IDispatch* addVariable(BSTR name, BSTR type); + [id(10)] int getPositionX(); + [id(11)] int getPositionY(); + [id(12)] void rename(BSTR name); + [id(13)] void deleteVariable(BSTR name); + [id(14)] LPDISPATCH addAssembly2(BSTR name, VARIANT xPos, VARIANT yPos, [optional]VARIANT assemblyType); + [id(19)] void convertToSubmodel(BSTR fileName, VersionStatus versionStatus, BSTR checkinMessage); + [id(20)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); + [id(21)] VARIANT getMetadata(BSTR name); + }; + + // -------------------------------------------------------------- IBooleanArray + [ uuid(6CBF1A4F-679A-11D3-A518-00A024B5452E), + helpstring("Boolean variable array") ] + dispinterface IBooleanArray + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // inherited from IVariable + [id(17)] boolean hasChanged; + [id(18)] boolean hide; + [id(22)] LPDISPATCH OwningComponent; + + // inherited from IArray + [id(1001)] long size; + [id(1006)] long numDimensions; + + // our properties + [id(2002)] BSTR description; + + methods: + // inherited from IVariable + [id(1)] boolean isValid(); + [id(2)] void validate(); + [id(3)] BSTR getName(); + [id(4)] BSTR getFullName(); + [id(5)] BSTR getType(); + [id(6)] boolean isInput(); + [id(7)] BSTR toString(); + [id(8)] void fromString(BSTR value); + [id(9)] BSTR toStringAbsolute(); + [id(10)] void invalidate(); + [id(11)] LPDISPATCH directPrecedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(12)] LPDISPATCH directDependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(13)] LPDISPATCH precedentLinks( + [optional]VARIANT reserved); + [id(14)] LPDISPATCH dependentLinks( + [optional]VARIANT reserved); + [id(15)] LPDISPATCH precedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(16)] LPDISPATCH dependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(19)] boolean isInputToComponent(); + [id(20)] boolean isInputToModel(); + [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); + [id(23)] VARIANT getMetadata(BSTR name); + + // inherited from IArray + [id(1002)] BSTR toStringEx(long index); + [id(1003)] void fromStringEx(BSTR value, long index); + [id(1004)] BSTR toStringAbsoluteEx(long index); + [id(1007)] long getLength( [optional] VARIANT dim); + [id(1008)] void setLength(long length, [optional] VARIANT dim); + [id(1009)] void setDimensions( long d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + + // our methods + [id(2001), propget] boolean value(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(2001), propput] void value(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10, + BOOL newValue); + [id(2003)] boolean getValue(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(2004)] void setValue(BOOL value, VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(2005)] VARIANT getArray(); + [id(2006)] void setArray( VARIANT array ); + [id(2007)] boolean getValueAbsolute(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + }; + + // -------------------------------------------------------------- IBooleanVariable + [ uuid(985910EA-C34D-11D2-A4E8-00A024B5452E), + helpstring("Boolean variable") ] + dispinterface IBooleanVariable + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // inherited from IVariable + [id(17)] boolean hasChanged; + [id(18)] boolean hide; + [id(22)] LPDISPATCH OwningComponent; + + // our properties + [id(1001)] boolean value; + [id(1004)] boolean valueAbsolute; + [id(1002)] BSTR description; + + methods: + // inherited from IVariable + [id(1)] boolean isValid(); + [id(2)] void validate(); + [id(3)] BSTR getName(); + [id(4)] BSTR getFullName(); + [id(5)] BSTR getType(); + [id(6)] boolean isInput(); + [id(7)] BSTR toString(); + [id(8)] void fromString(BSTR value); + [id(9)] BSTR toStringAbsolute(); + [id(10)] void invalidate(); + [id(11)] LPDISPATCH directPrecedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(12)] LPDISPATCH directDependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(13)] LPDISPATCH precedentLinks( + [optional]VARIANT reserved); + [id(14)] LPDISPATCH dependentLinks( + [optional]VARIANT reserved); + [id(15)] LPDISPATCH precedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(16)] LPDISPATCH dependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(19)] boolean isInputToComponent(); + [id(20)] boolean isInputToModel(); + [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); + [id(23)] VARIANT getMetadata(BSTR name); + + // our methods + [id(1003)] void setInitialValue(BOOL value); + + }; + + // -------------------------------------------------------------- IComponent + [ uuid(526AC1E1-D718-11D3-A544-00A024B5452E), + helpstring("Component") ] + dispinterface IComponent + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + [id(5)] VARIANT Variables; + [id(6)] VARIANT Groups; + [id(11)] VARIANT userData; + [id(15)] VARIANT AssociatedFiles; + [id(18)] int IndexInParent; + [id(19)] LPDISPATCH ParentAssembly; + + methods: + [id(1)] BSTR getName(); + [id(2)] BSTR getFullName(); + [id(3)] void run(); + [id(4)] BSTR getSource(); + [id(7)] void invokeMethod(BSTR method); + [id(8)] void invalidate(); + [id(9)] void reconnect(); + [id(10)] void downloadValues(); + [id(12)] LPDISPATCH getVariable(BSTR name); + [id(13)] int getPositionX(); + [id(14)] int getPositionY(); + [id(16)] void rename(BSTR name); + [id(17)] BSTR getType(); + [id(20)] void show(); + [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); + [id(22)] VARIANT getMetadata(BSTR name); + }; + + // -------------------------------------------------------------- IComponents + [ uuid(712469FD-A1E9-4450-BE93-457ED13A91F1), + helpstring("Components object") ] + dispinterface IComponents + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + [id(1)] VARIANT Count; + + methods: + [id(2)] VARIANT Item(VARIANT id); + }; + + // -------------------------------------------------------------- IIfComponent + [ uuid(897c0864-810e-444a-b648-f6f08c639bc3), + helpstring("If component") ] + dispinterface IIfComponent + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + //inherited from IComponent + [id(5)] VARIANT Variables; + [id(6)] VARIANT Groups; + [id(11)] VARIANT userData; + [id(15)] VARIANT AssociatedFiles; + [id(18)] int IndexInParent; + [id(19)] LPDISPATCH ParentAssembly; + + //our properties + [id(1001)] boolean exclusive; + [id(1002)] boolean runLastBranchByDefault; + + methods: + + //inherited from IComponent + [id(1)] BSTR getName(); + [id(2)] BSTR getFullName(); + [id(3)] void run(); + [id(4)] BSTR getSource(); + [id(7)] void invokeMethod(BSTR method); + [id(8)] void invalidate(); + [id(9)] void reconnect(); + [id(10)] void downloadValues(); + [id(12)] LPDISPATCH getVariable(BSTR name); + [id(13)] int getPositionX(); + [id(14)] int getPositionY(); + [id(16)] void rename(BSTR name); + [id(17)] BSTR getType(); + [id(20)] void show(); + + //our methods + [id(1003)] int getNumBranches(); + [id(1004)] BSTR getBranchCondition( int index ); + [id(1005)] void setBranchCondition( int index, BSTR condition ); + [id(1006)] BSTR getBranchName( int index ); + [id(1007)] void renameBranch( int index, BSTR name ); + }; + + // -------------------------------------------------------------- IScriptComponent + [ uuid(126c0864-810e-535a-b648-f6f08c548bc3), + helpstring("Script component") ] + dispinterface IScriptComponent + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + //inherited from IComponent + [id(5)] VARIANT Variables; + [id(6)] VARIANT Groups; + [id(11)] VARIANT userData; + [id(15)] VARIANT AssociatedFiles; + [id(18)] int IndexInParent; + [id(19)] LPDISPATCH ParentAssembly; + + [id(1001)] BSTR language; + [id(1002)] double timeout; + [id(1003)] boolean forwardSchedule; + [id(1004)] boolean prevalidate; + + methods: + + //inherited from IComponent + [id(1)] BSTR getName(); + [id(2)] BSTR getFullName(); + [id(3)] void run(); + [id(4)] BSTR getSource(); + [id(7)] void invokeMethod(BSTR method); + [id(8)] void invalidate(); + [id(9)] void reconnect(); + [id(10)] void downloadValues(); + [id(12)] LPDISPATCH getVariable(BSTR name); + [id(13)] int getPositionX(); + [id(14)] int getPositionY(); + [id(16)] void rename(BSTR name); + [id(17)] BSTR getType(); + [id(20)] void show(); + + //our methods + [id(1010)] void setSourceFromString(BSTR script); + [id(1011)] void setSourceFromFile(BSTR file); + [id(1012)] LPDISPATCH addVariable(BSTR name, BSTR type, BSTR state); + [id(1013)] void removeVariable(BSTR name); + [id(1014)] void setVariables(VARIANT inputs, BSTR outputs); + [id(1015)] BSTR getSourceScript(); + }; + + // -------------------------------------------------------------- ICustomDesignPoint + [ uuid(214FB734-840B-4BC1-A063-1D2DFA0C6D0A), + helpstring("Data Collector Custom Design Point object") ] + dispinterface ICustomDesignPoint + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // properties go here + + methods: + [id(1)] void addVariable(BSTR name, BSTR equation, BOOL isNumeric, + BOOL isValid, BOOL isInput,BSTR type, + BSTR units, BSTR value); + [id(2)] void runFailed(BSTR reason); + }; + + // -------------------------------------------------------------- IDataCollector + [ uuid(1539CF41-7B1A-11D3-A526-00A024B5452E), + helpstring("Data Collector object") ] + dispinterface IDataCollector + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // properties go here + [id(30)] BOOL isVisible; + + methods: + [id(1)] void storeCurrentDesignPoint(); + [id(2)] void enableGraphTab(BOOL flag); + [id(3)] void show(); + [id(4)] void addCustom(BSTR variable, BSTR label); + [id(5)] void selectX(BSTR name); + [id(6)] void selectY(BSTR name); + [id(7)] void setNumExpectedRuns(long numRuns); + [id(8)] void startRuns(); + [id(9)] void endRuns(); + [id(10)] long getNumFailedRuns(); + [id(11)] int getErrorID( long run ); + [id(12)] BSTR getErrorMessage( long run ); + [id(13)] long getNumRuns(); + [id(14)] long getNumVariables(); + [id(15)] VARIANT getValue( VARIANT index, long run ); + [id(16)] IDispatch* getVariableDescription( VARIANT index ); + [id(17)] BOOL isValid( VARIANT index, long run ); + [id(18)] void save(BSTR fileName, BSTR displayName, BSTR description, BSTR author, BOOL saveModel); + [id(19)] void exportToCSV(BSTR fileName); + [id(20)] BSTR toString(); + [id(21)] void fromString(BSTR str); + [id(22)] void enableCarpetPlotTab(BSTR var1, BSTR var2, BSTR plotVar); + [id(23)] void storeCustomDesignPoint(IDispatch* customDesignPoint); + [id(24)] void createEmptyRuns(long numEmptyRuns); + [id(25)] void setCustomRun(long index,IDispatch* customDesignPoint); + [id(26)] IDispatch* newCustomDesignPoint(); + [id(27)] void enableMainEffectsTab(); + [id(28)] IDispatch* getDataExplorer(); + [id(29)] void hide(); + }; + + // -------------------------------------------------------------- IDoubleArray + [ uuid(514D1080-6A11-11D3-A518-00A024B5452E), + helpstring("Double variable array") ] + dispinterface IDoubleArray + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // inherited from IVariable + [id(17)] boolean hasChanged; + [id(18)] boolean hide; + [id(22)] LPDISPATCH OwningComponent; + + // inherited from IArray + [id(1001)] long size; + [id(1006)] long numDimensions; + + // our properties + [id(2002)] double lowerBound; + [id(2003)] double upperBound; + [id(2004)] BSTR description; + [id(2005)] BSTR units; + [id(2006)] BSTR enumAliases; + [id(2007)] BSTR enumValues; + [id(2014)] BSTR format; + + methods: + // inherited from IVariable + [id(1)] boolean isValid(); + [id(2)] void validate(); + [id(3)] BSTR getName(); + [id(4)] BSTR getFullName(); + [id(5)] BSTR getType(); + [id(6)] boolean isInput(); + [id(7)] BSTR toString(); + [id(8)] void fromString(BSTR value); + [id(9)] BSTR toStringAbsolute(); + [id(10)] void invalidate(); + [id(11)] LPDISPATCH directPrecedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(12)] LPDISPATCH directDependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(13)] LPDISPATCH precedentLinks( + [optional]VARIANT reserved); + [id(14)] LPDISPATCH dependentLinks( + [optional]VARIANT reserved); + [id(15)] LPDISPATCH precedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(16)] LPDISPATCH dependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(19)] boolean isInputToComponent(); + [id(20)] boolean isInputToModel(); + [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); + [id(23)] VARIANT getMetadata(BSTR name); + + // inherited from IArray + [id(1002)] BSTR toStringEx(long index); + [id(1003)] void fromStringEx(BSTR value, long index); + [id(1004)] BSTR toStringAbsoluteEx(long index); + [id(1007)] long getLength( [optional] VARIANT dim); + [id(1008)] void setLength(long length, [optional] VARIANT dim); + [id(1009)] void setDimensions( long d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + + // our methods + [id(2001), propget] double value(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(2001), propput] void value(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10, + double newValue); + [id(2008)] boolean hasLowerBound(); + [id(2009)] boolean hasUpperBound(); + [id(2010)] double getValue(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(2011)] void setValue(double value, VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(2012)] VARIANT getArray(); + [id(2013)] void setArray( VARIANT array ); + [id(2015)] BSTR toFormattedStringEx(long index); + [id(2016)] void fromFormattedStringEx(BSTR value, long index); + [id(2017)] BSTR toFormattedStringAbsoluteEx(long index); + [id(2018)] void clearUpperBound(); + [id(2019)] void clearLowerBound(); + [id(2020)] double getValueAbsolute(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + }; + + // -------------------------------------------------------------- IDoubleVariable + [ uuid(985910E7-C34D-11D2-A4E8-00A024B5452E), + helpstring("Double variable") ] + dispinterface IDoubleVariable + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // inherited from IVariable + [id(17)] boolean hasChanged; + [id(18)] boolean hide; + [id(22)] LPDISPATCH OwningComponent; + + // our properties + [id(1001)] double value; + [id(1017)] double valueAbsolute; + [id(1002)] double lowerBound; + [id(1003)] double upperBound; + [id(1004)] BSTR units; + [id(1005)] BSTR description; + [id(1006)] BSTR enumValues; + [id(1007)] BSTR enumAliases; + [id(1011)] BSTR format; + + methods: + // inherited from IVariable + [id(1)] boolean isValid(); + [id(2)] void validate(); + [id(3)] BSTR getName(); + [id(4)] BSTR getFullName(); + [id(5)] BSTR getType(); + [id(6)] boolean isInput(); + [id(7)] BSTR toString(); + [id(8)] void fromString(BSTR value); + [id(9)] BSTR toStringAbsolute(); + [id(10)] void invalidate(); + [id(11)] LPDISPATCH directPrecedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(12)] LPDISPATCH directDependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(13)] LPDISPATCH precedentLinks( + [optional]VARIANT reserved); + [id(14)] LPDISPATCH dependentLinks( + [optional]VARIANT reserved); + [id(15)] LPDISPATCH precedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(16)] LPDISPATCH dependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(19)] boolean isInputToComponent(); + [id(20)] boolean isInputToModel(); + [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); + [id(23)] VARIANT getMetadata(BSTR name); + + // our methods + [id(1008)] void setInitialValue(double value); + [id(1009)] boolean hasLowerBound(); + [id(1010)] boolean hasUpperBound(); + [id(1012)] BSTR toFormattedString(); + [id(1013)] void fromFormattedString(BSTR value); + [id(1014)] BSTR toFormattedStringAbsolute(); + [id(1015)] void clearUpperBound(); + [id(1016)] void clearLowerBound(); + + }; + + // -------------------------------------------------------------- IObjectVariable + [ uuid(989FF781-95F2-4cfa-A10E-57D169BDD0F3), + helpstring("Object variable") ] + dispinterface IObjectVariable + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // inherited from IVariable + [id(17)] boolean hasChanged; + [id(18)] boolean hide; + [id(22)] LPDISPATCH OwningComponent; + + // our properties + [id(1001)] BSTR value; + [id(1002)] BSTR description; + + methods: + // inherited from IVariable + [id(1)] boolean isValid(); + [id(2)] void validate(); + [id(3)] BSTR getName(); + [id(4)] BSTR getFullName(); + [id(5)] BSTR getType(); + [id(6)] boolean isInput(); + [id(7)] BSTR toString(); + [id(8)] void fromString(BSTR value); + [id(9)] BSTR toStringAbsolute(); + [id(10)] void invalidate(); + [id(11)] LPDISPATCH directPrecedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(12)] LPDISPATCH directDependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(13)] LPDISPATCH precedentLinks( + [optional]VARIANT reserved); + [id(14)] LPDISPATCH dependentLinks( + [optional]VARIANT reserved); + [id(15)] LPDISPATCH precedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(16)] LPDISPATCH dependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(19)] boolean isInputToComponent(); + [id(20)] boolean isInputToModel(); + [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); + [id(23)] VARIANT getMetadata(BSTR name); + + // our methods + [id(1011)] BSTR getClassURL(); + [id(1012)] VARIANT getMemberValue(BSTR member); + [id(1013)] VARIANT getMemberValueAbsolute(BSTR member); + [id(1014)] void setMemberValue(BSTR member, BSTR value); + [id(1015)] void setMember(BSTR member, BSTR value, BSTR type); + [id(1016)] void deleteMember(BSTR member); + [id(1017)] void deleteAllMembers(); + [id(1018)] VARIANT callMethod(BSTR method); + [id(1019)] boolean isNonStrictType(); + [id(1020)] BSTR toXML(); + [id(1021)] void fromXML(BSTR str); + [id(1022)] boolean hasMember(BSTR member); + [id(1023)] boolean isNumericMember(BSTR member); + [id(1024)] void reinitialize(); + [id(1025)] long getMemberLength(BSTR member, [optional] VARIANT dim); + [id(1026)] void setMemberLength(BSTR member, long length, [optional] VARIANT dim); + [id(1027)] void setMemberDimensions( BSTR member, + long d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(1028)] long getMemberNumDimensions( BSTR member ); + [id(1029)] VARIANT getMemberDimensions( BSTR member ); + [id(1030)] BSTR getMemberType(BSTR member); + [id(1031)] boolean hasMemberLowerBound(BSTR member); + [id(1032)] boolean hasMemberUpperBound(BSTR member); + [id(1033)] double getMemberLowerBound(BSTR member); + [id(1034)] void setMemberLowerBound(BSTR member, double lowerBound); + [id(1035)] double getMemberUpperBound(BSTR member); + [id(1036)] void setMemberUpperBound(BSTR member, double upperBound); + [id(1037)] BSTR getMemberEnumValues(BSTR member); + [id(1038)] void setMemberEnumValues(BSTR member, BSTR enumValues); + [id(1039)] BSTR getMemberEnumAliases(BSTR member); + [id(1040)] void setMemberEnumAliases(BSTR member, BSTR enumAliases); + [id(1041)] BSTR getMemberDescription(BSTR member); + [id(1042)] void setMemberDescription(BSTR member, BSTR description); + [id(1043)] BSTR getMemberUnits(BSTR member); + [id(1044)] void setMemberUnits(BSTR member, BSTR units); + [id(1045)] BSTR getMemberProperty(BSTR member, BSTR propertyName); + [id(1046)] void setMemberProperty(BSTR member, BSTR propertyName, BSTR propertyValue); + [id(1047)] VARIANT getMemberList(BSTR member); + [id(1048)] VARIANT getMethodList(); + [id(1049)] void toFile(BSTR member, BSTR fileName, VARIANT encoding); + [id(1050)] void fromFile(BSTR member, BSTR fileName); + [id(1051)] void toFileAbsolute(BSTR member, BSTR fileName, VARIANT encoding); + [id(1052)] boolean getIsBinary(BSTR member); + [id(1053)] void setIsBinary(BSTR member, boolean isBinary); + [id(1054)] BSTR getFileName(BSTR member); + [id(1055)] void setFileName(BSTR member, BSTR fileName); + [id(1056)] BSTR getFileExtension(BSTR member); + [id(1057)] void setFileExtension(BSTR member, BSTR fileExtension); + [id(1101)] VARIANT getArrayMemberValueAbsolute(BSTR member, VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(1102)] VARIANT getArrayMemberValue(BSTR member, VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(1103)] void setArrayMemberValue(BSTR member, BSTR value, VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(1104)] VARIANT getArrayMemberAbsolute(BSTR member); + [id(1105)] VARIANT getArrayMember(BSTR member); + [id(1106)] void setArrayMember( BSTR member, VARIANT array ); + + + }; + // -------------------------------------------------------------- IFeature + [ uuid(22D5CD66-AF6F-48F7-AC03-80095DE85C94), + helpstring("FlexLM Feature") ] + dispinterface IFeature + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // properties go here + + methods: + [id(1)] void checkin(); + }; + + // -------------------------------------------------------------- IFileArray + [ uuid(14F18BD0-5BD9-4fcc-B084-7D95360631BE), + helpstring("File variable array") ] + dispinterface IFileArray + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // inherited from IVariable + [id(17)] boolean hasChanged; + [id(18)] boolean hide; + [id(22)] LPDISPATCH OwningComponent; + + // inherited from IArray + [id(1001)] long size; + [id(1006)] long numDimensions; + + // our properties + [id(2002)] boolean isBinary; + [id(2003)] BSTR description; + [id(2013)] boolean saveWithModel; + //NOT SUPPORTED [id(2014)] boolean directTransfer; + + methods: + // inherited from IVariable + [id(1)] boolean isValid(); + [id(2)] void validate(); + [id(3)] BSTR getName(); + [id(4)] BSTR getFullName(); + [id(5)] BSTR getType(); + [id(6)] boolean isInput(); + [id(7)] BSTR toString(); + [id(8)] void fromString(BSTR value); + [id(9)] BSTR toStringAbsolute(); + [id(10)] void invalidate(); + [id(11)] LPDISPATCH directPrecedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(12)] LPDISPATCH directDependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(13)] LPDISPATCH precedentLinks( + [optional]VARIANT reserved); + [id(14)] LPDISPATCH dependentLinks( + [optional]VARIANT reserved); + [id(15)] LPDISPATCH precedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(16)] LPDISPATCH dependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(19)] boolean isInputToComponent(); + [id(20)] boolean isInputToModel(); + [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); + [id(23)] VARIANT getMetadata(BSTR name); + + // inherited from IArray + [id(1002)] BSTR toStringEx(long index); + [id(1003)] void fromStringEx(BSTR value, long index); + [id(1004)] BSTR toStringAbsoluteEx(long index); + [id(1007)] long getLength( [optional] VARIANT dim); + [id(1008)] void setLength(long length, [optional] VARIANT dim); + [id(1009)] void setDimensions( long d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + + // our methods + [id(2001), propget] BSTR value(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(2001), propput] void value(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10, + BSTR newValue); + [id(2004)] BSTR getFileExtension(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(2005)] void setFileExtension(BSTR value, VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(2006), propget] BSTR fileExtension(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(2006), propput] void fileExtension(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10, + BSTR newValue); + [id(2007)] void toFile(BSTR fileName, VARIANT encoding, VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(2008)] void fromFile(BSTR fileName, VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(2011)] void toFileAbsolute(BSTR fileName, VARIANT encoding, VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + + + }; + + // -------------------------------------------------------------- IFileVariable + [ uuid(A79BA2F2-C8C2-11d5-A008-0010A4C22C0F), + helpstring("File variable") ] + dispinterface IFileVariable + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // inherited from IVariable + [id(17)] boolean hasChanged; + [id(18)] boolean hide; + [id(22)] LPDISPATCH OwningComponent; + + // our properties + [id(1001)] BSTR value; + [id(1002)] boolean isBinary; + [id(1003)] BSTR fileExtension; + [id(1010)] BSTR description; + [id(1011)] boolean saveWithModel; + [id(1012)] boolean directTransfer; + + methods: + // inherited from IVariable + [id(1)] boolean isValid(); + [id(2)] void validate(); + [id(3)] BSTR getName(); + [id(4)] BSTR getFullName(); + [id(5)] BSTR getType(); + [id(6)] boolean isInput(); + [id(7)] BSTR toString(); + [id(8)] void fromString(BSTR value); + [id(9)] BSTR toStringAbsolute(); + [id(10)] void invalidate(); + [id(11)] LPDISPATCH directPrecedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(12)] LPDISPATCH directDependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(13)] LPDISPATCH precedentLinks( + [optional]VARIANT reserved); + [id(14)] LPDISPATCH dependentLinks( + [optional]VARIANT reserved); + [id(15)] LPDISPATCH precedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(16)] LPDISPATCH dependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(19)] boolean isInputToComponent(); + [id(20)] boolean isInputToModel(); + [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); + [id(23)] VARIANT getMetadata(BSTR name); + + // our methods + [id(1004)] void toFile(BSTR fileName, [optional] VARIANT encoding); + [id(1005)] void fromFile(BSTR fileName); + [id(1006)] void writeFile(BSTR fileName); + [id(1007)] void readFile(BSTR fileName); + [id(1008)] void toFileAbsolute(BSTR fileName, [optional] VARIANT encoding); + [id(1009)] void writeFileAbsolute(BSTR fileName); + }; + + // -------------------------------------------------------------- IGeometryVariable + [ uuid(E45A67F4-C367-11D2-A4E8-00A024B5452E), + helpstring("Geometry variable") ] + dispinterface IGeometryVariable + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // inherited from IVariable + [id(17)] boolean hasChanged; + [id(18)] boolean hide; + [id(22)] LPDISPATCH OwningComponent; + + // our properties + [id(1001)] BSTR value; + [id(1002)] BSTR description; + + methods: + // inherited from IVariable + [id(1)] boolean isValid(); + [id(2)] void validate(); + [id(3)] BSTR getName(); + [id(4)] BSTR getFullName(); + [id(5)] BSTR getType(); + [id(6)] boolean isInput(); + [id(7)] BSTR toString(); + [id(8)] void fromString(BSTR value); + [id(9)] BSTR toStringAbsolute(); + [id(10)] void invalidate(); + [id(11)] LPDISPATCH directPrecedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(12)] LPDISPATCH directDependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(13)] LPDISPATCH precedentLinks( + [optional]VARIANT reserved); + [id(14)] LPDISPATCH dependentLinks( + [optional]VARIANT reserved); + [id(15)] LPDISPATCH precedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(16)] LPDISPATCH dependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(19)] boolean isInputToComponent(); + [id(20)] boolean isInputToModel(); + [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); + [id(23)] VARIANT getMetadata(BSTR name); + + // our methods + [id(1003)] void setInitialValue(BSTR value); + }; + + // -------------------------------------------------------------- IGroup + [ uuid(0D132C39-CA70-11D5-A008-0010A4C22C0F), + helpstring("Group") ] + dispinterface IGroup + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + [id(1)] VARIANT Variables; + [id(2)] VARIANT Groups; + [id(5)] int iconID; + + methods: + [id(3)] BSTR getName(); + [id(4)] BSTR getFullName(); + }; + + // -------------------------------------------------------------- IGroups + [ uuid(0D132C3F-CA70-11D5-A008-0010A4C22C0F), + helpstring("Groups object") ] + dispinterface IGroups + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + [id(1)] VARIANT Count; + + methods: + [id(2)] VARIANT Item(VARIANT id); + }; + + // -------------------------------------------------------------- IIntegerArray + [ uuid(6CBF1A44-679A-11D3-A518-00A024B5452E), + helpstring("Integer variable array") ] + dispinterface IIntegerArray + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // inherited from IVariable + [id(17)] boolean hasChanged; + [id(18)] boolean hide; + [id(22)] LPDISPATCH OwningComponent; + + // inherited from IArray + [id(1001)] long size; + [id(1006)] long numDimensions; + + // our properties + [id(2002)] long lowerBound; + [id(2003)] long upperBound; + [id(2004)] BSTR description; + [id(2005)] BSTR units; + [id(2006)] BSTR enumAliases; + [id(2007)] BSTR enumValues; + [id(2014)] BSTR format; + + methods: + // inherited from IVariable + [id(1)] boolean isValid(); + [id(2)] void validate(); + [id(3)] BSTR getName(); + [id(4)] BSTR getFullName(); + [id(5)] BSTR getType(); + [id(6)] boolean isInput(); + [id(7)] BSTR toString(); + [id(8)] void fromString(BSTR value); + [id(9)] BSTR toStringAbsolute(); + [id(10)] void invalidate(); + [id(11)] LPDISPATCH directPrecedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(12)] LPDISPATCH directDependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(13)] LPDISPATCH precedentLinks( + [optional]VARIANT reserved); + [id(14)] LPDISPATCH dependentLinks( + [optional]VARIANT reserved); + [id(15)] LPDISPATCH precedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(16)] LPDISPATCH dependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(19)] boolean isInputToComponent(); + [id(20)] boolean isInputToModel(); + [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); + [id(23)] VARIANT getMetadata(BSTR name); + + // inherited from IArray + [id(1002)] BSTR toStringEx(long index); + [id(1003)] void fromStringEx(BSTR value, long index); + [id(1004)] BSTR toStringAbsoluteEx(long index); + [id(1007)] long getLength( [optional] VARIANT dim); + [id(1008)] void setLength(long length, [optional] VARIANT dim); + [id(1009)] void setDimensions( long d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + + // our methods + [id(2001), propget] long value(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(2001), propput] void value(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10, + long newValue); + [id(2008)] boolean hasLowerBound(); + [id(2009)] boolean hasUpperBound(); + [id(2010)] long getValue(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(2011)] void setValue(long value, VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(2012)] VARIANT getArray(); + [id(2013)] void setArray( VARIANT array ); + [id(2015)] BSTR toFormattedStringEx(long index); + [id(2016)] void fromFormattedStringEx(BSTR value, long index); + [id(2017)] BSTR toFormattedStringAbsoluteEx(long index); + [id(2018)] void clearUpperBound(); + [id(2019)] void clearLowerBound(); + [id(2020)] long getValueAbsolute(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + }; + + // -------------------------------------------------------------- IIntegerVariable + [ uuid(985910ED-C34D-11D2-A4E8-00A024B5452E), + helpstring("Integer variable") ] + dispinterface IIntegerVariable + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // inherited from IVariable + [id(17)] boolean hasChanged; + [id(18)] boolean hide; + [id(22)] LPDISPATCH OwningComponent; + + // our properties + [id(1001)] long value; + [id(1017)] long valueAbsolute; + [id(1002)] long lowerBound; + [id(1003)] long upperBound; + [id(1004)] BSTR units; + [id(1005)] BSTR description; + [id(1006)] BSTR enumValues; + [id(1007)] BSTR enumAliases; + [id(1011)] BSTR format; + + methods: + // inherited from IVariable + [id(1)] boolean isValid(); + [id(2)] void validate(); + [id(3)] BSTR getName(); + [id(4)] BSTR getFullName(); + [id(5)] BSTR getType(); + [id(6)] boolean isInput(); + [id(7)] BSTR toString(); + [id(8)] void fromString(BSTR value); + [id(9)] BSTR toStringAbsolute(); + [id(10)] void invalidate(); + [id(11)] LPDISPATCH directPrecedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(12)] LPDISPATCH directDependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(13)] LPDISPATCH precedentLinks( + [optional]VARIANT reserved); + [id(14)] LPDISPATCH dependentLinks( + [optional]VARIANT reserved); + [id(15)] LPDISPATCH precedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(16)] LPDISPATCH dependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(19)] boolean isInputToComponent(); + [id(20)] boolean isInputToModel(); + [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); + [id(23)] VARIANT getMetadata(BSTR name); + + // our methods + [id(1008)] void setInitialValue(long value); + [id(1009)] boolean hasLowerBound(); + [id(1010)] boolean hasUpperBound(); + [id(1012)] BSTR toFormattedString(); + [id(1013)] void fromFormattedString(BSTR value); + [id(1014)] BSTR toFormattedStringAbsolute(); + [id(1015)] void clearUpperBound(); + [id(1016)] void clearLowerBound(); + }; + + // -------------------------------------------------------------- IJobManager + [ uuid(0C0D84B7-8376-4A71-AD4F-862AAD1BCE51), + helpstring("Job Manager object") ] + dispinterface IJobManager + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // properties go here + + [id(28)] boolean wasHalted; + + methods: + [id(1)] void addInput( BSTR name, BSTR label ); + [id(2)] void setInput( long run, BSTR name, BSTR value ); + [id(3)] void addOutput( BSTR name, BSTR label ); + [id(4)] boolean getValidateAll(); + [id(5)] void setValidateAll( boolean flag ); + [id(6)] long getNumRuns(); + [id(7)] void setNumRuns( long numRuns ); + [id(8)] void submit( IDispatch* dataCollector, [optional]VARIANT description, [optional]VARIANT fireAndForget); + [id(9)] void waitForJobCompletion(); + [id(10)] void addRerun( long run ); + [id(11)] void halt( boolean halt ); + [id(12)] long getNumInputs(); + [id(13)] long getNumOutputs(); + [id(14)] BSTR getInput( long index ); + [id(15)] BSTR getOutput( long index ); + [id(16)] BSTR getInputLabel( long index ); + [id(17)] BSTR getOutputLabel( long index ); + [id(18)] long getNumThreads(); + [id(19)] boolean getRunInParallel(); + [id(20)] void setNumThreads(long numThreads); + [id(21)] void setRunInParallel(boolean runInParallel); + [id(22)] boolean enableCache(boolean enable); + [id(23)] void clearCache(); + [id(24)] long getRunIndex(VARIANT names, VARIANT values); + + [id(27)] void resume(IDispatch* dataHistory); + + + [id(29)] void setCustomMetadata(BSTR name, BSTR key, BSTR value); + + }; + + // -------------------------------------------------------------- IModelCenter + + typedef enum { + ASSEMBLY_STYLE_COLLAPSED = 0, + ASSEMBLY_STYLE_EXPANDED = 1, + ASSEMBLY_STYLE_CLASSIC = 100, + ASSEMBLY_STYLE_N_SQUARED = 101, + ASSEMBLY_STYLE_AUTO_N_SQUARED = 102, + ASSEMBLY_STYLE_FORCE_32_BITS = 65536 + } AssemblyStyle; + + [ uuid(BAACE1AA-EFDC-11D1-A4AD-00A024B5452E), + helpstring("ModelCenter main object") ] + dispinterface IModelCenter //NRS: This is IID_IPHXCOMClient in the code + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + [id(15)] BSTR modelDirectory; + [id(18)] boolean screenUpdating; + [id(25)] BSTR modelFileName; + [id(65)] BSTR appName; + [id(72)] BSTR appFullPath; + [id(82)] BOOL IsInteractive; + [id(102)] unsigned long ProcessID; + + methods: + [id(1)] BSTR getLastErrorMessage(); + [id(2)] void loadFile(BSTR fileName, [optional]VARIANT onConnectError); + [id(3)] void setValue(BSTR varName, BSTR value); + [id(4)] VARIANT getValue(BSTR varName); + [id(5)] void createComponent(BSTR serverPath, BSTR name, BSTR parent, [optional]VARIANT xPos, [optional]VARIANT yPos); + [id(6)] void createLink(BSTR variable, BSTR equation); + [id(7)] void newModel([optional]VARIANT modelType); + [id(8)] void saveModel(); + [id(9)] void saveModelAs(BSTR fileName); + [id(10)] void closeModel(); + [id(11)] void loadModel(BSTR fileName, [optional]VARIANT onConnectError); + [id(12)] IDispatch* getVariable(BSTR name); + [id(13)] IDispatch* getComponent(BSTR name); + [id(14)] void exit(); + [id(16)] IDispatch* createDataCollector(BSTR tradeStudyType, BSTR setup); + [id(17)] void tradeStudyEnd(); + [id(19)] IDispatch* createJobManager([optional]VARIANT showProgressDialog); + [id(20)] void tradeStudyStart(); + [id(21)] boolean getHaltStatus(); + [id(22)] IDispatch* getModel(); + [id(23)] void MessageBox(BSTR msg,[optional]VARIANT force); + [id(24)] VARIANT getValueAbsolute(BSTR varName); + [id(26)] void setScheduler(BSTR scheduler); + [id(27)] void removeComponent(BSTR name); + [id(28)] void breakLink(BSTR variable); + [id(29)] long getHWND(); + [id(30)] IDispatch* checkout(BSTR feature); + [id(40)] IDispatch* checkout2(BSTR feature, BSTR productRelease); + [id(31)] VARIANT runMacro(BSTR macro, [optional]VARIANT useMCObject); + [id(32)] IDispatch* createAssembly(BSTR name, BSTR parent, [optional]VARIANT assemblyType); + [id(33)] IDispatch* createAssemblyVariable(BSTR name, BSTR type, BSTR parent); + [id(34), propget] long version(long index); + [id(35)] void autoLink(BSTR srcComp, BSTR destComp); + [id(36)] LPDISPATCH getLinks([optional]VARIANT reserved); + [id(37)] BSTR getModelUUID(); + [id(38)] IDispatch* getFormatter(BSTR format); + [id(39)] void invokeHelp( long pageID ); + [id(41)] void launchTradeStudy(BSTR type, [optional]VARIANT setup); + [id(42)] long createPlugInFrame(BSTR name, BSTR title, BSTR reserved, LPDISPATCH plugIn, [optional]VARIANT showFavorites, [optional]VARIANT defaultHeight, [optional]VARIANT defaultWidth); + [id(43)] void setAlternateParentFrame(long hwnd); + [id(44)] void displayAboutBox(); + [id(45)] void halt(); + [id(46)] void displayPreferencesDialog(); + [id(47)] void run(BSTR variableArray); + [id(48)] IDispatch* getDataMonitor(BSTR component, VARIANT index); + [id(49)] IDispatch* createDataMonitor(BSTR component, BSTR name, int x, int y); + [id(50)] boolean isOkToClose(); + [id(51)] short addIcon(BSTR iconFile); + [id(52)] boolean removeDataMonitor(BSTR component, VARIANT index); + [id(53)] void destroyPlugInFrame(long hwnd); + [id(54)] void showPlugInFrame(long hwnd); + [id(55)] void hidePlugInFrame(long hwnd); + [id(56)] void setIconPlugInFrame(long hwnd, BSTR iconFile); + [id(57)] void setUserName(BSTR userName); + [id(58)] void setPassword(BSTR password); + [id(59)] long launchHTMLViewer(BSTR url, boolean popup); + [id(60)] void runAntFile(BSTR fileName); + [id(61)] IDispatch* getGlobalParameters(); + [id(62)] boolean closeHTMLViewer(long hwnd); + [id(63)] void HTMLViewerWaitForClose(long hwnd); + [id(64)] long HTMLViewerGetMyHWND(); + [id(66)] IDispatch* getActiveJobManager(); + [id(67)] VARIANT getPreference(BSTR pref); + [id(68)] void internalLicensing(BSTR,long); + [id(69)] BSTR getModelCenterPath(); + [id(70)] void transformAVPoint(int x, int y, boolean screen, VARIANT* tx, VARIANT* ty); + [id(71)] IDispatch* getDataExplorer(int index); + [id(73)] IDispatch* getDataCollector(int index); + [id(74)] IDispatch* parallelInstance(); + [id(75)] IDispatch* getLogger(); + [id(76)] IDispatch* unAssociatedInstance(); + [id(77)] long createPlugInFrame2(BSTR name, BSTR title, BSTR reserved, LPDISPATCH plugIn, [optional]VARIANT showFavorites, [optional]VARIANT defaultHeight, [optional]VARIANT defaultWidth, [optional]VARIANT minimumHeight, [optional]VARIANT minimumWidth); + [id(78)] void configureLogging(boolean enableLogging); + [id(79)] void moveComponent(BSTR component, BSTR parent, [optional]VARIANT index); + [id(80)] void setXMLExtension(BSTR xml); + [id(81)] BSTR getXMLExtension(BSTR nodeName, BSTR attributeName, BSTR attributeValue); + [id(83)] void setAssemblyStyle(BSTR assemblyName, AssemblyStyle style, [optional]VARIANT width, [optional]VARIANT height); + [id(84)] AssemblyStyle getAssemblyStyle(BSTR assemblyName, int *width, int *height); + [id(85)] IDispatch* getAssembly(BSTR name); + [id(86)] IDispatch* createAndInitComponent(BSTR serverPath, BSTR name, BSTR parent, BSTR initString, [optional]VARIANT xPos, [optional]VARIANT yPos); + [id(87)] BSTR getLicensingPath(); + + [id(89)] BSTR getMacroScript(BSTR macroName); + [id(90)] void setMacroScript(BSTR macroName, BSTR script); + [id(91)] BSTR getMacroScriptLanguage(BSTR macroName); + [id(92)] void setMacroScriptLanguage(BSTR macroName, BSTR language); + [id(93)] void addNewMacro(BSTR macroName, boolean isAppMacro); + [id(94)] void launchMacroEditor(BSTR macroName); + [id(95)] void startGUIMode([optional]VARIANT showDialogs); + [id(96)] long getNumUnitCategories(); + [id(97)] BSTR getUnitCategoryName(long index); + [id(98)] long getNumUnits(BSTR category); + [id(99)] BSTR getUnitName(BSTR category, long index); + [id(100)] IDispatch* createTradeStudy(BSTR type, [optional]VARIANT setup); + + [id(101)] void setPreference(BSTR pref, BSTR value); + + [id(103)] IDispatch* getNetworkLocations(); + [id(104)] void saveVersionedModel(VersionStatus versionStatus, BSTR checkinMessage); + [id(105)] void saveVersionedModelAs(BSTR fileName, VersionStatus versionStatus, BSTR checkinMessage); + + [id(106)] LPDISPATCH getVariableMetaData(BSTR name); + + [id(107)] void dumpComDebug(); + + [id(108)] BSTR showFileBrowseDialog(BSTR title, [optional]VARIANT filters, [optional]VARIANT initialUri, [optional]VARIANT hwnd); + + [id(115)] BSTR showFileSaveDialog(BSTR title, int *selectedFilter, [optional]VARIANT initialFilename, [optional]VARIANT filters, [optional]VARIANT initialUri, [optional]VARIANT hwnd); + + [id(109)] void setLoginCallback(IDispatch* callback); + + [id(110)] IDispatch* createDataHistoryVariable(); + + [id(111)] boolean getRunOnlyMode(); + + [id(112)] void setRunOnlyMode(boolean shouldBeInRunOnly); + + [id(113)] IDispatch* createDataExplorer(BSTR tradeStudyType, BSTR setup); + + [id(114)] IDispatch* getFileSystemInfo(BSTR url); + + [id(116)] SAFEARRAY(BSTR) getTradeStudyFilters(); + + [id(117)] void saveTradeStudy(BSTR uri, int format, LPDISPATCH dataExplorer); + + [id(118)] IDispatch* getDataCollectorForDataExplorer(LPDISPATCH dataExplorer); + + [id(119)] void launchDataCollectorPlugIn(BSTR plugInName, LPDISPATCH dataExplorer); + + [id(120)] boolean guiLoadFile(BSTR fileName); + + [id(121)] void guiSaveModel(); + + [id(122)] double getMacroTimeout(BSTR macroName); + + [id(123)] void setMacroTimeout(BSTR macroName, double timeout); + + [id(124)] boolean guiCloseAllMultiplexers(); + + // NOTE: When adding new methods, do NOT reuse the numbers below for non-STK builds. The IDs must be unique in all + // build configurations. Hopefully, 350 is sufficient padding that this will never have a collision. +#ifndef DOXYGEN_SHOULD_SKIP_THIS +#ifdef STKOEM + + [id(350)] long createSTKTree(); + + [id(351)] void destroySTKTree(long hwnd); + +#endif // STKOEM +#endif // DOXYGEN_SHOULD_SKIP_THIS + }; + + [ uuid(3C596B3E-0B8A-4B07-87D5-E9C165F858FB), + helpstring("Dispatch interface for ILoginCallback") ] + dispinterface ILoginCallback + { + properties: + methods: + [id(1)] boolean requestAuthCredentials(BSTR uri, boolean isFailedAttempt, VARIANT* username, VARIANT* password, VARIANT* savePassword); + + [id(2)] void loginSucceeded(BSTR uri, BSTR username, BSTR password, boolean savePassword); + + [id(3)] boolean verifySslWarning(BSTR msg); + }; + + [ uuid(F2C901DF-0E2D-4715-9DE9-E69206ADF0C0), + helpstring("Trade Study Run events") ] + dispinterface ITradeStudyEvents + { + properties: + methods: + [id(1)] void StartToolRun(); + [id(2)] void EndToolRun(); + [id(3)] void ToolClosed(BSTR type); + + [id(4)] void ModelXMLExtensionsChanged(); + } + + [ uuid(F154331D-C65C-41A6-84D5-7BB9A065279D), + helpstring("Show Help events")] + dispinterface IShowHelpEvents + { + properties: + methods: + [id(1)] void ShowHelp(long context); + } + +#ifndef DOXYGEN_SHOULD_SKIP_THIS + +// Change STKAnalyzer Library GUID, CLSID, and progId for every release no matter major or minor releases, to support +// Independency from different releases. This value is unique for each release and must match the LIBID_PHXModelCenter +// value in ModelCenter.cpp and ModelCenterTypeLibrary/dummy.cpp. Also update PHXComClient.h/cpp +#if defined(STKOEM) + + [uuid(5fD16F36-7345-41F2-A95E-1EF9FAEF5D60)] + coclass STK1200Application + { + [default] dispinterface IModelCenter; + [default, source] dispinterface ITradeStudyEvents; + [source] dispinterface IShowHelpEvents; + }; + +#elif defined(NODERUNNER) + + [ uuid(BAACE1AB-EFDC-11D1-A4AD-00A024B54530) ] + coclass Application + { + [default] dispinterface IModelCenter; + [default, source] dispinterface ITradeStudyEvents; + }; + +#else + + [ uuid(BAACE1AB-EFDC-11D1-A4AD-00A024B5452E) ] + coclass Application + { + [default] dispinterface IModelCenter; + [default, source] dispinterface ITradeStudyEvents; +[source] dispinterface IShowHelpEvents; + }; + +#endif +#endif + + typedef enum + { + CONN_ERR_ERROR = 3, + CONN_ERR_IGNORE = 1, + CONN_ERR_USEDIALOG = -1 + } OnConnectionErrorMode; + + // --------------------------------------------------------------- INetworkLocations + [ uuid(F036F767-ACF7-4128-823F-74E8B7E53EE9), + helpstring("Network Locations") ] + dispinterface INetworkLocations + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + + methods: + [id(1)] void add(BSTR address, BSTR username, BSTR password); + + [id(2)] boolean exists(BSTR address); + + [id(3)] void removeAddress(BSTR address); + }; + + // -------------------------------------------------------------- IRefArrayProp + [ uuid(5BFF8381-7802-11D3-A524-00A024B5452E), + helpstring("Reference variable array") ] + dispinterface IRefArrayProp + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + [id(1)] BSTR enumValues; + [id(2)] boolean isInput; + [id(3)] BSTR title; + [id(4)] BSTR description; + + methods: + [id(5)] BSTR getName(); + [id(6)] BSTR getType(); + }; + + // -------------------------------------------------------------- IReferenceArray + [ uuid(492AB501-6AA8-11D3-A519-00A024B5452E), + helpstring("Reference variable array") ] + dispinterface IReferenceArray + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // inherited from IVariable + [id(17)] boolean hasChanged; + [id(18)] boolean hide; + [id(22)] LPDISPATCH OwningComponent; + + // inherited from IArray + [id(1001)] long size; + [id(1006)] long numDimensions; + + // our properties + [id(2003)] boolean autoGrow; + + methods: + // inherited from IVariable + [id(1)] boolean isValid(); + [id(2)] void validate(); + [id(3)] BSTR getName(); + [id(4)] BSTR getFullName(); + [id(5)] BSTR getType(); + [id(6)] boolean isInput(); + [id(7)] BSTR toString(); + [id(8)] void fromString(BSTR value); + [id(9)] BSTR toStringAbsolute(); + [id(10)] void invalidate(); + [id(11)] LPDISPATCH directPrecedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(12)] LPDISPATCH directDependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(13)] LPDISPATCH precedentLinks( + [optional]VARIANT reserved); + [id(14)] LPDISPATCH dependentLinks( + [optional]VARIANT reserved); + [id(15)] LPDISPATCH precedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(16)] LPDISPATCH dependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(19)] boolean isInputToComponent(); + [id(20)] boolean isInputToModel(); + [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); + [id(23)] VARIANT getMetadata(BSTR name); + + // inherited from IArray + [id(1002)] BSTR toStringEx(long index); + [id(1003)] void fromStringEx(BSTR value, long index); + [id(1004)] BSTR toStringAbsoluteEx(long index); + [id(1007)] long getLength( [optional] VARIANT dim); + [id(1008)] void setLength(long length, [optional] VARIANT dim); + [id(1009)] void setDimensions( long d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + + // our methods + [id(2001), propget] double value(long index); + [id(2001), propput] void value(long index, double newValue); + [id(2002), propget] BSTR reference(long index); + [id(2002), propput] void reference(long index, BSTR newValue); + [id(2004)] double getValue(int index); + [id(2005)] double setValue(double value, int index); + [id(2008)] IDispatch* createRefProp(BSTR name, BSTR type); + [id(2009)] VARIANT getRefPropValue( BSTR name, int index ); + [id(2010)] void setRefPropValue( BSTR name, int index, BSTR value ); + [id(2011)] VARIANT getRefPropValueAbsolute( BSTR name, int index ); + [id(2012), propget] VARIANT referencedVariables(long index); + [id(2013), propget] VARIANT referencedVariable(long index); + [id(2014)] double getValueAbsolute(int index); + + }; + + // -------------------------------------------------------------- IReferenceVariable + [ uuid(4864FF03-3DE9-11D3-A50E-00A024B5452E), + helpstring("Reference variable") ] + dispinterface IReferenceVariable + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // inherited from IVariable + [id(17)] boolean hasChanged; + [id(18)] boolean hide; + [id(22)] LPDISPATCH OwningComponent; + + // our properties + [id(1001)] double value; + [id(1002)] BSTR reference; + [id(1009)] VARIANT referencedVariables; + [id(1010)] VARIANT referencedVariable; + + methods: + // inherited from IVariable + [id(1)] boolean isValid(); + [id(2)] void validate(); + [id(3)] BSTR getName(); + [id(4)] BSTR getFullName(); + [id(5)] BSTR getType(); + [id(6)] boolean isInput(); + [id(7)] BSTR toString(); + [id(8)] void fromString(BSTR value); + [id(9)] BSTR toStringAbsolute(); + [id(10)] void invalidate(); + [id(11)] LPDISPATCH directPrecedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(12)] LPDISPATCH directDependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(13)] LPDISPATCH precedentLinks( + [optional]VARIANT reserved); + [id(14)] LPDISPATCH dependentLinks( + [optional]VARIANT reserved); + [id(15)] LPDISPATCH precedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(16)] LPDISPATCH dependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(19)] boolean isInputToComponent(); + [id(20)] boolean isInputToModel(); + [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); + [id(23)] VARIANT getMetadata(BSTR name); + + // our methods + [id(1005)] IDispatch* createRefProp( BSTR name, BSTR type ); + [id(1006)] VARIANT getRefPropValue( BSTR name ); + [id(1007)] void setRefPropValue( BSTR name, BSTR value ); + [id(1008)] VARIANT getRefPropValueAbsolute( BSTR name ); + }; + + // -------------------------------------------------------------- IRefProp + [ uuid(D3F8D5D4-7769-11D3-A522-00A024B5452E), + helpstring("Reference property") ] + dispinterface IRefProp + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + [id(1)] BSTR enumValues; + [id(2)] boolean isInput; + [id(3)] BSTR title; + [id(4)] BSTR description; + + methods: + [id(5)] BSTR getName(); + [id(6)] BSTR getType(); + }; + + // -------------------------------------------------------------- IStringArray + [ uuid(6CBF1A4C-679A-11D3-A518-00A024B5452E), + helpstring("String variable array") ] + dispinterface IStringArray + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // inherited from IVariable + [id(17)] boolean hasChanged; + [id(18)] boolean hide; + [id(22)] LPDISPATCH OwningComponent; + + // inherited from IArray + [id(1001)] long size; + [id(1006)] long numDimensions; + + // our properties + [id(2002)] BSTR description; + [id(2003)] BSTR enumAliases; + [id(2004)] BSTR enumValues; + + methods: + // inherited from IVariable + [id(1)] boolean isValid(); + [id(2)] void validate(); + [id(3)] BSTR getName(); + [id(4)] BSTR getFullName(); + [id(5)] BSTR getType(); + [id(6)] boolean isInput(); + [id(7)] BSTR toString(); + [id(8)] void fromString(BSTR value); + [id(9)] BSTR toStringAbsolute(); + [id(10)] void invalidate(); + [id(11)] LPDISPATCH directPrecedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(12)] LPDISPATCH directDependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(13)] LPDISPATCH precedentLinks( + [optional]VARIANT reserved); + [id(14)] LPDISPATCH dependentLinks( + [optional]VARIANT reserved); + [id(15)] LPDISPATCH precedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(16)] LPDISPATCH dependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(19)] boolean isInputToComponent(); + [id(20)] boolean isInputToModel(); + [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); + [id(23)] VARIANT getMetadata(BSTR name); + + // inherited from IArray + [id(1002)] BSTR toStringEx(long index); + [id(1003)] void fromStringEx(BSTR value, long index); + [id(1004)] BSTR toStringAbsoluteEx(long index); + [id(1007)] long getLength( [optional] VARIANT dim); + [id(1008)] void setLength(long length, [optional] VARIANT dim); + [id(1009)] void setDimensions( long d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + + // our methods + [id(2001), propget] BSTR value(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(2001), propput] void value(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10, + BSTR newValue); + [id(2005)] BSTR getValue(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(2006)] void setValue(BSTR value, VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + [id(2007)] VARIANT getArray(); + [id(2008)] void setArray( VARIANT array ); + [id(2009)] BSTR getValueAbsolute(VARIANT d1, [optional] VARIANT d2, + [optional] VARIANT d3, [optional] VARIANT d4, + [optional] VARIANT d5, [optional] VARIANT d6, + [optional] VARIANT d7, [optional] VARIANT d8, + [optional] VARIANT d9, [optional] VARIANT d10); + }; + + // -------------------------------------------------------------- IStringVariable + [ uuid(985910E3-C34D-11D2-A4E8-00A024B5452E), + helpstring("String variable") ] + dispinterface IStringVariable + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // inherited from IVariable + [id(17)] boolean hasChanged; + [id(18)] boolean hide; + [id(22)] LPDISPATCH OwningComponent; + + // our properties + [id(1001)] BSTR value; + [id(1006)] BSTR valueAbsolute; + [id(1002)] BSTR description; + [id(1003)] BSTR enumValues; + [id(1004)] BSTR enumAliases; + + methods: + // inherited from IVariable + [id(1)] boolean isValid(); + [id(2)] void validate(); + [id(3)] BSTR getName(); + [id(4)] BSTR getFullName(); + [id(5)] BSTR getType(); + [id(6)] boolean isInput(); + [id(7)] BSTR toString(); + [id(8)] void fromString(BSTR value); + [id(9)] BSTR toStringAbsolute(); + [id(10)] void invalidate(); + [id(11)] LPDISPATCH directPrecedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(12)] LPDISPATCH directDependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(13)] LPDISPATCH precedentLinks( + [optional]VARIANT reserved); + [id(14)] LPDISPATCH dependentLinks( + [optional]VARIANT reserved); + [id(15)] LPDISPATCH precedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(16)] LPDISPATCH dependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(19)] boolean isInputToComponent(); + [id(20)] boolean isInputToModel(); + [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); + [id(23)] VARIANT getMetadata(BSTR name); + + // our methods + [id(1005)] void setInitialValue(BSTR value); + }; + + // -------------------------------------------------------------- IVariable + [ uuid(A0E042F1-B480-11D2-A4E6-00A024B5452E), + helpstring("Variable base class") ] + dispinterface IVariable + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + [id(17)] boolean hasChanged; + [id(18)] boolean hide; + [id(22)] LPDISPATCH OwningComponent; + + methods: + [id(1)] boolean isValid(); + [id(2)] void validate(); + [id(3)] BSTR getName(); + [id(4)] BSTR getFullName(); + [id(5)] BSTR getType(); + [id(6)] boolean isInput(); + [id(7)] BSTR toString(); + [id(8)] void fromString(BSTR value); + [id(9)] BSTR toStringAbsolute(); + [id(10)] void invalidate(); + [id(11)] LPDISPATCH directPrecedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(12)] LPDISPATCH directDependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(13)] LPDISPATCH precedentLinks( + [optional]VARIANT reserved); + [id(14)] LPDISPATCH dependentLinks( + [optional]VARIANT reserved); + [id(15)] LPDISPATCH precedents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(16)] LPDISPATCH dependents( + [optional]VARIANT followSuspended, + [optional]VARIANT reserved); + [id(19)] boolean isInputToComponent(); + [id(20)] boolean isInputToModel(); + [id(21)] void setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive); + [id(23)] VARIANT getMetadata(BSTR name); + }; + + + // -------------------------------------------------------------- IVariableDescription + [ uuid(EAE610F5-CC85-11D5-A008-0010A4C22C0F), + helpstring("Variable description") ] + dispinterface IVariableDescription + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + [id(1)] BSTR name; + [id(2)] BSTR fullName; + [id(3)] short state; + [id(4)] BSTR units; + [id(5)] boolean isCustom; + [id(6)] BSTR equation; + [id(7)] BSTR type; + [id(8)] boolean isNumeric; + + methods: + }; + + // -------------------------------------------------------------- IVariableLink + [ uuid(0F11CB29-B367-40ED-8F26-BD4A54DACF2A), + helpstring("VariableLink object") ] + dispinterface IVariableLink + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + [id(1)] BSTR LHS; + [id(2)] BSTR RHS; + + methods: + [id(3)] void suspendLink(); + [id(4)] void resumeLink(); + [id(5)] void breakLink(); + }; + + // -------------------------------------------------------------- IVariableLinks + [ uuid(C5B28059-9C9F-4EA3-9AB1-B9EDE06C4152), + helpstring("VariableLinks collection") ] + dispinterface IVariableLinks + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + [id(1)] VARIANT Count; + + methods: + [id(2)] VARIANT Item(VARIANT id); + }; + + // -------------------------------------------------------------- IVariables + [ uuid(CC3F2432-D179-4018-835F-34173613824B), + helpstring("Variables object") ] + dispinterface IVariables + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + [id(1)] VARIANT Count; + + methods: + [id(2)] VARIANT Item(VARIANT id); + }; + + // -------------------------------------------------------------- IPHXFormat + [ uuid(F7E774F5-A4CA-41D0-8F48-CC6B45043FB4) ] + dispinterface IPHXFormat + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // NOTE - ClassWizard will maintain property information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_PROP(PHXCOMFormat) + //}}AFX_ODL_PROP + + methods: + // NOTE - ClassWizard will maintain method information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_METHOD(PHXCOMFormat) + [id(1)] void setFormat(BSTR format); + [id(2)] long stringToLong(BSTR str); + [id(3)] double stringToDouble(BSTR str); + [id(4)] BSTR longToString(long val); + [id(5)] BSTR doubleToString(double val); + [id(6)] BSTR getFormat(); + [id(7)] BSTR stringToString(BSTR str); + [id(8)] BSTR longToEditableString(long val); + [id(9)] BSTR doubleToEditableString(double val); + //}}AFX_ODL_METHOD + + }; + + // -------------------------------------------------------------- IDataMonitor + [ uuid(B4009E4E-5E90-4b44-8687-143051AA7400), + helpstring("Data Monitor object") ] + dispinterface IDataMonitor + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // properties go here + + methods: + [id(1)] BSTR getName( long row ); + [id(2)] void setName( long row, BSTR name ); + [id(3)] boolean isRenamed( long row ); + [id(4)] BSTR getLink ( long row ); + [id(5)] boolean setLink( long row, BSTR link ); + [id(6)] int addItem( BSTR name, BSTR link ); + [id(7)] int addUnlinkedItem( BSTR name ); + [id(8)] void removeItem( long row ); + [id(9)] void removeLink( long row ); + [id(10)] boolean getDisplayFullNames( ); + [id(11)] void setDisplayFullNames( boolean ); + [id(12)] boolean getAutoDelete( ); + [id(13)] void setAutoDelete( boolean ); + [id(14)] boolean getDisplayUnits( ); + [id(15)] void setDisplayUnits( boolean ); + [id(16)] int getColWidth( long col ); + [id(17)] void setColWidth( long col, int width ); + [id(18)] boolean isValid( ); + [id(19)] BSTR getTitle( ); + [id(20)] void setTitle( BSTR title ); + [id(21)] int getWidth( ); + [id(22)] int getHeight( ); + [id(23)] void setSize( int width, int height ); + [id(24)] int getX( ); + [id(25)] int getY( ); + [id(26)] void setLocation( int x, int y); + }; + + + // Primary dispatch interface for PHXComGlobalParameters + + [ uuid(CBBF5B6F-ED70-463D-B1E6-6DAE10500A4E) ] + dispinterface IGlobalParameters + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // NOTE - ClassWizard will maintain property information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_PROP(PHXComGlobalParameters) + [id(1)] long count; + //}}AFX_ODL_PROP + + methods: + // NOTE - ClassWizard will maintain method information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_METHOD(PHXComGlobalParameters) + [id(4), propget] VARIANT item(VARIANT index); + [id(4), propput] void item(VARIANT index, VARIANT newValue); + [id(0), propget] VARIANT _item(VARIANT index); + [id(0), propput] void _item(VARIANT index, VARIANT newValue); + [id(2)] void setExportToRemoteComponents(VARIANT index, boolean bexport); + [id(3)] void Remove(VARIANT index); + //}}AFX_ODL_METHOD + + }; + + // -------------------------------------------------------------- ILogger + [ uuid(B478A93F-8BAC-43c5-9C4C-BD4AF8C9BAC1), + helpstring("Logger") ] + dispinterface ILogger + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // properties go here + + methods: + [id(9)] boolean isTraceEnabled(); + [id(1)] boolean isDebugEnabled(); + [id(2)] boolean isInfoEnabled(); + [id(3)] boolean isWarnEnabled(); + [id(4)] boolean isErrorEnabled(); + [id(10)] void trace(BSTR message); + [id(5)] void debug(BSTR message); + [id(6)] void info(BSTR message); + [id(7)] void warn(BSTR message); + [id(8)] void error(BSTR message); + }; + + // -------------------------------------------------------------- ICachePin + [ uuid(631F5771-6F41-495F-BF88-55368128C415), + helpstring("CachePin") ] + dispinterface ICachePin + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // properties go here + + [id(1)] BSTR Url; + [id(2)] BSTR LocalPath; + [id(3)] boolean IsValid; + + methods: + [id(4)] boolean releasePin(); + [id(5)] void checkinOnFlush(BSTR message); + }; + + + //{{AFX_APPEND_ODL}} + + // -------------------------------------------------------------- IFileSystemInfo + [uuid(3E645325-85F9-456B-B5B7-395C90825986), + helpstring("FileSystemInfo") ] + dispinterface IFileSystemInfo + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + + [id(1)] boolean isValid; + + [id(2)] boolean exists; + + [id(3)] boolean isWritable; + + [id(4)] BSTR baseName; + + [id(5)] BSTR url; + + methods: + [id(6)] LPDISPATCH pin(boolean forWrite, [optional] VARIANT forceCopy); + }; + //{{AFX_APPEND_ODL}} + +#ifndef DOXYGEN_SHOULD_SKIP_THIS + // -------------------------------------------------------------- IVizContainer + [uuid(D57D1AA5-B852-4EB1-991E-7433AF3E0006), + helpstring("VizContainer") ] + + dispinterface IVizContainer + { + + properties: + [id(1)] boolean Visible; + + [id(2)] long HWnd; + + [id(3)] IDispatch* DataExplorerPlugIn; + + [id(6)] IDispatch* DataExplorer; + + methods: + + [id(4)] void hide(); + + [id(5)] void show(); + + [id(7)] void fileSaved(); + + [id(8)] void showAt(long top, long left, long width, long height, [optional] VARIANT state); + }; + +#endif + +}; + + +``` + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/PHXDataExplorer_8odl.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/PHXDataExplorer_8odl.md index 46d504fcca..22ca3e1cfb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/PHXDataExplorer_8odl.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/PHXDataExplorer_8odl.md @@ -1,277 +1,276 @@ - -# File PHXDataExplorer.odl - -![][IDL] - -**Location**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` - - - - - -## Classes - -* [PHXDATAEXPLORERLib::\_DPHXDataExplorer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer) -* [PHXDATAEXPLORERLib::\_DPHXDataExplorerEvents](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents) -* [PHXDATAEXPLORERLib::PHXDataExplorer](classPHXDATAEXPLORERLib_1_1PHXDataExplorer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorer) -* [PHXDATAEXPLORERLib::IPHXDataExplorerPointer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer) -* [PHXDATAEXPLORERLib::PHXDataExplorerPointer](classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer) -* [PHXDATAEXPLORERLib::IPHXDEKeepalive](interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive.md#interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive) -* [PHXDATAEXPLORERLib::IDataExplorerFacadeOwner](interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner.md#interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner) -* [PHXDATAEXPLORERLib::IPageVisibility](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility) -* [PHXDATAEXPLORERLib::ILegacyVisiblity](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity) - -## Namespaces - -* [PHXDATAEXPLORERLib](namespacePHXDATAEXPLORERLib.md#namespacePHXDATAEXPLORERLib) - -## Includes - -* -* - -```mermaid -graph LR -1["LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl"] -click 1 "PHXDataExplorer_8odl.md#PHXDataExplorer_8odl" -1 --> 2 -1 --> 3 - -3["idispids.h"] - -2["olectl.h"] - -``` - -## Source - -``` -// PHXDataExplorer.odl : type library source for ActiveX Control project. - -// This file will be processed by the Make Type Library (mktyplib) tool to -// produce the type library (PHXDataExplorer.tlb) that will become a resource in -// PHXDataExplorer.ocx. - -[ uuid(091E15A1-980A-4B43-AD02-91DFD8144D7E), version(2.0), - helpfile("PHXDataExplorer.hlp"), - helpstring("PHXDataExplorer ActiveX Control module"), - control ] -library PHXDATAEXPLORERLib -{ - #include - #include - #include "olectl.h" - - importlib(STDOLE_TLB); - importlib(STDTYPE_TLB); - - // Primary dispatch interface for CPHXDataExplorer - - [ uuid(14375246-E4A1-4A30-85B2-0DF991B4FFB1), - helpstring("Dispatch interface for PHXDataExplorer Control"), hidden ] -#ifndef DOXYGEN_SHOULD_SKIP_THIS // so that _DPHXDataExplorer appears as PHXDataExplorer in documentation - dispinterface _DPHXDataExplorer - { - properties: -#else - dispinterface PHXDataExplorer - { - methods: -#endif - // NOTE - ClassWizard will maintain property information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_PROP(CPHXDataExplorerCtrl) - [id(1)] BSTR author; - [id(2)] BSTR description; - [id(3)] BSTR displayName; - [id(4)] IDispatch* modelCenter; - [id(5)] BSTR tradeStudyType; - [id(6)] IDispatch* dataHistory; - [id(7)] BSTR tradeStudySetup; - [id(27)] BSTR associatedModelFile; - [id(28)] BSTR associatedModelFileUUID; - [id(60)] BSTR creationDate; - - [id(61)] BSTR tradeStudyUri; - //}}AFX_ODL_PROP - - methods: - // NOTE - ClassWizard will maintain method information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_METHOD(CPHXDataExplorerCtrl) - [id(8)] long getNumPages(); - [id(9)] IDispatch* getPage(long page); - [id(10)] IDispatch* addPage(BSTR type, VARIANT insertBefore, VARIANT setupString); - [id(11)] void removePage(long page); - [id(12)] void movePage(long page, long insertBefore); - [id(13)] void selectPage(long page); - [id(14)] long getSelectedPage(); - [id(15)] void pageCut(long index); - [id(16)] void pageCopy(long index); - [id(17)] void pagePaste(); - [id(18)] void invokeInsertPageGUI(); - [id(19)] void toXMLFile(BSTR fileName, [optional]VARIANT includeRunData); - [id(20)] BSTR getPageType(long page); - [id(21)] void fromXMLFile(BSTR fileName, [optional]VARIANT root); - [id(22)] BSTR toXML([optional]VARIANT includeRunData); - [id(23)] void fromXML(BSTR xml, [optional] VARIANT root); - [id(24)] void getMenuItems(LPDISPATCH iPHXMenuItem); - [id(25)] void invokeMenuItem(long id); - [id(26)] boolean isMenuItemEnabled(long id); - [id(29)] void updateThumbHint(long id); - [id(30)] void fromCenterLink(BSTR server, BSTR runMatrixID, BSTR userName, BSTR password); - [id(31)] BSTR getPageSetup(long page); - [id(32)] void exportImage(long page, BSTR hints, BSTR filename); - [id(33)] boolean ignoreDefaultPlotSetup(); - [id(34)] void setupPlotsPre(); - [id(35)] void setupPlotsPost(); - [id(36)] void showGeomTooltip(long run, long x, long y); - [id(37)] void showGeomViewer(long run, long x, long y); - [id(38)] void updateGeomViewerHint(long viewerID); - [id(39)] void setGeomViewerRunID(long viewerID, long runID); - [id(40)] void updateComparisonViewHint(BOOL restore); - [id(41)] boolean isMenuItemChecked(long id); - [id(42)] void removeFromComparisonList(long runID); - [id(43)] void addToComparisonList(long runID); - [id(44)] void addRunsToComparisonList(VARIANT runIDs); - [id(45)] boolean getDaXType(); - [id(46)] boolean getDaXFormat(); - [id(47)] void ensureRunDataAction(); - [id(48)] void multiPageCut(VARIANT index); - [id(49)] void multiPageCopy(VARIANT index); - [id(50)] void multiDelete(VARIANT index); - [id(51)] IDispatch* getKeepalive(); - [id(52)] long getHWND(); - [id(53)] void loadTemplate( BSTR str); - [id(54)] void saveTemplate( BSTR str); - [id(55)] void toXMLSaveContext(LPDISPATCH saveContext, [optional] VARIANT includeRunData); - [id(56)] void fromXMLSaveContext(LPDISPATCH saveContext, [optional] VARIANT root); - [id(57)] void show(); - [id(58)] void hide(); - [id(59), propget] boolean isVisible(); - [id(62)] BSTR getPageTitle(long page); - //}}AFX_ODL_METHOD - //}}AFX_ODL_METHOD - }; - -#ifndef DOXYGEN_SHOULD_SKIP_THIS // hide from documentation - // Event dispatch interface for CPHXDataExplorerCtrl - - [ uuid(3D2E8CB8-81A2-46EA-86F8-850D4CCC5905), - helpstring("Event interface for PHXDataExplorer Control") ] - dispinterface _DPHXDataExplorerEvents - { - properties: - // Event interface has no properties - - methods: - // NOTE - ClassWizard will maintain event information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_EVENT(CPHXDataExplorerCtrl) - //}}AFX_ODL_EVENT - }; - - // Class information for CPHXDataExplorerCtrl - - [ uuid(FA0DBB7C-BEB1-4950-AC2A-E479C1D9FFE7), - helpstring("PHXDataExplorer Control"), control ] - coclass PHXDataExplorer - { - [default] dispinterface _DPHXDataExplorer; - [default, source] dispinterface _DPHXDataExplorerEvents; - }; -#endif // DOXYGEN_SHOULD_SKIP_THIS - - - // Primary dispatch interface for PHXDataExplorerPointer - [ uuid(EF05817D-2113-4F01-901F-569BB83EE42A) ] - dispinterface IPHXDataExplorerPointer - { - properties: - // NOTE - ClassWizard will maintain property information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_PROP(PHXDataExplorerPointer) - //}}AFX_ODL_PROP - - methods: - // NOTE - ClassWizard will maintain method information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_METHOD(PHXDataExplorerPointer) - [id(1)] IDispatch* getDataExplorer(); - //}}AFX_ODL_METHOD - - }; - -#ifndef DOXYGEN_SHOULD_SKIP_THIS // hide from documentation - // Class information for PHXDataExplorerPointer - - [ uuid(3E03FBC4-FB2F-4B0E-B388-59B49861669D) ] - coclass PHXDataExplorerPointer - { - [default] dispinterface IPHXDataExplorerPointer; - }; - - - //{{AFX_APPEND_ODL}} - //}}AFX_APPEND_ODL}} - // Primary dispatch interface for PHXDEKeepalive - - [ uuid(C484FD38-0B9F-4191-868E-84E03B660F6C) ] - dispinterface IPHXDEKeepalive - { - properties: - methods: - }; -#endif // DOXYGEN_SHOULD_SKIP_THIS - -#ifndef DOXYGEN_SHOULD_SKIP_THIS // hide from documentation - // Primary dispatch interface for ICanHazDE - [ uuid(276713D7-E8E3-488C-80DA-70899430EA05), - helpstring("Data Explorer facade owner interface") ] - dispinterface IDataExplorerFacadeOwner - { - properties: - [id(1978)] IDispatch* dataExplorerFacade; - - methods: - - }; -#endif // DOXYGEN_SHOULD_SKIP_THIS - - [ uuid(A1ED8D1C-717D-42D9-B02C-11326F5572B6), - helpstring("Page visibility interface") ] - dispinterface IPageVisibility - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS // hide from documentation - properties: -#endif - methods: - [id(1992)] void hide(long index); - - [id(1993)] void show(long index); - - [id(1994)] boolean isVisible(long index); - - [id(1995)] long getDataViewHWND(); - - [id(1996)] long getViewHWND(long index); - } - -#ifndef DOXYGEN_SHOULD_SKIP_THIS // hide from documentation - [ uuid(39E431DC-BFD2-4BE5-9BC9-5D9126975369), - helpstring("Legacy visibility interface") ] - dispinterface ILegacyVisiblity - { - properties: - methods: - [id(2000)] void showLegacy(); - - [id(2001)] long getLegacyHWND(); - } -#endif -}; -``` - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# File PHXDataExplorer.odl + +![][IDL] + +**Location**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` + + + + + +## Classes + +* [PHXDATAEXPLORERLib::\_DPHXDataExplorer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer) +* [PHXDATAEXPLORERLib::\_DPHXDataExplorerEvents](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents) +* [PHXDATAEXPLORERLib::PHXDataExplorer](classPHXDATAEXPLORERLib_1_1PHXDataExplorer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorer) +* [PHXDATAEXPLORERLib::IPHXDataExplorerPointer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer) +* [PHXDATAEXPLORERLib::PHXDataExplorerPointer](classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer) +* [PHXDATAEXPLORERLib::IPHXDEKeepalive](interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive.md#interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive) +* [PHXDATAEXPLORERLib::IDataExplorerFacadeOwner](interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner.md#interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner) +* [PHXDATAEXPLORERLib::IPageVisibility](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility) +* [PHXDATAEXPLORERLib::ILegacyVisiblity](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity) + +## Namespaces + +* [PHXDATAEXPLORERLib](namespacePHXDATAEXPLORERLib.md#namespacePHXDATAEXPLORERLib) + +## Includes + +* +* + +```mermaid +graph LR +1["LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl"] +click 1 "PHXDataExplorer_8odl.md#PHXDataExplorer_8odl" +1 --> 2 +1 --> 3 + +3["idispids.h"] + +2["olectl.h"] + +``` + +## Source + +``` +// PHXDataExplorer.odl : type library source for ActiveX Control project. + +// This file will be processed by the Make Type Library (mktyplib) tool to +// produce the type library (PHXDataExplorer.tlb) that will become a resource in +// PHXDataExplorer.ocx. + +[ uuid(091E15A1-980A-4B43-AD02-91DFD8144D7E), version(2.0), + helpfile("PHXDataExplorer.hlp"), + helpstring("PHXDataExplorer ActiveX Control module"), + control ] +library PHXDATAEXPLORERLib +{ + #include + #include + #include "olectl.h" + + importlib(STDOLE_TLB); + importlib(STDTYPE_TLB); + + // Primary dispatch interface for CPHXDataExplorer + + [ uuid(14375246-E4A1-4A30-85B2-0DF991B4FFB1), + helpstring("Dispatch interface for PHXDataExplorer Control"), hidden ] +#ifndef DOXYGEN_SHOULD_SKIP_THIS // so that _DPHXDataExplorer appears as PHXDataExplorer in documentation + dispinterface _DPHXDataExplorer + { + properties: +#else + dispinterface PHXDataExplorer + { + methods: +#endif + // NOTE - ClassWizard will maintain property information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_PROP(CPHXDataExplorerCtrl) + [id(1)] BSTR author; + [id(2)] BSTR description; + [id(3)] BSTR displayName; + [id(4)] IDispatch* modelCenter; + [id(5)] BSTR tradeStudyType; + [id(6)] IDispatch* dataHistory; + [id(7)] BSTR tradeStudySetup; + [id(27)] BSTR associatedModelFile; + [id(28)] BSTR associatedModelFileUUID; + [id(60)] BSTR creationDate; + + [id(61)] BSTR tradeStudyUri; + //}}AFX_ODL_PROP + + methods: + // NOTE - ClassWizard will maintain method information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_METHOD(CPHXDataExplorerCtrl) + [id(8)] long getNumPages(); + [id(9)] IDispatch* getPage(long page); + [id(10)] IDispatch* addPage(BSTR type, VARIANT insertBefore, VARIANT setupString); + [id(11)] void removePage(long page); + [id(12)] void movePage(long page, long insertBefore); + [id(13)] void selectPage(long page); + [id(14)] long getSelectedPage(); + [id(15)] void pageCut(long index); + [id(16)] void pageCopy(long index); + [id(17)] void pagePaste(); + [id(18)] void invokeInsertPageGUI(); + [id(19)] void toXMLFile(BSTR fileName, [optional]VARIANT includeRunData); + [id(20)] BSTR getPageType(long page); + [id(21)] void fromXMLFile(BSTR fileName, [optional]VARIANT root); + [id(22)] BSTR toXML([optional]VARIANT includeRunData); + [id(23)] void fromXML(BSTR xml, [optional] VARIANT root); + [id(24)] void getMenuItems(LPDISPATCH iPHXMenuItem); + [id(25)] void invokeMenuItem(long id); + [id(26)] boolean isMenuItemEnabled(long id); + [id(29)] void updateThumbHint(long id); + [id(30)] void fromCenterLink(BSTR server, BSTR runMatrixID, BSTR userName, BSTR password); + [id(31)] BSTR getPageSetup(long page); + [id(32)] void exportImage(long page, BSTR hints, BSTR filename); + [id(33)] boolean ignoreDefaultPlotSetup(); + [id(34)] void setupPlotsPre(); + [id(35)] void setupPlotsPost(); + [id(36)] void showGeomTooltip(long run, long x, long y); + [id(37)] void showGeomViewer(long run, long x, long y); + [id(38)] void updateGeomViewerHint(long viewerID); + [id(39)] void setGeomViewerRunID(long viewerID, long runID); + [id(40)] void updateComparisonViewHint(BOOL restore); + [id(41)] boolean isMenuItemChecked(long id); + [id(42)] void removeFromComparisonList(long runID); + [id(43)] void addToComparisonList(long runID); + [id(44)] void addRunsToComparisonList(VARIANT runIDs); + [id(45)] boolean getDaXType(); + [id(46)] boolean getDaXFormat(); + [id(47)] void ensureRunDataAction(); + [id(48)] void multiPageCut(VARIANT index); + [id(49)] void multiPageCopy(VARIANT index); + [id(50)] void multiDelete(VARIANT index); + [id(51)] IDispatch* getKeepalive(); + [id(52)] long getHWND(); + [id(53)] void loadTemplate( BSTR str); + [id(54)] void saveTemplate( BSTR str); + [id(55)] void toXMLSaveContext(LPDISPATCH saveContext, [optional] VARIANT includeRunData); + [id(56)] void fromXMLSaveContext(LPDISPATCH saveContext, [optional] VARIANT root); + [id(57)] void show(); + [id(58)] void hide(); + [id(59), propget] boolean isVisible(); + [id(62)] BSTR getPageTitle(long page); + //}}AFX_ODL_METHOD + //}}AFX_ODL_METHOD + }; + +#ifndef DOXYGEN_SHOULD_SKIP_THIS // hide from documentation + // Event dispatch interface for CPHXDataExplorerCtrl + + [ uuid(3D2E8CB8-81A2-46EA-86F8-850D4CCC5905), + helpstring("Event interface for PHXDataExplorer Control") ] + dispinterface _DPHXDataExplorerEvents + { + properties: + // Event interface has no properties + + methods: + // NOTE - ClassWizard will maintain event information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_EVENT(CPHXDataExplorerCtrl) + //}}AFX_ODL_EVENT + }; + + // Class information for CPHXDataExplorerCtrl + + [ uuid(FA0DBB7C-BEB1-4950-AC2A-E479C1D9FFE7), + helpstring("PHXDataExplorer Control"), control ] + coclass PHXDataExplorer + { + [default] dispinterface _DPHXDataExplorer; + [default, source] dispinterface _DPHXDataExplorerEvents; + }; +#endif // DOXYGEN_SHOULD_SKIP_THIS + + + // Primary dispatch interface for PHXDataExplorerPointer + [ uuid(EF05817D-2113-4F01-901F-569BB83EE42A) ] + dispinterface IPHXDataExplorerPointer + { + properties: + // NOTE - ClassWizard will maintain property information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_PROP(PHXDataExplorerPointer) + //}}AFX_ODL_PROP + + methods: + // NOTE - ClassWizard will maintain method information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_METHOD(PHXDataExplorerPointer) + [id(1)] IDispatch* getDataExplorer(); + //}}AFX_ODL_METHOD + + }; + +#ifndef DOXYGEN_SHOULD_SKIP_THIS // hide from documentation + // Class information for PHXDataExplorerPointer + + [ uuid(3E03FBC4-FB2F-4B0E-B388-59B49861669D) ] + coclass PHXDataExplorerPointer + { + [default] dispinterface IPHXDataExplorerPointer; + }; + + + //{{AFX_APPEND_ODL}} + //}}AFX_APPEND_ODL}} + // Primary dispatch interface for PHXDEKeepalive + + [ uuid(C484FD38-0B9F-4191-868E-84E03B660F6C) ] + dispinterface IPHXDEKeepalive + { + properties: + methods: + }; +#endif // DOXYGEN_SHOULD_SKIP_THIS + +#ifndef DOXYGEN_SHOULD_SKIP_THIS // hide from documentation + // Primary dispatch interface for ICanHazDE + [ uuid(276713D7-E8E3-488C-80DA-70899430EA05), + helpstring("Data Explorer facade owner interface") ] + dispinterface IDataExplorerFacadeOwner + { + properties: + [id(1978)] IDispatch* dataExplorerFacade; + + methods: + + }; +#endif // DOXYGEN_SHOULD_SKIP_THIS + + [ uuid(A1ED8D1C-717D-42D9-B02C-11326F5572B6), + helpstring("Page visibility interface") ] + dispinterface IPageVisibility + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS // hide from documentation + properties: +#endif + methods: + [id(1992)] void hide(long index); + + [id(1993)] void show(long index); + + [id(1994)] boolean isVisible(long index); + + [id(1995)] long getDataViewHWND(); + + [id(1996)] long getViewHWND(long index); + } + +#ifndef DOXYGEN_SHOULD_SKIP_THIS // hide from documentation + [ uuid(39E431DC-BFD2-4BE5-9BC9-5D9126975369), + helpstring("Legacy visibility interface") ] + dispinterface ILegacyVisiblity + { + properties: + methods: + [id(2000)] void showLegacy(); + + [id(2001)] long getLegacyHWND(); + } +#endif +}; +``` + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/PHXDataHistory_8odl.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/PHXDataHistory_8odl.md index d6cef7c065..30aebae4e2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/PHXDataHistory_8odl.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/PHXDataHistory_8odl.md @@ -1,470 +1,469 @@ - -# File PHXDataHistory.odl - -![][IDL] - -**Location**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` - - - - - -## Classes - -* [PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct) -* [PHXDATAHISTORYLib::DataHistoryVariableStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct) -* [PHXDATAHISTORYLib::\_DPHXDataHistory](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory) -* [PHXDATAHISTORYLib::\_DPHXDataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel) -* [PHXDATAHISTORYLib::\_DPHXDataHistoryEvents](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents) -* [PHXDATAHISTORYLib::PHXDataHistory](classPHXDATAHISTORYLib_1_1PHXDataHistory.md#classPHXDATAHISTORYLib_1_1PHXDataHistory) -* [PHXDATAHISTORYLib::DataHistoryVariableMetadata](classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata.md#classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata) -* [PHXDATAHISTORYLib::PHXDataExplorerPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) -* [PHXDATAHISTORYLib::PHXDataExplorerExportPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn) -* [PHXDATAHISTORYLib::IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) -* [PHXDATAHISTORYLib::IPHXMenuItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems) -* [PHXDATAHISTORYLib::ISaveContext](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext) - -## Namespaces - -* [PHXDATAHISTORYLib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib) - -## Includes - -* -* - -```mermaid -graph LR -1["LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl"] -click 1 "PHXDataHistory_8odl.md#PHXDataHistory_8odl" -1 --> 2 -1 --> 3 - -3["idispids.h"] - -2["olectl.h"] - -``` - -## Source - -``` -// PHXDataHistory.odl : type library source for ActiveX Control project. - -// This file will be processed by the Make Type Library (mktyplib) tool to -// produce the type library (PHXDataHistory.tlb) that will become a resource in -// PHXDataHistory.ocx. - -[ uuid(39BAE22B-3E29-4DC7-A37B-13B5611B0033), version(2.0), - helpfile("PHXDataHistory.hlp"), - helpstring("PHXDataHistory ActiveX Control module"), - control ] -library PHXDATAHISTORYLib -{ - #include - #include - - importlib(STDOLE_TLB); - importlib(STDTYPE_TLB); - - //There is a wrapper class for this struct in DataHistoryDataStructures::DataHistorySmartPointers - // the wrapper needs to be kept up to date with any canges made here. - [uuid(8671f043-8be7-4c75-b2ae-ccd193d164a9)] - typedef struct - { - BSTR name; - boolean isNumeric; - boolean isInput; - boolean isBinary; - boolean isDesignVar; - BSTR equation; - BSTR format; - BSTR type; - BSTR units; - BSTR fileName; - BSTR geomScript; - BSTR enumValues; - BSTR enumAliases; - VARIANT lowerBound; - VARIANT upperBound; - VARIANT customMetadata; - } DataHistoryVariableMetadataStruct; - - //There is a wrapper class for this struct in DataHistoryDataStructures::DataHistorySmartPointers - // the wrapper needs to be kept up to date with any canges made here. - [uuid(888728e8-b042-4c38-82e3-68765738116a)] - typedef struct - { - VARIANT index; - VARIANT varValue; - boolean isValid; - boolean isModified; - DataHistoryVariableMetadataStruct metadata; - } DataHistoryVariableStruct; - - - // Primary dispatch interface for CPHXDataHistoryCtrl - [ uuid(76DF9BEB-B18B-4E42-8FA3-88D3C14C9344), - helpstring("Dispatch interface for PHXDataHistory Control"), hidden ] -#ifndef DOXYGEN_SHOULD_SKIP_THIS // so that _DPHXDataHistory appears as PHXDataHistory in documentation - dispinterface _DPHXDataHistory - { - properties: -#else - dispinterface PHXDataHistory - { - methods: -#endif - // NOTE - ClassWizard will maintain property information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_PROP(CPHXDataHistoryCtrl) - [id(1)] BSTR suggestedIndependantVar; - [id(80)] BSTR suggestedIndependentVar; - [id(2)] VARIANT suggestedDependentVars; - [id(30)] long suggestedCountFrom; - [id(37)] IDispatch* dataExplorerPointer; - [id(38)] boolean settingRun; - [id(40)] BSTR centerLinkServer; - [id(41)] BSTR centerLinkRunMatrixID; - [id(42)] BSTR centerLinkJobConnector; - [id(43)] BSTR centerLinkQueue; - [id(64)] LPDISPATCH dataHistoryToModel; - [id(78)] boolean warmStartStudyComplete; - [id(79)] BSTR tradeStudyModelFile; - //}}AFX_ODL_PROP - - methods: - // NOTE - ClassWizard will maintain method information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_METHOD(CPHXDataHistoryCtrl) - [id(3)] void addVariable(LPDISPATCH var); - [id(4)] void setNumExpectedRuns(long numRuns); - [id(5)] void startRuns(); - [id(6)] void endRuns(); - [id(7)] long getNumFailedRuns(); - [id(8)] long getErrorID(long run); - [id(9)] BSTR getErrorMessage(long run); - [id(10)] void setError(long run, long errorID, BSTR message); - [id(11)] long getNumRuns(); - [id(12)] long getNumVariables(); - [id(13)] void setResult(VARIANT index, long run, VARIANT value, boolean valid, boolean modified); - [id(14)] VARIANT getValue(VARIANT index, long run); - [id(15)] boolean isValid(VARIANT index, long run); - [id(16)] boolean isModified(VARIANT index, long run); - [id(17)] void toCSVFile(BSTR fileName, [optional] VARIANT variablesInRows, [optional] VARIANT includeFailed); - [id(18)] BSTR toXML([optional]VARIANT includeRunData); - [id(19)] void toXMLFile(BSTR fileName, [optional]VARIANT includeRunData); - [id(20)] void fromXML(BSTR xmlStr, [optional] VARIANT root); - [id(21)] void fromXMLFile(BSTR fileName, [optional] VARIANT root); - [id(22)] BSTR toCSV([optional] VARIANT variablesInRows, [optional] VARIANT includeFailed); - [id(23)] long getNumNonEmptyRuns(); - [id(24)] IDispatch* getVariable(VARIANT index); - [id(25)] IDispatch* createVariable(); - [id(26)] boolean isRunning(); - [id(27)] long getNumExpectedRuns(); - [id(28)] BSTR getRunName(long runNum); - [id(29)] void setRunName(long runNum, BSTR name); - [id(31)] void insertRun(long insertBefore); - [id(32)] void deleteRun(long run); - [id(33)] void deleteVariable(VARIANT index); - [id(34)] BSTR getFormattedValue(VARIANT index, long run); - [id(35)] void setFormattedResult(VARIANT index, long run, BSTR value, boolean valid, boolean modified); - [id(36)] long getNumCustomVars(); - [id(39)] void fromCenterLink(BSTR serverName, BSTR runMatrixID, BSTR userName, BSTR password); - [id(44)] long getUniqueID(); - [id(45)] VARIANT getVariableValues(VARIANT index); - [id(46)] long createDesignVariable(VARIANT index); - [id(47)] void addVariableAt(LPDISPATCH var, long location); - [id(48)] void setVariableValues(VARIANT index, long run, VARIANT values, boolean valid, boolean modified); - [id(49)] void setUsernamePassword(BSTR username, BSTR password); - [id(50)] boolean isHighlighted(long run); - [id(51)] void highlight(long run, boolean highlight, boolean handleEvent); - [id(52)] void setResultAsFile(VARIANT index, long run, boolean valid, boolean modified, BSTR tempFileName, BSTR tempFileDir); - [id(53)] long getNumDesignVariables(); - [id(54)] BSTR getDatabaseFile(); - [id(55)] void setDatabaseFile(BSTR filename); - [id(56)] void removeAutosave(); - [id(57)] void setTradeStudySetup(BSTR setup); - [id(58)] BSTR getTradeStudySetup(); - [id(59)] void setTradeStudyType(BSTR type); - [id(60)] BSTR getTradeStudyType(); - [id(61)] void setShortVariableNames( boolean shortenVariableNames ); - [id(62)] IDispatch* getVariable2(VARIANT index); - [id(63)] BSTR getVariableTempDir(VARIANT index); - - [id(65)] void setRunValues(long run, VARIANT values, BOOL valid, BOOL modified); - [id(66)] VARIANT getFailedRunIndexes(); - [id(67)] void toXMLSaveContext(LPDISPATCH saveContext, [optional] VARIANT includeRunData); - [id(68)] void fromXMLSaveContext(LPDISPATCH saveContext, [optional] VARIANT root); - [id(69)] VARIANT getCompletedRunIndices(); - [id(70)] boolean isRunComplete(long run); - [id(73)] void addCheckpoint(long runNumber, BSTR value); - [id(74)] long getNumCheckpoints(); - [id(76)] BSTR getCheckpointValue(long checkpointIndex); - [id(77)] long getCheckpointRunNumber(long checkpointIndex); - - // NOTE (KMC): We want to skip this documentation since this method is public for COM, but we don't want our - //users to be really be doing this. This was per Nathan's advice. -#ifndef DOXYGEN_SHOULD_SKIP_THIS -#endif - [id(81)] void setUniqueID(long identifier); - - [id(82)] long getNumCompletedRuns(); - -#ifndef DOXYGEN_SHOULD_SKIP_THIS - [id(83)] ULONG getCompletedRunData( - [out] VARIANT* runIDs, - [out] VARIANT* errorIDs, - [out] VARIANT* errorMessages, - [out] VARIANT* variableValues, - [out] LONG* endSequenceNumber, - [in, defaultvalue(0)] ULONG startSequenceNumber, - [in, defaultvalue(0xFFFFFFFF)] ULONG maxLength, - [in, defaultvalue(FALSE)] boolean allVariables); -#else - [id(83)] ULONG getCompletedRunData( - [out] VARIANT* runIDs, - [out] VARIANT* errorIDs, - [out] VARIANT* errorMessages, - [out] VARIANT* variableValues, - [out] LONG* endSequenceNumber, - [in] ULONG startSequenceNumber = 0, - [in] ULONG maxLength = ULONG_MAX, - [in] boolean allVariables = false); -#endif - [id(84)] VARIANT getHighlightedRuns(); - - [id(85)] void setHighlightedRuns(VARIANT selectedRunIndices); - - [id(86)] void addVariableStructs(VARIANT dhVarStructs, long run); - - - //}}AFX_ODL_METHOD - }; - - // Primary dispatch interface for CPHXDataHistoryToModelCtrl - [ uuid(80412376-d61e-416a-8df1-26cf2c4ec732), - helpstring("Dispatch interface for PHXDataHistoryToModel control")] -#ifndef DOXYGEN_SHOULD_SKIP_THIS // so that _DPHXDataHistoryToModel appears as PHXDataHistoryToModel in documentation - dispinterface _DPHXDataHistoryToModel - { - properties: -#else - dispinterface PHXDataHistoryToModel - { - methods: -#endif - // NOTE - ClassWizard will maintain property information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_PROP(CPHXDataHistoryToModelCtrl) - - // add property definitions here - - //}}AFX_ODL_PROP - - methods: - // NOTE - ClassWizard will maintain method information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_METHOD(CPHXDataHistoryToModelCtrl) - - [id(1)] BOOL canSaveToModel(LPDISPATCH dataHistory, long run); - - [id(2)] void saveToModel(LPDISPATCH dataHistory, long run); - - [id(3)] BOOL canRerunRuns(LPDISPATCH dataHistory, VARIANT runs); - - [id(4)] void rerunRuns(LPDISPATCH dataHistory, VARIANT runs); - - [id(5)] void closeDataHistory(LPDISPATCH dataHistory); - - //}}AFX_ODL_METHOD - }; - - - // Event dispatch interface for CPHXDataHistoryCtrl - [ uuid(799E1901-5409-45C6-ACEA-0255FE4BD3C4), - helpstring("Event interface for PHXDataHistory Control") ] -#ifndef DOXYGEN_SHOULD_SKIP_THIS - dispinterface _DPHXDataHistoryEvents -#else - dispinterface PHXDataHistoryEvents -#endif - { - properties: - // Event interface has no properties - - methods: - // NOTE - ClassWizard will maintain event information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_EVENT(CPHXDataHistoryCtrl) - [id(1)] void variablesChanged(); - [id(2)] void progressMeterChange(long completed, long total); - [id(3)] void progressMeterStart(); - [id(4)] void progressMeterStop(); - [id(5)] void dataChanged(long varIndex, long runIndex); - [id(6)] void progressMeterEstimate(long estimate); - [id(7)] void highlightChanged(long runIndex, boolean highlight, boolean handleEvent); - - //}}AFX_ODL_EVENT - }; - -#ifndef DOXYGEN_SHOULD_SKIP_THIS - - // Class information for CPHXDataHistoryCtrl - - [ uuid(1636E131-1E51-4C6A-B31D-5E6D691C57C9), - helpstring("PHXDataHistory Control"), control ] - coclass PHXDataHistory - { - [default] dispinterface _DPHXDataHistory; - [default, source] dispinterface _DPHXDataHistoryEvents; - }; - - [ uuid(CA4F77A7-2265-48B5-AFAB-F2F2E0F02F91) ] - coclass DataHistoryVariableMetadata - { - [default] dispinterface IDHVariable; - }; - -#endif - - - [ uuid(14375246-E4A1-4A30-85B2-0DF991B4FFB2), - helpstring("Dispatch interface for a PHXDataExplorer Plugin") ] - dispinterface PHXDataExplorerPlugIn - { - properties: - - methods: - [id(6)] LPDISPATCH getDataHistory(); - [id(7)] void setDataHistory(LPDISPATCH dataHistory); - [id(8)] LPDISPATCH getModelCenter(); - [id(9)] void setModelCenter(LPDISPATCH modelCenter); - [id(10)] BSTR getPageTitle(); - [id(11)] BSTR toString(); - [id(12)] void fromString(BSTR str); - [id(13)] void getMenuItems(LPDISPATCH iPHXMenuItem); - [id(14)] void invokeMenuItem(long id); - [id(15)] boolean isMenuItemEnabled(long id); - [id(16)] boolean updateHint(); - [id(17)] void setStartContext(BSTR str); - [id(18)] BSTR getThumbnail(BSTR hints); - } - - [ uuid(32A29C04-BB5C-4029-92AB-3DFC5C7B72A2), - helpstring("Dispatch interface for a PHXDataExplorer Plugin that provides custom image export") ] - dispinterface PHXDataExplorerExportPlugIn - { - properties: - - methods: - [id(18)] void exportImage(BSTR hints, BSTR filename); - } - - typedef enum { - PHXMENU_CUT=-1, - PHXMENU_COPY=-2, - PHXMENU_PASTE=-3, - PHXMENU_DELETE=-4, - PHXMENU_PAGESETTINGS=-5, - PHXMENU_PRINT=-6, - PHXMENU_EXPORT=-7, - PHXMENU_TOOLTIP=-8 - } PHXMENU_PREDEFS; - - - // Primary dispatch interface for DataHistoryVariableMetadata - [ uuid(4BA85B03-92CA-4CFF-96CE-6E2D10365C9D) ] - dispinterface IDHVariable - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // NOTE - ClassWizard will maintain property information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_PROP(IDHVariable) - [id(1)] BSTR name; - [id(2)] BSTR equation; - [id(3)] boolean isDesignVar; - [id(4)] boolean isNumeric; - [id(5)] boolean isInput; - [id(6)] BSTR format; - [id(7)] BSTR enumValues; - [id(8)] BSTR enumAliases; - [id(9)] VARIANT lowerBound; - [id(10)] VARIANT upperBound; - [id(11)] BSTR type; - [id(12)] BSTR units; - [id(17)] BSTR geomScript; - [id(18)] boolean isBinary; - [id(19)] BSTR fileName; - //}}AFX_ODL_PROP - - methods: - // NOTE - ClassWizard will maintain method information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_METHOD(IDHVariable) - [id(13)] long getNumEnumValues(); - [id(14)] BSTR getEnumValue(long index); - [id(15)] BSTR getEnumAlias(long index); - [id(16)] long getNumEnumAliases(); - [id(20)] void setMetaData(BSTR key, BSTR value); - [id(21)] BSTR getMetaData(BSTR key); - [id(22)] SAFEARRAY(BSTR) getMetaDataKeys(); - - [id(23)] void copyFrom(LPDISPATCH other); - - [id(24)] void removeMetadata(BSTR key); - - //}}AFX_ODL_METHOD - }; - - [ uuid(901e602e-d00e-4efc-a71e-10c554170747) ] - dispinterface IPHXMenuItems - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - [id(1)] long numItems; - - methods: - [id(2)] void setMenuItem(long index, BSTR name, BSTR description); - [id(3)] BSTR getMenuItemName(long index); - [id(4)] BSTR getMenuItemDescription(long index); - }; - - // -------------------------------------------------------------- ISaveContext - [ uuid(3CD8CED0-4519-40C9-8FA6-A60A11011D2D), - helpstring("SaveContext") ] - dispinterface ISaveContext - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // properties go here - - methods: - [id(1)] boolean saveFile(BSTR sourceLocation, BSTR context); - [id(2)] boolean restoreFile(BSTR fileID, BSTR targetLocation); - [id(3)] void close(); - [id(4)] BSTR getSaveLocation(); - [id(5)] LPUNKNOWN saveFileStream(BSTR context); - [id(6)] LPUNKNOWN restoreFileStream(BSTR fileID); - [id(7)] int getFileFormat(); - [id(8)] void setFileFormat(int fileFormat); - }; - - //{{AFX_APPEND_ODL}} - //}}AFX_APPEND_ODL}} -}; -``` - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# File PHXDataHistory.odl + +![][IDL] + +**Location**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` + + + + + +## Classes + +* [PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct) +* [PHXDATAHISTORYLib::DataHistoryVariableStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct) +* [PHXDATAHISTORYLib::\_DPHXDataHistory](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory) +* [PHXDATAHISTORYLib::\_DPHXDataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel) +* [PHXDATAHISTORYLib::\_DPHXDataHistoryEvents](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents) +* [PHXDATAHISTORYLib::PHXDataHistory](classPHXDATAHISTORYLib_1_1PHXDataHistory.md#classPHXDATAHISTORYLib_1_1PHXDataHistory) +* [PHXDATAHISTORYLib::DataHistoryVariableMetadata](classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata.md#classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata) +* [PHXDATAHISTORYLib::PHXDataExplorerPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) +* [PHXDATAHISTORYLib::PHXDataExplorerExportPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn) +* [PHXDATAHISTORYLib::IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) +* [PHXDATAHISTORYLib::IPHXMenuItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems) +* [PHXDATAHISTORYLib::ISaveContext](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext) + +## Namespaces + +* [PHXDATAHISTORYLib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib) + +## Includes + +* +* + +```mermaid +graph LR +1["LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl"] +click 1 "PHXDataHistory_8odl.md#PHXDataHistory_8odl" +1 --> 2 +1 --> 3 + +3["idispids.h"] + +2["olectl.h"] + +``` + +## Source + +``` +// PHXDataHistory.odl : type library source for ActiveX Control project. + +// This file will be processed by the Make Type Library (mktyplib) tool to +// produce the type library (PHXDataHistory.tlb) that will become a resource in +// PHXDataHistory.ocx. + +[ uuid(39BAE22B-3E29-4DC7-A37B-13B5611B0033), version(2.0), + helpfile("PHXDataHistory.hlp"), + helpstring("PHXDataHistory ActiveX Control module"), + control ] +library PHXDATAHISTORYLib +{ + #include + #include + + importlib(STDOLE_TLB); + importlib(STDTYPE_TLB); + + //There is a wrapper class for this struct in DataHistoryDataStructures::DataHistorySmartPointers + // the wrapper needs to be kept up to date with any canges made here. + [uuid(8671f043-8be7-4c75-b2ae-ccd193d164a9)] + typedef struct + { + BSTR name; + boolean isNumeric; + boolean isInput; + boolean isBinary; + boolean isDesignVar; + BSTR equation; + BSTR format; + BSTR type; + BSTR units; + BSTR fileName; + BSTR geomScript; + BSTR enumValues; + BSTR enumAliases; + VARIANT lowerBound; + VARIANT upperBound; + VARIANT customMetadata; + } DataHistoryVariableMetadataStruct; + + //There is a wrapper class for this struct in DataHistoryDataStructures::DataHistorySmartPointers + // the wrapper needs to be kept up to date with any canges made here. + [uuid(888728e8-b042-4c38-82e3-68765738116a)] + typedef struct + { + VARIANT index; + VARIANT varValue; + boolean isValid; + boolean isModified; + DataHistoryVariableMetadataStruct metadata; + } DataHistoryVariableStruct; + + + // Primary dispatch interface for CPHXDataHistoryCtrl + [ uuid(76DF9BEB-B18B-4E42-8FA3-88D3C14C9344), + helpstring("Dispatch interface for PHXDataHistory Control"), hidden ] +#ifndef DOXYGEN_SHOULD_SKIP_THIS // so that _DPHXDataHistory appears as PHXDataHistory in documentation + dispinterface _DPHXDataHistory + { + properties: +#else + dispinterface PHXDataHistory + { + methods: +#endif + // NOTE - ClassWizard will maintain property information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_PROP(CPHXDataHistoryCtrl) + [id(1)] BSTR suggestedIndependantVar; + [id(80)] BSTR suggestedIndependentVar; + [id(2)] VARIANT suggestedDependentVars; + [id(30)] long suggestedCountFrom; + [id(37)] IDispatch* dataExplorerPointer; + [id(38)] boolean settingRun; + [id(40)] BSTR centerLinkServer; + [id(41)] BSTR centerLinkRunMatrixID; + [id(42)] BSTR centerLinkJobConnector; + [id(43)] BSTR centerLinkQueue; + [id(64)] LPDISPATCH dataHistoryToModel; + [id(78)] boolean warmStartStudyComplete; + [id(79)] BSTR tradeStudyModelFile; + //}}AFX_ODL_PROP + + methods: + // NOTE - ClassWizard will maintain method information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_METHOD(CPHXDataHistoryCtrl) + [id(3)] void addVariable(LPDISPATCH var); + [id(4)] void setNumExpectedRuns(long numRuns); + [id(5)] void startRuns(); + [id(6)] void endRuns(); + [id(7)] long getNumFailedRuns(); + [id(8)] long getErrorID(long run); + [id(9)] BSTR getErrorMessage(long run); + [id(10)] void setError(long run, long errorID, BSTR message); + [id(11)] long getNumRuns(); + [id(12)] long getNumVariables(); + [id(13)] void setResult(VARIANT index, long run, VARIANT value, boolean valid, boolean modified); + [id(14)] VARIANT getValue(VARIANT index, long run); + [id(15)] boolean isValid(VARIANT index, long run); + [id(16)] boolean isModified(VARIANT index, long run); + [id(17)] void toCSVFile(BSTR fileName, [optional] VARIANT variablesInRows, [optional] VARIANT includeFailed); + [id(18)] BSTR toXML([optional]VARIANT includeRunData); + [id(19)] void toXMLFile(BSTR fileName, [optional]VARIANT includeRunData); + [id(20)] void fromXML(BSTR xmlStr, [optional] VARIANT root); + [id(21)] void fromXMLFile(BSTR fileName, [optional] VARIANT root); + [id(22)] BSTR toCSV([optional] VARIANT variablesInRows, [optional] VARIANT includeFailed); + [id(23)] long getNumNonEmptyRuns(); + [id(24)] IDispatch* getVariable(VARIANT index); + [id(25)] IDispatch* createVariable(); + [id(26)] boolean isRunning(); + [id(27)] long getNumExpectedRuns(); + [id(28)] BSTR getRunName(long runNum); + [id(29)] void setRunName(long runNum, BSTR name); + [id(31)] void insertRun(long insertBefore); + [id(32)] void deleteRun(long run); + [id(33)] void deleteVariable(VARIANT index); + [id(34)] BSTR getFormattedValue(VARIANT index, long run); + [id(35)] void setFormattedResult(VARIANT index, long run, BSTR value, boolean valid, boolean modified); + [id(36)] long getNumCustomVars(); + [id(39)] void fromCenterLink(BSTR serverName, BSTR runMatrixID, BSTR userName, BSTR password); + [id(44)] long getUniqueID(); + [id(45)] VARIANT getVariableValues(VARIANT index); + [id(46)] long createDesignVariable(VARIANT index); + [id(47)] void addVariableAt(LPDISPATCH var, long location); + [id(48)] void setVariableValues(VARIANT index, long run, VARIANT values, boolean valid, boolean modified); + [id(49)] void setUsernamePassword(BSTR username, BSTR password); + [id(50)] boolean isHighlighted(long run); + [id(51)] void highlight(long run, boolean highlight, boolean handleEvent); + [id(52)] void setResultAsFile(VARIANT index, long run, boolean valid, boolean modified, BSTR tempFileName, BSTR tempFileDir); + [id(53)] long getNumDesignVariables(); + [id(54)] BSTR getDatabaseFile(); + [id(55)] void setDatabaseFile(BSTR filename); + [id(56)] void removeAutosave(); + [id(57)] void setTradeStudySetup(BSTR setup); + [id(58)] BSTR getTradeStudySetup(); + [id(59)] void setTradeStudyType(BSTR type); + [id(60)] BSTR getTradeStudyType(); + [id(61)] void setShortVariableNames( boolean shortenVariableNames ); + [id(62)] IDispatch* getVariable2(VARIANT index); + [id(63)] BSTR getVariableTempDir(VARIANT index); + + [id(65)] void setRunValues(long run, VARIANT values, BOOL valid, BOOL modified); + [id(66)] VARIANT getFailedRunIndexes(); + [id(67)] void toXMLSaveContext(LPDISPATCH saveContext, [optional] VARIANT includeRunData); + [id(68)] void fromXMLSaveContext(LPDISPATCH saveContext, [optional] VARIANT root); + [id(69)] VARIANT getCompletedRunIndices(); + [id(70)] boolean isRunComplete(long run); + [id(73)] void addCheckpoint(long runNumber, BSTR value); + [id(74)] long getNumCheckpoints(); + [id(76)] BSTR getCheckpointValue(long checkpointIndex); + [id(77)] long getCheckpointRunNumber(long checkpointIndex); + + // NOTE (KMC): We want to skip this documentation since this method is public for COM, but we don't want our + //users to be really be doing this. This was per Nathan's advice. +#ifndef DOXYGEN_SHOULD_SKIP_THIS +#endif + [id(81)] void setUniqueID(long identifier); + + [id(82)] long getNumCompletedRuns(); + +#ifndef DOXYGEN_SHOULD_SKIP_THIS + [id(83)] ULONG getCompletedRunData( + [out] VARIANT* runIDs, + [out] VARIANT* errorIDs, + [out] VARIANT* errorMessages, + [out] VARIANT* variableValues, + [out] LONG* endSequenceNumber, + [in, defaultvalue(0)] ULONG startSequenceNumber, + [in, defaultvalue(0xFFFFFFFF)] ULONG maxLength, + [in, defaultvalue(FALSE)] boolean allVariables); +#else + [id(83)] ULONG getCompletedRunData( + [out] VARIANT* runIDs, + [out] VARIANT* errorIDs, + [out] VARIANT* errorMessages, + [out] VARIANT* variableValues, + [out] LONG* endSequenceNumber, + [in] ULONG startSequenceNumber = 0, + [in] ULONG maxLength = ULONG_MAX, + [in] boolean allVariables = false); +#endif + [id(84)] VARIANT getHighlightedRuns(); + + [id(85)] void setHighlightedRuns(VARIANT selectedRunIndices); + + [id(86)] void addVariableStructs(VARIANT dhVarStructs, long run); + + + //}}AFX_ODL_METHOD + }; + + // Primary dispatch interface for CPHXDataHistoryToModelCtrl + [ uuid(80412376-d61e-416a-8df1-26cf2c4ec732), + helpstring("Dispatch interface for PHXDataHistoryToModel control")] +#ifndef DOXYGEN_SHOULD_SKIP_THIS // so that _DPHXDataHistoryToModel appears as PHXDataHistoryToModel in documentation + dispinterface _DPHXDataHistoryToModel + { + properties: +#else + dispinterface PHXDataHistoryToModel + { + methods: +#endif + // NOTE - ClassWizard will maintain property information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_PROP(CPHXDataHistoryToModelCtrl) + + // add property definitions here + + //}}AFX_ODL_PROP + + methods: + // NOTE - ClassWizard will maintain method information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_METHOD(CPHXDataHistoryToModelCtrl) + + [id(1)] BOOL canSaveToModel(LPDISPATCH dataHistory, long run); + + [id(2)] void saveToModel(LPDISPATCH dataHistory, long run); + + [id(3)] BOOL canRerunRuns(LPDISPATCH dataHistory, VARIANT runs); + + [id(4)] void rerunRuns(LPDISPATCH dataHistory, VARIANT runs); + + [id(5)] void closeDataHistory(LPDISPATCH dataHistory); + + //}}AFX_ODL_METHOD + }; + + + // Event dispatch interface for CPHXDataHistoryCtrl + [ uuid(799E1901-5409-45C6-ACEA-0255FE4BD3C4), + helpstring("Event interface for PHXDataHistory Control") ] +#ifndef DOXYGEN_SHOULD_SKIP_THIS + dispinterface _DPHXDataHistoryEvents +#else + dispinterface PHXDataHistoryEvents +#endif + { + properties: + // Event interface has no properties + + methods: + // NOTE - ClassWizard will maintain event information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_EVENT(CPHXDataHistoryCtrl) + [id(1)] void variablesChanged(); + [id(2)] void progressMeterChange(long completed, long total); + [id(3)] void progressMeterStart(); + [id(4)] void progressMeterStop(); + [id(5)] void dataChanged(long varIndex, long runIndex); + [id(6)] void progressMeterEstimate(long estimate); + [id(7)] void highlightChanged(long runIndex, boolean highlight, boolean handleEvent); + + //}}AFX_ODL_EVENT + }; + +#ifndef DOXYGEN_SHOULD_SKIP_THIS + + // Class information for CPHXDataHistoryCtrl + + [ uuid(1636E131-1E51-4C6A-B31D-5E6D691C57C9), + helpstring("PHXDataHistory Control"), control ] + coclass PHXDataHistory + { + [default] dispinterface _DPHXDataHistory; + [default, source] dispinterface _DPHXDataHistoryEvents; + }; + + [ uuid(CA4F77A7-2265-48B5-AFAB-F2F2E0F02F91) ] + coclass DataHistoryVariableMetadata + { + [default] dispinterface IDHVariable; + }; + +#endif + + + [ uuid(14375246-E4A1-4A30-85B2-0DF991B4FFB2), + helpstring("Dispatch interface for a PHXDataExplorer Plugin") ] + dispinterface PHXDataExplorerPlugIn + { + properties: + + methods: + [id(6)] LPDISPATCH getDataHistory(); + [id(7)] void setDataHistory(LPDISPATCH dataHistory); + [id(8)] LPDISPATCH getModelCenter(); + [id(9)] void setModelCenter(LPDISPATCH modelCenter); + [id(10)] BSTR getPageTitle(); + [id(11)] BSTR toString(); + [id(12)] void fromString(BSTR str); + [id(13)] void getMenuItems(LPDISPATCH iPHXMenuItem); + [id(14)] void invokeMenuItem(long id); + [id(15)] boolean isMenuItemEnabled(long id); + [id(16)] boolean updateHint(); + [id(17)] void setStartContext(BSTR str); + [id(18)] BSTR getThumbnail(BSTR hints); + } + + [ uuid(32A29C04-BB5C-4029-92AB-3DFC5C7B72A2), + helpstring("Dispatch interface for a PHXDataExplorer Plugin that provides custom image export") ] + dispinterface PHXDataExplorerExportPlugIn + { + properties: + + methods: + [id(18)] void exportImage(BSTR hints, BSTR filename); + } + + typedef enum { + PHXMENU_CUT=-1, + PHXMENU_COPY=-2, + PHXMENU_PASTE=-3, + PHXMENU_DELETE=-4, + PHXMENU_PAGESETTINGS=-5, + PHXMENU_PRINT=-6, + PHXMENU_EXPORT=-7, + PHXMENU_TOOLTIP=-8 + } PHXMENU_PREDEFS; + + + // Primary dispatch interface for DataHistoryVariableMetadata + [ uuid(4BA85B03-92CA-4CFF-96CE-6E2D10365C9D) ] + dispinterface IDHVariable + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // NOTE - ClassWizard will maintain property information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_PROP(IDHVariable) + [id(1)] BSTR name; + [id(2)] BSTR equation; + [id(3)] boolean isDesignVar; + [id(4)] boolean isNumeric; + [id(5)] boolean isInput; + [id(6)] BSTR format; + [id(7)] BSTR enumValues; + [id(8)] BSTR enumAliases; + [id(9)] VARIANT lowerBound; + [id(10)] VARIANT upperBound; + [id(11)] BSTR type; + [id(12)] BSTR units; + [id(17)] BSTR geomScript; + [id(18)] boolean isBinary; + [id(19)] BSTR fileName; + //}}AFX_ODL_PROP + + methods: + // NOTE - ClassWizard will maintain method information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_METHOD(IDHVariable) + [id(13)] long getNumEnumValues(); + [id(14)] BSTR getEnumValue(long index); + [id(15)] BSTR getEnumAlias(long index); + [id(16)] long getNumEnumAliases(); + [id(20)] void setMetaData(BSTR key, BSTR value); + [id(21)] BSTR getMetaData(BSTR key); + [id(22)] SAFEARRAY(BSTR) getMetaDataKeys(); + + [id(23)] void copyFrom(LPDISPATCH other); + + [id(24)] void removeMetadata(BSTR key); + + //}}AFX_ODL_METHOD + }; + + [ uuid(901e602e-d00e-4efc-a71e-10c554170747) ] + dispinterface IPHXMenuItems + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + [id(1)] long numItems; + + methods: + [id(2)] void setMenuItem(long index, BSTR name, BSTR description); + [id(3)] BSTR getMenuItemName(long index); + [id(4)] BSTR getMenuItemDescription(long index); + }; + + // -------------------------------------------------------------- ISaveContext + [ uuid(3CD8CED0-4519-40C9-8FA6-A60A11011D2D), + helpstring("SaveContext") ] + dispinterface ISaveContext + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // properties go here + + methods: + [id(1)] boolean saveFile(BSTR sourceLocation, BSTR context); + [id(2)] boolean restoreFile(BSTR fileID, BSTR targetLocation); + [id(3)] void close(); + [id(4)] BSTR getSaveLocation(); + [id(5)] LPUNKNOWN saveFileStream(BSTR context); + [id(6)] LPUNKNOWN restoreFileStream(BSTR fileID); + [id(7)] int getFileFormat(); + [id(8)] void setFileFormat(int fileFormat); + }; + + //{{AFX_APPEND_ODL}} + //}}AFX_APPEND_ODL}} +}; +``` + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/PlugInMetaData_8odl.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/PlugInMetaData_8odl.md index 707fe5af4d..02be5778cd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/PlugInMetaData_8odl.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/PlugInMetaData_8odl.md @@ -1,69 +1,68 @@ - -# File PlugInMetaData.odl - -![][IDL] - -**Location**: `ModelCenter/src/InterfaceDLL\_PlugInMetaData/PlugInMetaData.odl` - - - - - -## Classes - -* [PlugInMetaData::IPlugInMetaData](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData) - -## Namespaces - -* [PlugInMetaData](namespacePlugInMetaData.md#namespacePlugInMetaData) - -## Source - -``` -// PlugInMetaData.odl : type library source for PlugInMetaData.dll - -// This file will be processed by the MIDL compiler to produce the -// type library (PlugInMetaData.tlb). - -[ uuid(C0D290FC-D60E-406A-A403-B6C6A7E38BB7), version(1.0) ] -library PlugInMetaData -{ - importlib("stdole32.tlb"); - importlib("stdole2.tlb"); - - - - - // Primary dispatch interface for PHXCOMPlugInMetaData - - [ uuid(BDE7EDB6-6FBD-4B71-8374-4CD42914F312) ] - dispinterface IPlugInMetaData - { - properties: - // NOTE - ClassWizard will maintain property information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_PROP(PHXCOMPlugInMetaData) - //}}AFX_ODL_PROP - - methods: - // NOTE - ClassWizard will maintain method information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_METHOD(PHXCOMPlugInMetaData) - [id(1)] BSTR getDescription(); - [id(2)] BSTR getAuthor(); - [id(3)] BSTR getVersion(); - [id(4)] BSTR getHelpURL(); - [id(5)] BSTR getKeywords(); - [id(6)] BSTR getIconLocation(); - //}}AFX_ODL_METHOD - - }; - - //{{AFX_APPEND_ODL}} - //}}AFX_APPEND_ODL}} -}; -``` - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# File PlugInMetaData.odl + +![][IDL] + +**Location**: `ModelCenter/src/InterfaceDLL\_PlugInMetaData/PlugInMetaData.odl` + + + + + +## Classes + +* [PlugInMetaData::IPlugInMetaData](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData) + +## Namespaces + +* [PlugInMetaData](namespacePlugInMetaData.md#namespacePlugInMetaData) + +## Source + +``` +// PlugInMetaData.odl : type library source for PlugInMetaData.dll + +// This file will be processed by the MIDL compiler to produce the +// type library (PlugInMetaData.tlb). + +[ uuid(C0D290FC-D60E-406A-A403-B6C6A7E38BB7), version(1.0) ] +library PlugInMetaData +{ + importlib("stdole32.tlb"); + importlib("stdole2.tlb"); + + + + + // Primary dispatch interface for PHXCOMPlugInMetaData + + [ uuid(BDE7EDB6-6FBD-4B71-8374-4CD42914F312) ] + dispinterface IPlugInMetaData + { + properties: + // NOTE - ClassWizard will maintain property information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_PROP(PHXCOMPlugInMetaData) + //}}AFX_ODL_PROP + + methods: + // NOTE - ClassWizard will maintain method information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_METHOD(PHXCOMPlugInMetaData) + [id(1)] BSTR getDescription(); + [id(2)] BSTR getAuthor(); + [id(3)] BSTR getVersion(); + [id(4)] BSTR getHelpURL(); + [id(5)] BSTR getKeywords(); + [id(6)] BSTR getIconLocation(); + //}}AFX_ODL_METHOD + + }; + + //{{AFX_APPEND_ODL}} + //}}AFX_APPEND_ODL}} +}; +``` + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/TradeStudyPlugIn_8odl.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/TradeStudyPlugIn_8odl.md index 869be11a21..dd166b487f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/TradeStudyPlugIn_8odl.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/TradeStudyPlugIn_8odl.md @@ -1,311 +1,310 @@ - -# File TradeStudyPlugIn.odl - -![][IDL] - -**Location**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` - - - - - -## Classes - -* [TradeStudyPlugIn::ITradeStudyPlugIn](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn) -* [TradeStudyPlugIn::ITradeStudyPlugIn2](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2) -* [TradeStudyPlugIn::ITradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback) -* [TradeStudyPlugIn::ITradeStudy3JobInfo](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo) -* [TradeStudyPlugIn::ITradeStudy3JobResult](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult) -* [TradeStudyPlugIn::IVariableMetaDataProvider](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider) -* [TradeStudyPlugIn::ITradeStudy3JobManager](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager) -* [TradeStudyPlugIn::ITradeStudyPlugIn3](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3) -* [TradeStudyPlugIn::IWindowed](interfaceTradeStudyPlugIn_1_1IWindowed.md#interfaceTradeStudyPlugIn_1_1IWindowed) -* [TradeStudyPlugIn::ICombinedPlugIn](interfaceTradeStudyPlugIn_1_1ICombinedPlugIn.md#interfaceTradeStudyPlugIn_1_1ICombinedPlugIn) -* [TradeStudyPlugIn::TradeStudyPlugIn](classTradeStudyPlugIn_1_1TradeStudyPlugIn.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn) -* [TradeStudyPlugIn::TradeStudyPlugIn2](classTradeStudyPlugIn_1_1TradeStudyPlugIn2.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn2) - -## Namespaces - -* [TradeStudyPlugIn](namespaceTradeStudyPlugIn.md#namespaceTradeStudyPlugIn) - -## Source - -``` -// TradeStudyPlugIn.odl : type library source for TradeStudyPlugIn.dll - -// This file will be processed by the MIDL compiler to produce the -// type library (TradeStudyPlugIn.tlb). - -[ uuid(A4C1DA09-6913-465B-BC86-9A7364881DF8), version(1.0) ] -library TradeStudyPlugIn -{ - importlib("stdole32.tlb"); - importlib("stdole2.tlb"); - - // Primary dispatch interface for PHXCOMTradeStudyPlugIn - - [ uuid(23C63C08-4BC7-4153-B89F-706D8BDCB3ED) ] - dispinterface ITradeStudyPlugIn - { - properties: - // NOTE - ClassWizard will maintain property information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_PROP(PHXCOMTradeStudyPlugIn) - //}}AFX_ODL_PROP - - methods: - // NOTE - ClassWizard will maintain method information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_METHOD(PHXCOMTradeStudyPlugIn) - [id(1)] void construct(IDispatch* modelCenter, IDispatch* addToModel, [defaultvalue(NULL)]IDispatch* dataCollector); - [id(2)] boolean show(); - [id(3)] BSTR toString(); - [id(4)] void fromString(BSTR setupString); - //}}AFX_ODL_METHOD - - }; - - // -------------------------------------------------------------- ITradeStudyPlugIn2 - [uuid(5C569D84-899F-4403-BFAD-C851E1B874C7)] - dispinterface ITradeStudyPlugIn2 - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // our properties - [id(5)] LPDISPATCH TradeStudyCallback; - - [id(9)] boolean saveAllAnalyzerVariables; - - methods: - // inherited from ITradeStudyPlugIn - [id(1)] void construct(IDispatch* modelCenter, IDispatch* addToModel, [defaultvalue(NULL)]IDispatch* dataCollector); - - [id(2)] boolean show(); - - [id(3)] BSTR toString(); - - [id(4)] void fromString(BSTR setupString); - - [id(6)] void onEnd(); - - [id(7)] void addAnalyzerVariable(BSTR formula, [optional]VARIANT analyzerName); - - [id(8)] void clearAnalyzerVariables(); - }; - - // Primary dispatch interface for CPHXTradeStudyCallbackCtrl - [ uuid(1834107A-299F-4D83-AECA-D2563D2E1FFB), - helpstring("Dispatch interface for PHXTradeStudyCallback control") ] - dispinterface ITradeStudyCallback - { - properties: - // NOTE - ClassWizard will maintain property information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_PROP(CPHXTradeStudyCallbackCtrl) - - // add property definitions here - - //}}AFX_ODL_PROP - - methods: - // NOTE - ClassWizard will maintain method information here. - // Use extreme caution when editing this section. - //{{AFX_ODL_METHOD(CPHXTradeStudyCallbackCtrl) - - [id(1)] void dataCollectorCreated(LPDISPATCH tradeStudy, LPDISPATCH dataCollector); - - [id(2)] BOOL runStarting(LPDISPATCH tradeStudy); - - [id(3)] void runEnded(LPDISPATCH tradeStudy); - - [id(4)] void tradeStudyClosed(LPDISPATCH tradeStudy); - - //}}AFX_ODL_METHOD - }; - - // -------------------------------------------------------------- ITradeStudyPlugIn3 - - [uuid(BE014673-9D1E-457E-819E-CA9B584269FF)] - dispinterface ITradeStudy3JobInfo - { - properties: - methods: - - [id(1), propget] long numRuns(); - - [id(2), propget] long numVariables(); - - [id(3)] BSTR getVariableEquation(long index); - [id(4)] BSTR getVariableDisplayName(long index); - - [id(5)] boolean isDesignVariable(VARIANT which); - [id(6)] boolean isInput(VARIANT which); - }; - - [uuid(AAE6E030-AF5F-4237-B586-F40B367DBAFA)] - dispinterface ITradeStudy3JobResult - { - properties: - - methods: - - [id(1), propget] long numRuns(); - - [id(2), propget] long numVariables(); - - [id(3)] BSTR getVariableEquation(long index); - [id(4)] BSTR getVariableDisplayName(long index); - - [id(5)] boolean isDesignVariable(VARIANT which); - [id(6)] boolean isInput(VARIANT which); - - [id(101), propget] LPDISPATCH dataHistory(); - [id(102), propget] boolean isRunning(); - [id(103), propget] boolean isCanceled(); - - [id(106)] void cancelAsync(); - [id(107)] void waitForCompletion(); - }; - - [uuid(674CAFFE-3423-4F16-BD44-B7EC0C9C3AD2)] - dispinterface IVariableMetaDataProvider - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - - methods: - - [id(1)] LPDISPATCH getVariableMetaData(BSTR fullName); - - [id(2)] SAFEARRAY(IDispatch*) getAllVariableMetaData(BSTR path); - }; - - [uuid(06AEC424-37AE-4E36-BA60-37D68696A201)] - dispinterface ITradeStudy3JobManager - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - - [id(100)] LPDISPATCH dataHistory; - - [id(101)] boolean validateAll; - - [id(102)] boolean runInParallel; - - [id(103)] long numThreads; - - methods: - - [id(1), propget] long numRuns(); - - [id(2), propget] long numVariables(); - - [id(3)] BSTR getVariableEquation(long index); - [id(4)] BSTR getVariableDisplayName(long index); - - [id(5)] boolean isDesignVariable(VARIANT which); - [id(6)] boolean isInput(VARIANT which); - - [id(104), propget] boolean supportsParallelExecution(); - - [id(105), propget] boolean canNewJob(); - - [id(106)] void newJob(long numRuns); - [id(107)] void clear(); - [id(108)] void addVariable(BSTR equation, BSTR displayName, boolean isInput); - [id(109)] void setInput(long runIndex, VARIANT which, VARIANT value); - [id(110)] void setRunInputs(long runIndex, SAFEARRAY(VARIANT) values, [optional] SAFEARRAY(VARIANT) which); - [id(111)] void setVariableInputs(VARIANT which, SAFEARRAY(VARIANT) values, [optional] SAFEARRAY(long) runIndices); - [id(112)] ITradeStudy3JobResult* runJobAsync(); - - [id(113)] IVariableMetaDataProvider* getMetaDataProvider(); - }; - - [uuid(5ED31B61-8BE7-41AC-A278-1CA8EC7B945D)] - dispinterface ITradeStudyPlugIn3 - { -#ifndef DOXYGEN_SHOULD_SKIP_THIS - properties: -#else - methods: -#endif - // inherited from ITradeStudyPlugIn2 - [id(5)] LPDISPATCH TradeStudyCallback; - - [id(9)] boolean saveAllAnalyzerVariables; - - [id(10)] ITradeStudy3JobManager* jobManager; - - methods: - // inherited from ITradeStudyPlugIn2 - [id(1)] void construct(IDispatch* modelCenter, IDispatch* addToModel, [defaultvalue(NULL)]IDispatch* dataCollector); - - [id(2)] boolean show(); - - [id(3)] BSTR toString(); - - [id(4)] void fromString(BSTR setupString); - - [id(6)] void onEnd(); - - [id(7)] void addAnalyzerVariable(BSTR formula, [optional]VARIANT analyzerName); - - [id(8)] void clearAnalyzerVariables(); - }; - - [uuid(4DE940EF-A810-4AEC-A8B9-EC1502F902E2)] - dispinterface IWindowed - { - properties: - methods: - [id(1)] boolean closeWindow(); - } - - [uuid(B58D8757-0999-442B-838C-C581C67D35B1)] - dispinterface ICombinedPlugIn - { - properties: - - methods: - }; - - // Class information for PHXCOMTradeStudyPlugIn - - [ uuid(5412C8CE-AA4D-4D0F-8B67-EFE3E36A9D81) ] - coclass TradeStudyPlugIn - { - [default] dispinterface ITradeStudyPlugIn; - }; - - [ uuid(DB842003-DD05-4C82-BB76-C5646A94BE4D) ] - coclass TradeStudyPlugIn2 - { - [default] dispinterface ITradeStudyPlugIn2; - }; - - - - /* - [ uuid(A31E0F7A-F5E9-4EE3-BF2F-CA67CB855CC6) ] - coclass TradeStudyCallback - { - [default] dispinterface ITradeStudyCallback; - };*/ - - //{{AFX_APPEND_ODL}} - //}}AFX_APPEND_ODL}} -}; -``` - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# File TradeStudyPlugIn.odl + +![][IDL] + +**Location**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` + + + + + +## Classes + +* [TradeStudyPlugIn::ITradeStudyPlugIn](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn) +* [TradeStudyPlugIn::ITradeStudyPlugIn2](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2) +* [TradeStudyPlugIn::ITradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback) +* [TradeStudyPlugIn::ITradeStudy3JobInfo](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo) +* [TradeStudyPlugIn::ITradeStudy3JobResult](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult) +* [TradeStudyPlugIn::IVariableMetaDataProvider](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider) +* [TradeStudyPlugIn::ITradeStudy3JobManager](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager) +* [TradeStudyPlugIn::ITradeStudyPlugIn3](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3) +* [TradeStudyPlugIn::IWindowed](interfaceTradeStudyPlugIn_1_1IWindowed.md#interfaceTradeStudyPlugIn_1_1IWindowed) +* [TradeStudyPlugIn::ICombinedPlugIn](interfaceTradeStudyPlugIn_1_1ICombinedPlugIn.md#interfaceTradeStudyPlugIn_1_1ICombinedPlugIn) +* [TradeStudyPlugIn::TradeStudyPlugIn](classTradeStudyPlugIn_1_1TradeStudyPlugIn.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn) +* [TradeStudyPlugIn::TradeStudyPlugIn2](classTradeStudyPlugIn_1_1TradeStudyPlugIn2.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn2) + +## Namespaces + +* [TradeStudyPlugIn](namespaceTradeStudyPlugIn.md#namespaceTradeStudyPlugIn) + +## Source + +``` +// TradeStudyPlugIn.odl : type library source for TradeStudyPlugIn.dll + +// This file will be processed by the MIDL compiler to produce the +// type library (TradeStudyPlugIn.tlb). + +[ uuid(A4C1DA09-6913-465B-BC86-9A7364881DF8), version(1.0) ] +library TradeStudyPlugIn +{ + importlib("stdole32.tlb"); + importlib("stdole2.tlb"); + + // Primary dispatch interface for PHXCOMTradeStudyPlugIn + + [ uuid(23C63C08-4BC7-4153-B89F-706D8BDCB3ED) ] + dispinterface ITradeStudyPlugIn + { + properties: + // NOTE - ClassWizard will maintain property information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_PROP(PHXCOMTradeStudyPlugIn) + //}}AFX_ODL_PROP + + methods: + // NOTE - ClassWizard will maintain method information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_METHOD(PHXCOMTradeStudyPlugIn) + [id(1)] void construct(IDispatch* modelCenter, IDispatch* addToModel, [defaultvalue(NULL)]IDispatch* dataCollector); + [id(2)] boolean show(); + [id(3)] BSTR toString(); + [id(4)] void fromString(BSTR setupString); + //}}AFX_ODL_METHOD + + }; + + // -------------------------------------------------------------- ITradeStudyPlugIn2 + [uuid(5C569D84-899F-4403-BFAD-C851E1B874C7)] + dispinterface ITradeStudyPlugIn2 + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // our properties + [id(5)] LPDISPATCH TradeStudyCallback; + + [id(9)] boolean saveAllAnalyzerVariables; + + methods: + // inherited from ITradeStudyPlugIn + [id(1)] void construct(IDispatch* modelCenter, IDispatch* addToModel, [defaultvalue(NULL)]IDispatch* dataCollector); + + [id(2)] boolean show(); + + [id(3)] BSTR toString(); + + [id(4)] void fromString(BSTR setupString); + + [id(6)] void onEnd(); + + [id(7)] void addAnalyzerVariable(BSTR formula, [optional]VARIANT analyzerName); + + [id(8)] void clearAnalyzerVariables(); + }; + + // Primary dispatch interface for CPHXTradeStudyCallbackCtrl + [ uuid(1834107A-299F-4D83-AECA-D2563D2E1FFB), + helpstring("Dispatch interface for PHXTradeStudyCallback control") ] + dispinterface ITradeStudyCallback + { + properties: + // NOTE - ClassWizard will maintain property information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_PROP(CPHXTradeStudyCallbackCtrl) + + // add property definitions here + + //}}AFX_ODL_PROP + + methods: + // NOTE - ClassWizard will maintain method information here. + // Use extreme caution when editing this section. + //{{AFX_ODL_METHOD(CPHXTradeStudyCallbackCtrl) + + [id(1)] void dataCollectorCreated(LPDISPATCH tradeStudy, LPDISPATCH dataCollector); + + [id(2)] BOOL runStarting(LPDISPATCH tradeStudy); + + [id(3)] void runEnded(LPDISPATCH tradeStudy); + + [id(4)] void tradeStudyClosed(LPDISPATCH tradeStudy); + + //}}AFX_ODL_METHOD + }; + + // -------------------------------------------------------------- ITradeStudyPlugIn3 + + [uuid(BE014673-9D1E-457E-819E-CA9B584269FF)] + dispinterface ITradeStudy3JobInfo + { + properties: + methods: + + [id(1), propget] long numRuns(); + + [id(2), propget] long numVariables(); + + [id(3)] BSTR getVariableEquation(long index); + [id(4)] BSTR getVariableDisplayName(long index); + + [id(5)] boolean isDesignVariable(VARIANT which); + [id(6)] boolean isInput(VARIANT which); + }; + + [uuid(AAE6E030-AF5F-4237-B586-F40B367DBAFA)] + dispinterface ITradeStudy3JobResult + { + properties: + + methods: + + [id(1), propget] long numRuns(); + + [id(2), propget] long numVariables(); + + [id(3)] BSTR getVariableEquation(long index); + [id(4)] BSTR getVariableDisplayName(long index); + + [id(5)] boolean isDesignVariable(VARIANT which); + [id(6)] boolean isInput(VARIANT which); + + [id(101), propget] LPDISPATCH dataHistory(); + [id(102), propget] boolean isRunning(); + [id(103), propget] boolean isCanceled(); + + [id(106)] void cancelAsync(); + [id(107)] void waitForCompletion(); + }; + + [uuid(674CAFFE-3423-4F16-BD44-B7EC0C9C3AD2)] + dispinterface IVariableMetaDataProvider + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + + methods: + + [id(1)] LPDISPATCH getVariableMetaData(BSTR fullName); + + [id(2)] SAFEARRAY(IDispatch*) getAllVariableMetaData(BSTR path); + }; + + [uuid(06AEC424-37AE-4E36-BA60-37D68696A201)] + dispinterface ITradeStudy3JobManager + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + + [id(100)] LPDISPATCH dataHistory; + + [id(101)] boolean validateAll; + + [id(102)] boolean runInParallel; + + [id(103)] long numThreads; + + methods: + + [id(1), propget] long numRuns(); + + [id(2), propget] long numVariables(); + + [id(3)] BSTR getVariableEquation(long index); + [id(4)] BSTR getVariableDisplayName(long index); + + [id(5)] boolean isDesignVariable(VARIANT which); + [id(6)] boolean isInput(VARIANT which); + + [id(104), propget] boolean supportsParallelExecution(); + + [id(105), propget] boolean canNewJob(); + + [id(106)] void newJob(long numRuns); + [id(107)] void clear(); + [id(108)] void addVariable(BSTR equation, BSTR displayName, boolean isInput); + [id(109)] void setInput(long runIndex, VARIANT which, VARIANT value); + [id(110)] void setRunInputs(long runIndex, SAFEARRAY(VARIANT) values, [optional] SAFEARRAY(VARIANT) which); + [id(111)] void setVariableInputs(VARIANT which, SAFEARRAY(VARIANT) values, [optional] SAFEARRAY(long) runIndices); + [id(112)] ITradeStudy3JobResult* runJobAsync(); + + [id(113)] IVariableMetaDataProvider* getMetaDataProvider(); + }; + + [uuid(5ED31B61-8BE7-41AC-A278-1CA8EC7B945D)] + dispinterface ITradeStudyPlugIn3 + { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + properties: +#else + methods: +#endif + // inherited from ITradeStudyPlugIn2 + [id(5)] LPDISPATCH TradeStudyCallback; + + [id(9)] boolean saveAllAnalyzerVariables; + + [id(10)] ITradeStudy3JobManager* jobManager; + + methods: + // inherited from ITradeStudyPlugIn2 + [id(1)] void construct(IDispatch* modelCenter, IDispatch* addToModel, [defaultvalue(NULL)]IDispatch* dataCollector); + + [id(2)] boolean show(); + + [id(3)] BSTR toString(); + + [id(4)] void fromString(BSTR setupString); + + [id(6)] void onEnd(); + + [id(7)] void addAnalyzerVariable(BSTR formula, [optional]VARIANT analyzerName); + + [id(8)] void clearAnalyzerVariables(); + }; + + [uuid(4DE940EF-A810-4AEC-A8B9-EC1502F902E2)] + dispinterface IWindowed + { + properties: + methods: + [id(1)] boolean closeWindow(); + } + + [uuid(B58D8757-0999-442B-838C-C581C67D35B1)] + dispinterface ICombinedPlugIn + { + properties: + + methods: + }; + + // Class information for PHXCOMTradeStudyPlugIn + + [ uuid(5412C8CE-AA4D-4D0F-8B67-EFE3E36A9D81) ] + coclass TradeStudyPlugIn + { + [default] dispinterface ITradeStudyPlugIn; + }; + + [ uuid(DB842003-DD05-4C82-BB76-C5646A94BE4D) ] + coclass TradeStudyPlugIn2 + { + [default] dispinterface ITradeStudyPlugIn2; + }; + + + + /* + [ uuid(A31E0F7A-F5E9-4EE3-BF2F-CA67CB855CC6) ] + coclass TradeStudyCallback + { + [default] dispinterface ITradeStudyCallback; + };*/ + + //{{AFX_APPEND_ODL}} + //}}AFX_APPEND_ODL}} +}; +``` + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classModelCenter_1_1Application.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classModelCenter_1_1Application.md index fb50efaa4f..407d00b0f2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classModelCenter_1_1Application.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classModelCenter_1_1Application.md @@ -1,17 +1,16 @@ - -# Class ModelCenter::Application - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5024) - - - - - -## Members - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Class ModelCenter::Application + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5024) + + + + + +## Members + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classPHXDATAEXPLORERLib_1_1PHXDataExplorer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classPHXDATAEXPLORERLib_1_1PHXDataExplorer.md index 04ed7ec567..0037a9a59f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classPHXDATAEXPLORERLib_1_1PHXDataExplorer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classPHXDATAEXPLORERLib_1_1PHXDataExplorer.md @@ -1,17 +1,16 @@ - -# Class PHXDATAEXPLORERLib::PHXDataExplorer - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 377) - - - - - -## Members - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Class PHXDATAEXPLORERLib::PHXDataExplorer + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 377) + + + + + +## Members + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer.md index 38d88cd6f6..a30ac3d872 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer.md @@ -1,17 +1,16 @@ - -# Class PHXDATAEXPLORERLib::PHXDataExplorerPointer - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 418) - - - - - -## Members - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Class PHXDATAEXPLORERLib::PHXDataExplorerPointer + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 418) + + + + + +## Members + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata.md index bc3a55c18d..4434ea1bce 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata.md @@ -1,17 +1,16 @@ - -# Class PHXDATAHISTORYLib::DataHistoryVariableMetadata - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 868) - - - - - -## Members - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Class PHXDATAHISTORYLib::DataHistoryVariableMetadata + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 868) + + + + + +## Members + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classPHXDATAHISTORYLib_1_1PHXDataHistory.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classPHXDATAHISTORYLib_1_1PHXDataHistory.md index ca370ecd26..55c16dec54 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classPHXDATAHISTORYLib_1_1PHXDataHistory.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classPHXDATAHISTORYLib_1_1PHXDataHistory.md @@ -1,17 +1,16 @@ - -# Class PHXDATAHISTORYLib::PHXDataHistory - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 861) - - - - - -## Members - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Class PHXDATAHISTORYLib::PHXDataHistory + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 861) + + + + + +## Members + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classTradeStudyPlugIn_1_1TradeStudyPlugIn.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classTradeStudyPlugIn_1_1TradeStudyPlugIn.md index eb22245a84..f82d87d897 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classTradeStudyPlugIn_1_1TradeStudyPlugIn.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classTradeStudyPlugIn_1_1TradeStudyPlugIn.md @@ -1,17 +1,16 @@ - -# Class TradeStudyPlugIn::TradeStudyPlugIn - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 596) - - - - - -## Members - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Class TradeStudyPlugIn::TradeStudyPlugIn + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 596) + + + + + +## Members + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classTradeStudyPlugIn_1_1TradeStudyPlugIn2.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classTradeStudyPlugIn_1_1TradeStudyPlugIn2.md index 49964bb109..18cbc16fee 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classTradeStudyPlugIn_1_1TradeStudyPlugIn2.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/classTradeStudyPlugIn_1_1TradeStudyPlugIn2.md @@ -1,17 +1,16 @@ - -# Class TradeStudyPlugIn::TradeStudyPlugIn2 - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 602) - - - - - -## Members - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Class TradeStudyPlugIn::TradeStudyPlugIn2 + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 602) + + + + + +## Members + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/class_contents.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/class_contents.md index 9ceefca26b..703a90f1bb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/class_contents.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/class_contents.md @@ -1,9 +1,9 @@ -# Classes - -* [ModelCenter::Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) -* [PHXDATAHISTORYLib::DataHistoryVariableMetadata](classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata.md#classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata) -* [PHXDATAEXPLORERLib::PHXDataExplorer](classPHXDATAEXPLORERLib_1_1PHXDataExplorer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorer) -* [PHXDATAEXPLORERLib::PHXDataExplorerPointer](classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer) -* [PHXDATAHISTORYLib::PHXDataHistory](classPHXDATAHISTORYLib_1_1PHXDataHistory.md#classPHXDATAHISTORYLib_1_1PHXDataHistory) -* [TradeStudyPlugIn::TradeStudyPlugIn](classTradeStudyPlugIn_1_1TradeStudyPlugIn.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn) +# Classes + +* [ModelCenter::Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) +* [PHXDATAHISTORYLib::DataHistoryVariableMetadata](classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata.md#classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata) +* [PHXDATAEXPLORERLib::PHXDataExplorer](classPHXDATAEXPLORERLib_1_1PHXDataExplorer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorer) +* [PHXDATAEXPLORERLib::PHXDataExplorerPointer](classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer) +* [PHXDATAHISTORYLib::PHXDataHistory](classPHXDATAHISTORYLib_1_1PHXDataHistory.md#classPHXDATAHISTORYLib_1_1PHXDataHistory) +* [TradeStudyPlugIn::TradeStudyPlugIn](classTradeStudyPlugIn_1_1TradeStudyPlugIn.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn) * [TradeStudyPlugIn::TradeStudyPlugIn2](classTradeStudyPlugIn_1_1TradeStudyPlugIn2.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn2) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/class_index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/class_index.md index 2fbf27d032..1fdf6ff65f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/class_index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/class_index.md @@ -1,17 +1,17 @@ -# Index of Classes - -## M - -* [ModelCenter::Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) - -## P - -* [PHXDATAHISTORYLib::DataHistoryVariableMetadata](classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata.md#classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata) -* [PHXDATAEXPLORERLib::PHXDataExplorer](classPHXDATAEXPLORERLib_1_1PHXDataExplorer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorer) -* [PHXDATAEXPLORERLib::PHXDataExplorerPointer](classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer) -* [PHXDATAHISTORYLib::PHXDataHistory](classPHXDATAHISTORYLib_1_1PHXDataHistory.md#classPHXDATAHISTORYLib_1_1PHXDataHistory) - -## T - -* [TradeStudyPlugIn::TradeStudyPlugIn](classTradeStudyPlugIn_1_1TradeStudyPlugIn.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn) +# Index of Classes + +## M + +* [ModelCenter::Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) + +## P + +* [PHXDATAHISTORYLib::DataHistoryVariableMetadata](classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata.md#classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata) +* [PHXDATAEXPLORERLib::PHXDataExplorer](classPHXDATAEXPLORERLib_1_1PHXDataExplorer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorer) +* [PHXDATAEXPLORERLib::PHXDataExplorerPointer](classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer) +* [PHXDATAHISTORYLib::PHXDataHistory](classPHXDATAHISTORYLib_1_1PHXDataHistory.md#classPHXDATAHISTORYLib_1_1PHXDataHistory) + +## T + +* [TradeStudyPlugIn::TradeStudyPlugIn](classTradeStudyPlugIn_1_1TradeStudyPlugIn.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn) * [TradeStudyPlugIn::TradeStudyPlugIn2](classTradeStudyPlugIn_1_1TradeStudyPlugIn2.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn2) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/deprecated.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/deprecated.md index eea1ed5c4b..24b8b1b914 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/deprecated.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/deprecated.md @@ -1,67 +1,66 @@ - -# Deprecated List - - - -Member [ModelCenter::IModelCenter::createDataCollector](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad91dff33c09345053346ce2d831fd968) (BSTR tradeStudyType, BSTR setup): - - -use [createDataExplorer()](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3edba311337bb171b956e0d331cfa05f) instead - - -Member [ModelCenter::IModelCenter::exit](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aba655ef2cf9a8f639acde2697d8319a2) (): - - - No longer used. - - -Member [ModelCenter::TS\_FORMAT\_PXT\_COMPRESSED](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaac387037adbfc62827fa1523fc69a1278): - - -This file format is deprecated and files can no longer be saved in this format. - - -Member [ModelCenter::TS\_FORMAT\_PXT\_UNCOMPRESSED](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaaeead4e562c092545f613d220eb2df08e): - - -This file format is deprecated and files can no longer be saved in this format. - - -Member [ModelCenter::TS\_FORMAT\_PXTZ](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaac6d6ad08981541727efbbf8c181674cf): - - -This file format is deprecated and files can no longer be saved in this format. - - -Member [PHXDATAEXPLORERLib::\_DPHXDataExplorer::getMenuItems](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1c15433a3ca058372e666abbaa1e1fa6) (LPDISPATCH iPHXMenuItem): - - - Deprecated. Do not use. - - -Member [PHXDATAEXPLORERLib::\_DPHXDataExplorer::invokeMenuItem](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2a636f7492de925506cd78a80e37deca) (long id): - - - Deprecated. Do not use. - - -Member [PHXDATAEXPLORERLib::\_DPHXDataExplorer::isMenuItemEnabled](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a23f32ddd6ea2d2d268351327a03e46b5) (long id): - - - Deprecated. Do not use. - - -Member [PHXDATAEXPLORERLib::\_DPHXDataExplorer::updateThumbHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1adda950ce0660029538ab7bdb541c6f2c) (long id): - - - Deprecated. Do not use. - - -Member [PHXDATAHISTORYLib::\_DPHXDataHistory::suggestedIndependantVar](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3b5732bdccab13e2a7ed55c852d4c55b): - - -(misspelling) - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Deprecated List + + + +Member [ModelCenter::IModelCenter::createDataCollector](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad91dff33c09345053346ce2d831fd968) (BSTR tradeStudyType, BSTR setup): + + +use [createDataExplorer()](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3edba311337bb171b956e0d331cfa05f) instead + + +Member [ModelCenter::IModelCenter::exit](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aba655ef2cf9a8f639acde2697d8319a2) (): + + + No longer used. + + +Member [ModelCenter::TS\_FORMAT\_PXT\_COMPRESSED](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaac387037adbfc62827fa1523fc69a1278): + + +This file format is deprecated and files can no longer be saved in this format. + + +Member [ModelCenter::TS\_FORMAT\_PXT\_UNCOMPRESSED](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaaeead4e562c092545f613d220eb2df08e): + + +This file format is deprecated and files can no longer be saved in this format. + + +Member [ModelCenter::TS\_FORMAT\_PXTZ](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaac6d6ad08981541727efbbf8c181674cf): + + +This file format is deprecated and files can no longer be saved in this format. + + +Member [PHXDATAEXPLORERLib::\_DPHXDataExplorer::getMenuItems](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1c15433a3ca058372e666abbaa1e1fa6) (LPDISPATCH iPHXMenuItem): + + + Deprecated. Do not use. + + +Member [PHXDATAEXPLORERLib::\_DPHXDataExplorer::invokeMenuItem](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2a636f7492de925506cd78a80e37deca) (long id): + + + Deprecated. Do not use. + + +Member [PHXDATAEXPLORERLib::\_DPHXDataExplorer::isMenuItemEnabled](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a23f32ddd6ea2d2d268351327a03e46b5) (long id): + + + Deprecated. Do not use. + + +Member [PHXDATAEXPLORERLib::\_DPHXDataExplorer::updateThumbHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1adda950ce0660029538ab7bdb541c6f2c) (long id): + + + Deprecated. Do not use. + + +Member [PHXDATAHISTORYLib::\_DPHXDataHistory::suggestedIndependantVar](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3b5732bdccab13e2a7ed55c852d4c55b): + + +(misspelling) + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_254da5db084e40f61f0f3ecf2de92ae0.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_254da5db084e40f61f0f3ecf2de92ae0.md index 6714c3d514..5d4a4cb950 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_254da5db084e40f61f0f3ecf2de92ae0.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_254da5db084e40f61f0f3ecf2de92ae0.md @@ -1,16 +1,15 @@ - -# Directory ModelCenter/src/InterfaceDLL\_PlugInMetaData - -**Location**: `ModelCenter/src/InterfaceDLL\_PlugInMetaData/` - - - - - -## Files - -* [PlugInMetaData.odl](PlugInMetaData_8odl.md#PlugInMetaData_8odl) - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Directory ModelCenter/src/InterfaceDLL\_PlugInMetaData + +**Location**: `ModelCenter/src/InterfaceDLL\_PlugInMetaData/` + + + + + +## Files + +* [PlugInMetaData.odl](PlugInMetaData_8odl.md#PlugInMetaData_8odl) + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_3deb6222fdd4eb7b0f76591cf78ec6d0.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_3deb6222fdd4eb7b0f76591cf78ec6d0.md index 745186c605..0c698d8bc2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_3deb6222fdd4eb7b0f76591cf78ec6d0.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_3deb6222fdd4eb7b0f76591cf78ec6d0.md @@ -1,16 +1,15 @@ - -# Directory LIBS - -**Location**: `LIBS/` - - - - - -## Subdirectories - -* [LIBS/DataExplorer](dir_4c5da7dd69977c70a414920e45f0e4dd.md#dir_4c5da7dd69977c70a414920e45f0e4dd) - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Directory LIBS + +**Location**: `LIBS/` + + + + + +## Subdirectories + +* [LIBS/DataExplorer](dir_4c5da7dd69977c70a414920e45f0e4dd.md#dir_4c5da7dd69977c70a414920e45f0e4dd) + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_4c5da7dd69977c70a414920e45f0e4dd.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_4c5da7dd69977c70a414920e45f0e4dd.md index d0e6500db0..f0de07803c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_4c5da7dd69977c70a414920e45f0e4dd.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_4c5da7dd69977c70a414920e45f0e4dd.md @@ -1,17 +1,16 @@ - -# Directory LIBS/DataExplorer - -**Location**: `LIBS/DataExplorer/` - - - - - -## Subdirectories - -* [LIBS/DataExplorer/PHXDataExplorer](dir_f8085194870fe60668985a445c75a643.md#dir_f8085194870fe60668985a445c75a643) -* [LIBS/DataExplorer/PHXDataHistory](dir_b61c1eebc2b964146e7860adc8b8cd2e.md#dir_b61c1eebc2b964146e7860adc8b8cd2e) - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Directory LIBS/DataExplorer + +**Location**: `LIBS/DataExplorer/` + + + + + +## Subdirectories + +* [LIBS/DataExplorer/PHXDataExplorer](dir_f8085194870fe60668985a445c75a643.md#dir_f8085194870fe60668985a445c75a643) +* [LIBS/DataExplorer/PHXDataHistory](dir_b61c1eebc2b964146e7860adc8b8cd2e.md#dir_b61c1eebc2b964146e7860adc8b8cd2e) + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_6384486296a61296aa9794364431ed6d.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_6384486296a61296aa9794364431ed6d.md index 0b6a5437bd..9b8f9e937f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_6384486296a61296aa9794364431ed6d.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_6384486296a61296aa9794364431ed6d.md @@ -1,16 +1,15 @@ - -# Directory ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn - -**Location**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/` - - - - - -## Files - -* [TradeStudyPlugIn.odl](TradeStudyPlugIn_8odl.md#TradeStudyPlugIn_8odl) - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Directory ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn + +**Location**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/` + + + + + +## Files + +* [TradeStudyPlugIn.odl](TradeStudyPlugIn_8odl.md#TradeStudyPlugIn_8odl) + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_b61c1eebc2b964146e7860adc8b8cd2e.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_b61c1eebc2b964146e7860adc8b8cd2e.md index 4c34bd4258..65e10b5407 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_b61c1eebc2b964146e7860adc8b8cd2e.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_b61c1eebc2b964146e7860adc8b8cd2e.md @@ -1,16 +1,15 @@ - -# Directory LIBS/DataExplorer/PHXDataHistory - -**Location**: `LIBS/DataExplorer/PHXDataHistory/` - - - - - -## Files - -* [PHXDataHistory.odl](PHXDataHistory_8odl.md#PHXDataHistory_8odl) - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Directory LIBS/DataExplorer/PHXDataHistory + +**Location**: `LIBS/DataExplorer/PHXDataHistory/` + + + + + +## Files + +* [PHXDataHistory.odl](PHXDataHistory_8odl.md#PHXDataHistory_8odl) + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_cb6cf9700ae02fb10e39761559b5fdeb.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_cb6cf9700ae02fb10e39761559b5fdeb.md index 108c9e8b6e..481917de93 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_cb6cf9700ae02fb10e39761559b5fdeb.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_cb6cf9700ae02fb10e39761559b5fdeb.md @@ -1,22 +1,21 @@ - -# Directory ModelCenter/src - -**Location**: `ModelCenter/src/` - - - - - -## Subdirectories - -* [ModelCenter/src/InterfaceDLL\_ComponentPlugIn](dir_f4b71a0ee7c6b8122721a969fd158e55.md#dir_f4b71a0ee7c6b8122721a969fd158e55) -* [ModelCenter/src/InterfaceDLL\_PlugInMetaData](dir_254da5db084e40f61f0f3ecf2de92ae0.md#dir_254da5db084e40f61f0f3ecf2de92ae0) -* [ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn](dir_6384486296a61296aa9794364431ed6d.md#dir_6384486296a61296aa9794364431ed6d) - -## Files - -* [ModelCenter.odl](ModelCenter_8odl.md#ModelCenter_8odl) - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Directory ModelCenter/src + +**Location**: `ModelCenter/src/` + + + + + +## Subdirectories + +* [ModelCenter/src/InterfaceDLL\_ComponentPlugIn](dir_f4b71a0ee7c6b8122721a969fd158e55.md#dir_f4b71a0ee7c6b8122721a969fd158e55) +* [ModelCenter/src/InterfaceDLL\_PlugInMetaData](dir_254da5db084e40f61f0f3ecf2de92ae0.md#dir_254da5db084e40f61f0f3ecf2de92ae0) +* [ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn](dir_6384486296a61296aa9794364431ed6d.md#dir_6384486296a61296aa9794364431ed6d) + +## Files + +* [ModelCenter.odl](ModelCenter_8odl.md#ModelCenter_8odl) + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_contents.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_contents.md index 3df2f10b33..c33a557bb6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_contents.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_contents.md @@ -1,11 +1,11 @@ -# Directories - -* [LIBS](dir_3deb6222fdd4eb7b0f76591cf78ec6d0.md#dir_3deb6222fdd4eb7b0f76591cf78ec6d0) - * [LIBS/DataExplorer](dir_4c5da7dd69977c70a414920e45f0e4dd.md#dir_4c5da7dd69977c70a414920e45f0e4dd) - * [LIBS/DataExplorer/PHXDataExplorer](dir_f8085194870fe60668985a445c75a643.md#dir_f8085194870fe60668985a445c75a643) - * [LIBS/DataExplorer/PHXDataHistory](dir_b61c1eebc2b964146e7860adc8b8cd2e.md#dir_b61c1eebc2b964146e7860adc8b8cd2e) -* [ModelCenter](dir_e61251abb0949c61ea8ea7dc5fba4af2.md#dir_e61251abb0949c61ea8ea7dc5fba4af2) - * [ModelCenter/src](dir_cb6cf9700ae02fb10e39761559b5fdeb.md#dir_cb6cf9700ae02fb10e39761559b5fdeb) - * [ModelCenter/src/InterfaceDLL\_ComponentPlugIn](dir_f4b71a0ee7c6b8122721a969fd158e55.md#dir_f4b71a0ee7c6b8122721a969fd158e55) - * [ModelCenter/src/InterfaceDLL\_PlugInMetaData](dir_254da5db084e40f61f0f3ecf2de92ae0.md#dir_254da5db084e40f61f0f3ecf2de92ae0) +# Directories + +* [LIBS](dir_3deb6222fdd4eb7b0f76591cf78ec6d0.md#dir_3deb6222fdd4eb7b0f76591cf78ec6d0) + * [LIBS/DataExplorer](dir_4c5da7dd69977c70a414920e45f0e4dd.md#dir_4c5da7dd69977c70a414920e45f0e4dd) + * [LIBS/DataExplorer/PHXDataExplorer](dir_f8085194870fe60668985a445c75a643.md#dir_f8085194870fe60668985a445c75a643) + * [LIBS/DataExplorer/PHXDataHistory](dir_b61c1eebc2b964146e7860adc8b8cd2e.md#dir_b61c1eebc2b964146e7860adc8b8cd2e) +* [ModelCenter](dir_e61251abb0949c61ea8ea7dc5fba4af2.md#dir_e61251abb0949c61ea8ea7dc5fba4af2) + * [ModelCenter/src](dir_cb6cf9700ae02fb10e39761559b5fdeb.md#dir_cb6cf9700ae02fb10e39761559b5fdeb) + * [ModelCenter/src/InterfaceDLL\_ComponentPlugIn](dir_f4b71a0ee7c6b8122721a969fd158e55.md#dir_f4b71a0ee7c6b8122721a969fd158e55) + * [ModelCenter/src/InterfaceDLL\_PlugInMetaData](dir_254da5db084e40f61f0f3ecf2de92ae0.md#dir_254da5db084e40f61f0f3ecf2de92ae0) * [ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn](dir_6384486296a61296aa9794364431ed6d.md#dir_6384486296a61296aa9794364431ed6d) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_e61251abb0949c61ea8ea7dc5fba4af2.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_e61251abb0949c61ea8ea7dc5fba4af2.md index ba5c38ccbf..132188bdb2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_e61251abb0949c61ea8ea7dc5fba4af2.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_e61251abb0949c61ea8ea7dc5fba4af2.md @@ -1,16 +1,15 @@ - -# Directory ModelCenter - -**Location**: `ModelCenter/` - - - - - -## Subdirectories - -* [ModelCenter/src](dir_cb6cf9700ae02fb10e39761559b5fdeb.md#dir_cb6cf9700ae02fb10e39761559b5fdeb) - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Directory ModelCenter + +**Location**: `ModelCenter/` + + + + + +## Subdirectories + +* [ModelCenter/src](dir_cb6cf9700ae02fb10e39761559b5fdeb.md#dir_cb6cf9700ae02fb10e39761559b5fdeb) + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_f4b71a0ee7c6b8122721a969fd158e55.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_f4b71a0ee7c6b8122721a969fd158e55.md index 7b4036523e..1154230bdf 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_f4b71a0ee7c6b8122721a969fd158e55.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_f4b71a0ee7c6b8122721a969fd158e55.md @@ -1,16 +1,15 @@ - -# Directory ModelCenter/src/InterfaceDLL\_ComponentPlugIn - -**Location**: `ModelCenter/src/InterfaceDLL\_ComponentPlugIn/` - - - - - -## Files - -* [ComponentPlugIn.odl](ComponentPlugIn_8odl.md#ComponentPlugIn_8odl) - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Directory ModelCenter/src/InterfaceDLL\_ComponentPlugIn + +**Location**: `ModelCenter/src/InterfaceDLL\_ComponentPlugIn/` + + + + + +## Files + +* [ComponentPlugIn.odl](ComponentPlugIn_8odl.md#ComponentPlugIn_8odl) + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_f8085194870fe60668985a445c75a643.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_f8085194870fe60668985a445c75a643.md index ee95b4f946..0b340dba0f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_f8085194870fe60668985a445c75a643.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_f8085194870fe60668985a445c75a643.md @@ -1,16 +1,15 @@ - -# Directory LIBS/DataExplorer/PHXDataExplorer - -**Location**: `LIBS/DataExplorer/PHXDataExplorer/` - - - - - -## Files - -* [PHXDataExplorer.odl](PHXDataExplorer_8odl.md#PHXDataExplorer_8odl) - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Directory LIBS/DataExplorer/PHXDataExplorer + +**Location**: `LIBS/DataExplorer/PHXDataExplorer/` + + + + + +## Files + +* [PHXDataExplorer.odl](PHXDataExplorer_8odl.md#PHXDataExplorer_8odl) + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_index.md index a1119774ad..eb328c8afe 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/dir_index.md @@ -1,16 +1,16 @@ -# Index of Directories - -## L - -* [LIBS/DataExplorer](dir_4c5da7dd69977c70a414920e45f0e4dd.md#dir_4c5da7dd69977c70a414920e45f0e4dd) -* [LIBS](dir_3deb6222fdd4eb7b0f76591cf78ec6d0.md#dir_3deb6222fdd4eb7b0f76591cf78ec6d0) -* [LIBS/DataExplorer/PHXDataExplorer](dir_f8085194870fe60668985a445c75a643.md#dir_f8085194870fe60668985a445c75a643) -* [LIBS/DataExplorer/PHXDataHistory](dir_b61c1eebc2b964146e7860adc8b8cd2e.md#dir_b61c1eebc2b964146e7860adc8b8cd2e) - -## M - -* [ModelCenter/src/InterfaceDLL\_ComponentPlugIn](dir_f4b71a0ee7c6b8122721a969fd158e55.md#dir_f4b71a0ee7c6b8122721a969fd158e55) -* [ModelCenter/src/InterfaceDLL\_PlugInMetaData](dir_254da5db084e40f61f0f3ecf2de92ae0.md#dir_254da5db084e40f61f0f3ecf2de92ae0) -* [ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn](dir_6384486296a61296aa9794364431ed6d.md#dir_6384486296a61296aa9794364431ed6d) -* [ModelCenter](dir_e61251abb0949c61ea8ea7dc5fba4af2.md#dir_e61251abb0949c61ea8ea7dc5fba4af2) +# Index of Directories + +## L + +* [LIBS/DataExplorer](dir_4c5da7dd69977c70a414920e45f0e4dd.md#dir_4c5da7dd69977c70a414920e45f0e4dd) +* [LIBS](dir_3deb6222fdd4eb7b0f76591cf78ec6d0.md#dir_3deb6222fdd4eb7b0f76591cf78ec6d0) +* [LIBS/DataExplorer/PHXDataExplorer](dir_f8085194870fe60668985a445c75a643.md#dir_f8085194870fe60668985a445c75a643) +* [LIBS/DataExplorer/PHXDataHistory](dir_b61c1eebc2b964146e7860adc8b8cd2e.md#dir_b61c1eebc2b964146e7860adc8b8cd2e) + +## M + +* [ModelCenter/src/InterfaceDLL\_ComponentPlugIn](dir_f4b71a0ee7c6b8122721a969fd158e55.md#dir_f4b71a0ee7c6b8122721a969fd158e55) +* [ModelCenter/src/InterfaceDLL\_PlugInMetaData](dir_254da5db084e40f61f0f3ecf2de92ae0.md#dir_254da5db084e40f61f0f3ecf2de92ae0) +* [ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn](dir_6384486296a61296aa9794364431ed6d.md#dir_6384486296a61296aa9794364431ed6d) +* [ModelCenter](dir_e61251abb0949c61ea8ea7dc5fba4af2.md#dir_e61251abb0949c61ea8ea7dc5fba4af2) * [ModelCenter/src](dir_cb6cf9700ae02fb10e39761559b5fdeb.md#dir_cb6cf9700ae02fb10e39761559b5fdeb) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/file_contents.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/file_contents.md index 0a29d7a39b..484d857c4c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/file_contents.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/file_contents.md @@ -1,8 +1,8 @@ -# Files - -* [PHXDataExplorer.odl](PHXDataExplorer_8odl.md#PHXDataExplorer_8odl) -* [PHXDataHistory.odl](PHXDataHistory_8odl.md#PHXDataHistory_8odl) -* [ComponentPlugIn.odl](ComponentPlugIn_8odl.md#ComponentPlugIn_8odl) -* [PlugInMetaData.odl](PlugInMetaData_8odl.md#PlugInMetaData_8odl) -* [TradeStudyPlugIn.odl](TradeStudyPlugIn_8odl.md#TradeStudyPlugIn_8odl) +# Files + +* [PHXDataExplorer.odl](PHXDataExplorer_8odl.md#PHXDataExplorer_8odl) +* [PHXDataHistory.odl](PHXDataHistory_8odl.md#PHXDataHistory_8odl) +* [ComponentPlugIn.odl](ComponentPlugIn_8odl.md#ComponentPlugIn_8odl) +* [PlugInMetaData.odl](PlugInMetaData_8odl.md#PlugInMetaData_8odl) +* [TradeStudyPlugIn.odl](TradeStudyPlugIn_8odl.md#TradeStudyPlugIn_8odl) * [ModelCenter.odl](ModelCenter_8odl.md#ModelCenter_8odl) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/file_index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/file_index.md index fee12ed0fe..c083b3f482 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/file_index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/file_index.md @@ -1,19 +1,19 @@ -# Index of Files - -## C - -* [ComponentPlugIn.odl](ComponentPlugIn_8odl.md#ComponentPlugIn_8odl) - -## M - -* [ModelCenter.odl](ModelCenter_8odl.md#ModelCenter_8odl) - -## P - -* [PHXDataExplorer.odl](PHXDataExplorer_8odl.md#PHXDataExplorer_8odl) -* [PHXDataHistory.odl](PHXDataHistory_8odl.md#PHXDataHistory_8odl) -* [PlugInMetaData.odl](PlugInMetaData_8odl.md#PlugInMetaData_8odl) - -## T - +# Index of Files + +## C + +* [ComponentPlugIn.odl](ComponentPlugIn_8odl.md#ComponentPlugIn_8odl) + +## M + +* [ModelCenter.odl](ModelCenter_8odl.md#ModelCenter_8odl) + +## P + +* [PHXDataExplorer.odl](PHXDataExplorer_8odl.md#PHXDataExplorer_8odl) +* [PHXDataHistory.odl](PHXDataHistory_8odl.md#PHXDataHistory_8odl) +* [PlugInMetaData.odl](PlugInMetaData_8odl.md#PlugInMetaData_8odl) + +## T + * [TradeStudyPlugIn.odl](TradeStudyPlugIn_8odl.md#TradeStudyPlugIn_8odl) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/global_contents.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/global_contents.md index 0f0f304ed8..c9ba9c82be 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/global_contents.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/global_contents.md @@ -1,1531 +1,1531 @@ -# Contents - -* [PHXDATAEXPLORERLib::\_DPHXDataExplorer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer) Interface - * [author](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a8acab1f7a5d2caa0ab47d0d74247497e) Property - * [description](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a29b8b160371c7db191f6e3dd0e1fc414) Property - * [displayName](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a5f8b196a046e313bc7d50d6ac80ec29d) Property - * [id](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa3402e5d6822ebe510cc7fec192d5094) Property - * [id](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a75bed8e4832c534f7d7842ec7921e652) Property - * [associatedModelFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a145b2ba8b5de9c0bac5b0ac89ad7f960) Property - * [associatedModelFileUUID](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad91c318a844622c7673df74c0f92128b) Property - * [creationDate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a4e0ab1e84c6e9f6ddd62ec774c75f42c) Property - * [tradeStudyUri](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aefa05eb2c41402bebce7e388d06d08e8) Property - * [isVisible](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a876e3d3fad4e109897eb41df8252cee4) Property - * [getNumPages](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a389bca42567d788cb1c1c619a400109f) Function - * [getPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a3da50454f5e424f4aa3971d84f7387c4) Function - * [addPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af65679f9d81fa741896f22fb959f81d1) Function - * [removePage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a75118395c50e7e2dc424d3f3eeba8fa6) Function - * [movePage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa890fee8f830a7ca7e04840962c2cece) Function - * [selectPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2110d97cf0636bd118ea3197ef9ba134) Function - * [getSelectedPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2dfa9fbb916798751f0fbac5ca3d2fa8) Function - * [pageCut](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1925e33cfa2ae4e284cef4b8255c92dd) Function - * [pageCopy](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1241ff0682653a4b92dd9b6064d0bf42) Function - * [pagePaste](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a08c390d4e7e3ff7f93a60283464c7826) Function - * [invokeInsertPageGUI](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a0f0eb77a79bbc31706335b91e6a2923a) Function - * [toXMLFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a889efcee9f2e90cf7de94b3d521f4cdd) Function - * [getPageType](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2e8a2fc452e5d1bad94bedf2edfe3ca5) Function - * [fromXMLFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a4ea300c891cc45556fdd4b1e7988274d) Function - * [toXML](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1afc2dbe6d642993070f320d76f0b1f6b6) Function - * [fromXML](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aef1e4bfd5cd8b8e28d6e26b06483629f) Function - * [getMenuItems](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1c15433a3ca058372e666abbaa1e1fa6) Function - * [invokeMenuItem](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2a636f7492de925506cd78a80e37deca) Function - * [isMenuItemEnabled](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a23f32ddd6ea2d2d268351327a03e46b5) Function - * [updateThumbHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1adda950ce0660029538ab7bdb541c6f2c) Function - * [getPageSetup](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ac36fc1456cb55f50ccf9046d617b7187) Function - * [exportImage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2dc01f47f79342cc3893c66a8be1fb12) Function - * [multiPageCut](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ae2457af6aec2f86ffb328421ad2051e7) Function - * [multiPageCopy](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1eca7b9ded4f6956ccfa95b11629021d) Function - * [multiDelete](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad9dc21008ad2ddd47dfc339328d454da) Function - * [loadTemplate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1945a9df23ff32406e48f560a14ea592) Function - * [saveTemplate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a3919d10a314c536703149f6377f7f924) Function - * [toXMLSaveContext](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a9ce95b6c36069c784ea2389d85dde7ec) Function - * [fromXMLSaveContext](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a237c798449d1bd63e69905b53fe17d06) Function - * [show](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad1f82e4921ee4c4db89b43fe92bf171d) Function - * [hide](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1adcc3bc6f74b07b516bbc98361b36d4d6) Function - * [getPageTitle](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a91b7a788be45f38d1cea9579731e794c) Function - * [fromCenterLink](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab68593eb479ef9f2684e7e8e683ed0bd) Function - * [ignoreDefaultPlotSetup](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a0c7a09c2192beadb073ce041aa0e8893) Function - * [setupPlotsPre](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a21238a932694565dbf0e2115c80ae59b) Function - * [setupPlotsPost](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2f726b811f8e11e39612bfd8b082ef68) Function - * [showGeomTooltip](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a89fb0170b61fdd2e320c52a8b370e99c) Function - * [showGeomViewer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a7d467a6fb859b8cb7f63c04f84f75dfa) Function - * [updateGeomViewerHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab9e6e926290d9a829d5e90b17911fb22) Function - * [setGeomViewerRunID](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af1cd6cc367767eafd9ee19b54cac0305) Function - * [updateComparisonViewHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad687c055e59a0bb50aac411174fa9a70) Function - * [isMenuItemChecked](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa6aabcb973d32ab328fa815d38d2da7f) Function - * [removeFromComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa30551e6356933878904d49df1239bd3) Function - * [addToComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2b46272c7cead32a5f75319eecddbc87) Function - * [addRunsToComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a7e608fa73c8645388956a6c1538438af) Function - * [getDaXType](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af8150d8d7d5f6fc37eb3bdf0a27fc817) Function - * [getDaXFormat](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2559ee7d7f32bbcebd0d18bb145bd012) Function - * [ensureRunDataAction](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab5a2bb675d76aca81691538b7ef55ef9) Function - * [getKeepalive](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa49db3c3a511089125f6ce44a1ec838f) Function - * [getHWND](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a27e733b7b61329799abe081c40b00394) Function -* [PHXDATAEXPLORERLib::\_DPHXDataExplorerEvents](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents) Interface -* [PHXDATAHISTORYLib::\_DPHXDataHistory](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory) Interface - * [suggestedIndependantVar](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3b5732bdccab13e2a7ed55c852d4c55b) Property - * [suggestedIndependentVar](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a1713976f65a0fdc2d37e9606bbc8672b) Property - * [suggestedDependentVars](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae1e8705d32948c759d3ab3e59bf6306b) Property - * [suggestedCountFrom](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a07162878a7dcf1c2a6ea41a56c9ddb6b) Property - * [id](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a1a709440522385b3161831eea313c15d) Property - * [centerLinkServer](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a226709acf22397c41215acd7f0ab0605) Property - * [centerLinkRunMatrixID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a61514463a5c0f82163d4789cd9e60f8a) Property - * [centerLinkJobConnector](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1af8f87624e919e067935bb5403261b63f) Property - * [centerLinkQueue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aac2a1a4d2bc65319ac7e94f0f20368b1) Property - * [dataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a4c0b3167dd18062593fb1a221bce40af) Property - * [warmStartStudyComplete](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac68974459907dcaf6b35ea631bba2801) Property - * [tradeStudyModelFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aeecce56460ab6c1c203c9d56433f4371) Property - * [addVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9a819127adb7f83be0acfa4e79f4643d) Function - * [setNumExpectedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a8ee93fde7260e85a34331b2c32a1289c) Function - * [startRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a74028f784809522e15bf71133d8fd23c) Function - * [endRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a0576632449bf05bc8b0274fb341a3332) Function - * [getNumFailedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac08c8abcc799991d7b12548ae1172378) Function - * [getErrorID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a90e9fc9cfb0d469c4169504e6f2c9cd4) Function - * [getErrorMessage](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a876302a3d26eda812e93bdd8b15bb26d) Function - * [setError](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a51fddca34fae5fbd0a5f5c858eddac26) Function - * [getNumRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a59b24c674a512a94640f4c5a890e9309) Function - * [getNumVariables](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aca767f94c4b80412c79eba62214eebfd) Function - * [setResult](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9260828e57d6cee2ec51e26dcef48ea7) Function - * [getValue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a43d806edede4bc2efa5e88c7615189ed) Function - * [isValid](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a55e6f50a94f58d4c39bb6fe06c5398da) Function - * [isModified](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1af7b8598fa12d5b516344517c0593a983) Function - * [toCSVFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a582bd6a4ad61e03070dcde9e4df76812) Function - * [toXML](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac6e672dc87278a4037bbf085b76f6aa4) Function - * [toXMLFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a7d11e224b1eaac4fab085ed9fa3d183b) Function - * [fromXML](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a1649ee497672683a575cc6cd6b78c9a6) Function - * [fromXMLFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3b65f441a218c193aae8863e6354cc2d) Function - * [toCSV](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ada3b86a293b267a74999e35c70fea775) Function - * [getNumNonEmptyRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac1ad590e863b19678c6e47ae4ff3e521) Function - * [getVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a074ed759e40eb4931c5b6e23f2c72e02) Function - * [createVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a68acd508b225f5c74c27daf848f3ae27) Function - * [isRunning](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab045302c25ef3b584eb3736b9071569b) Function - * [getNumExpectedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a250340a6fc41c19a43783cd3171db63d) Function - * [getRunName](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a42f819d3a26184898d9487b42894d4e2) Function - * [setRunName](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1adff96af9fbbb349cd4d0d69aab8a1b43) Function - * [insertRun](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab64f03fca9f43b3a491393d44c9144d5) Function - * [deleteRun](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a0be98d87ed201827314037c9100e8fce) Function - * [deleteVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1af26d20927c5ef5ccd3304b1c3ba220c4) Function - * [getFormattedValue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a45bea3dd1938199a0846f46c3d024503) Function - * [setFormattedResult](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9d98950fdb4e2e3f07519c40580c8ae9) Function - * [getNumCustomVars](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a0b2e2ab12279325bc63b9db7330d6bab) Function - * [getUniqueID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a01538f2f06fba2512c31fb7a35a04b4d) Function - * [getVariableValues](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a03fd55d685a75a6041202d00e676e052) Function - * [createDesignVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1adb61a037918e5f45dfc6a43541023970) Function - * [addVariableAt](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a156c9828bc7c8251e68886297349ccab) Function - * [setVariableValues](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aff837e76c92ab15ac33eebfe3f348c99) Function - * [isHighlighted](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a81c862c59a3b280376afc1b9bd221116) Function - * [highlight](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a77749479f2bbdf8caa1f90119e6112fd) Function - * [getNumDesignVariables](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ade57b335d32a772b6de31d129b6374bc) Function - * [setTradeStudySetup](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1acfc1654be0cc6fbe5469b487f9576bb9) Function - * [getTradeStudySetup](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a5f068466f0c9b18f8ba1681d97c2ddf9) Function - * [setTradeStudyType](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a7e9c912ffb74926c67437bf50b8b944f) Function - * [getTradeStudyType](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9f51a8f280c8bc80f4cebcb9de40ab5e) Function - * [setShortVariableNames](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae53e12cca23a7988b0d8c7dfdbe14308) Function - * [setRunValues](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aa6fcc8d517001f5b1e1c2b4cb9d6a95c) Function - * [getFailedRunIndexes](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a2acdef5238b168dae7f3294ba1629c77) Function - * [toXMLSaveContext](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a21df6ed38dc18c8cc9054f40f1f9daaf) Function - * [fromXMLSaveContext](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ad00d42b514b490170b0d28930b4bd32b) Function - * [getCompletedRunIndices](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a434f332ecfce0734f8f940da4b722cc6) Function - * [isRunComplete](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ad0d48129784f8ce140ff3dfb76ee8ba3) Function - * [addCheckpoint](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9e6d72c9c2f589323e745f69426aaefb) Function - * [getNumCheckpoints](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae1070b5293d700b8e095477fbb54b80c) Function - * [getCheckpointValue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae28168a3a789a8d8c2413e6c58c635d0) Function - * [getCheckpointRunNumber](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a71781fe2343b7ef49d1fb80ed91d295a) Function - * [setUniqueID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1adc572aab955548292d15997e1b519434) Function - * [getNumCompletedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a023f64de843e0e97d47e37b9cfbac5ae) Function - * [getCompletedRunData](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a76a5d19e76fdfe69e61d6910917acb32) Function - * [getHighlightedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab7998245db9550b3e7c21a25b37ce7bf) Function - * [setHighlightedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aea1fd966af29d2f3d0f7d95ac8f93ce3) Function - * [addVariableStructs](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9bf37e7831e0c32cfe17225f019c9cc4) Function - * [fromCenterLink](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3ff1b9e535edf561dfa7f575814f1792) Function - * [setUsernamePassword](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab6b36fde7ab38b09357add72dcbaf225) Function - * [setResultAsFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a8fe368442becfe48a2642b16d9a73e3c) Function - * [getDatabaseFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aaecbc010eb87c6a2fbe894a646d83a4e) Function - * [setDatabaseFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae38c2eeccd0c6e3c6c2e68063bd7008a) Function - * [removeAutosave](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a222463b648be93775c026887adf9d75f) Function - * [getVariable2](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a03430a06338ca51c6f5c45421a47f320) Function - * [getVariableTempDir](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aee367d3da3f483f1d9d476e832c7bb9a) Function -* [PHXDATAHISTORYLib::\_DPHXDataHistoryEvents](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents) Interface - * [variablesChanged](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a9a2402c1679d7707f2f274399276107d) Function - * [progressMeterChange](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a2f121535f7eedf77ce9e6edb9b512a51) Function - * [progressMeterStart](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1aca4688267a060ab301972886d0c04d6e) Function - * [progressMeterStop](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a0fb85ceb307de0a1c2a449be77890447) Function - * [dataChanged](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1aa6f5dbeba5082e060cb68696cd07d44f) Function - * [progressMeterEstimate](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1af43f03e636994de756db750668ac86d6) Function - * [highlightChanged](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a84baf9536c489fbb318a5e13cbf6fef5) Function -* [PHXDATAHISTORYLib::\_DPHXDataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel) Interface - * [canSaveToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a3123522cb86b3daa95c56f60b99a4f9e) Function - * [saveToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a6efbbc76935609344ddfe8b48eaac5c1) Function - * [canRerunRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a080673db51fe153fd870e46b9dd4f221) Function - * [rerunRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a2d1c0808d8fcdfe748d3194c45eda87a) Function - * [closeDataHistory](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a9ead478fc2486a3ac01b73ee8b3962be) Function -* [ModelCenter::Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) Class -* [PHXDATAHISTORYLib::DataHistoryVariableMetadata](classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata.md#classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata) Class -* [PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct) Structure - * [name](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a539d4b4f21c4c53505a6c39534fb2c3f) Variable - * [isNumeric](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1ae0822979f6b70670a347c98c67d367b2) Variable - * [isInput](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a1f4709d547b2d872fd404f7fc5b6566a) Variable - * [isBinary](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a121de67cd4278a5b008d416a2579bcf0) Variable - * [isDesignVar](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a09f46ea4820a3341554e2bad9a052f7e) Variable - * [equation](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a32fdc64aa5113896a4a962a5c3cbaf93) Variable - * [format](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a5d2b591cdaa6ce26e344f11ab6e1b76f) Variable - * [type](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1ab613172a10fa02c2756813e75944536a) Variable - * [units](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a48e1dedfd188d030f71a196434ebaf3b) Variable - * [fileName](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1aa624273f5c3fb5af9baa0272caa971e0) Variable - * [geomScript](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a8f89e59faab48afc96e4a0dde2f457c3) Variable - * [enumValues](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a3388bf5cf3b1f7de69b343b81669e6ff) Variable - * [enumAliases](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1ab0241db307b35f1e5d19adbd2d1f17df) Variable - * [lowerBound](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1aa8335d587fd45435098d82f59751071d) Variable - * [upperBound](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1aeda7394339c56c5493cfad15d26b0b3e) Variable - * [customMetadata](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a5e4dfb223db7287d798efb5b8078a3e2) Variable -* [PHXDATAHISTORYLib::DataHistoryVariableStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct) Structure - * [index](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a331317f8f767933429cce81e8ada5385) Variable - * [varValue](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a44619a37f14a5ff181483dcf993d1424) Variable - * [isValid](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a55153c5a8cc53d611839b0b55bb3e8a2) Variable - * [isModified](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a0e1c5e9cd74d1f2516fc1d35eea45b17) Variable - * [metadata](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1adad4bb3cc571df3df8a8df37d634fe72) Variable -* [ModelCenter::IAddToModel](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel) Interface - * [prevalidateInputs](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac59a55cf1a42f612e494d429c3879595) Property - * [autoRun](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1aa714911e950223667ee525a435b00b7a) Property - * [addToModel](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a58f5f3bc676a7c683ea4fc9b531d608f) Function - * [updateComponent](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a7f5a3a1914714827435dfd59e9be5e32) Function - * [getComponent](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ae5ee8b89f3b20182eb2ab707460fe751) Function - * [getRegID](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac0dd856b24d06484c6ded0aba0199016) Function - * [addInput](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a62816c713535ea573159c78f709aa04e) Function - * [addOutput](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a073c5f4a93c492f05fe361ca1799974e) Function - * [getProgID](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a0b7490ab8fe0d89e8ecb6478cfbee8e9) Function - * [setAuthor](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a0799afa68197fad61909e0a271e28993) Function - * [setDescription](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a04419d1a39017fa8f13b83720fdca196) Function - * [setVersion](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a13e4e0a07dfd282fa44afcb16c06aac8) Function - * [setHelpURL](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1af83b75cc2e88ab4935fdbd04e094bc21) Function - * [setKeywords](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a1cafe3fad847bbafcea6adc616c2f97b) Function - * [clearBusyFlag](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1aa73cb2b559ec21ef817b241e7f943e8a) Function - * [addToModel2](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ab0bc1abd000532d2d89d6179868431fc) Function - * [setComponentRequirements](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a0b44c7a2dbdcac528e00911168a8ae05) Function - * [setIcon](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ad14bf669563d84f430c220a1bc1bd94c) Function - * [addMethod](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a1ef6ce942ff5def3c8faa1c4d6d52106) Function - * [addInput2](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a915f8989fd54300d4ce830d37c2682bf) Function - * [addOutput2](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a34633d249d8fd7b02a28c3158c6dbae6) Function - * [addToModel3](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac2d1861e463ef89757948bb091502dbb) Function -* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) Interface - * [hasChanged](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad7310b48379f9d4f8d4688d11ccf0185) Property - * [hide](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac7ae926ce6dea385cb26901c86c7fccd) Property - * [OwningComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aab060b2f29895c77882494f7194f55e0) Property - * [size](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a9a38726b51caed75a30ae66b82959f64) Property - * [autoSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aca63a47369d69cbbf53532286b64a611) Property - * [numDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a29af128098031d3d75f20bb0fafe633a) Property - * [length](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af118bdf4b120050d6700a7ceae7f5bec) Property - * [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) Function - * [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) Function - * [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) Function - * [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) Function - * [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) Function - * [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) Function - * [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) Function - * [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) Function - * [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) Function - * [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) Function - * [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) Function - * [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) Function - * [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) Function - * [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) Function - * [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) Function - * [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) Function - * [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) Function - * [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) Function - * [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) Function - * [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) Function - * [toStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a37c622ae9f50579f714ce98c0379cd98) Function - * [fromStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad23f4082662c464be07251d6d1695a2d) Function - * [toStringAbsoluteEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a2e3041440581aab716c684fe88d2ee87) Function - * [getLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) Function - * [setLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) Function - * [setDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) Function - * [getSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a3d171136e0b219dd4e2d0d1b4bb9aa1f) Function - * [setSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b7b41ca5463a86aecb2368d73464c0e) Function - * [getDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a83abe70ccf5e8a0a582748d84e3d7956) Function -* [ModelCenter::IAssemblies](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies) Interface - * [Count](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies_1aee7be5ec0b95eaea973eb669981b4804) Property - * [Item](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies_1ae6f3debe976f58187639b34a900ea2b1) Function -* [ModelCenter::IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) Interface - * [Variables](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a88d34960f336b71cc7f4beff3b4bbaba) Property - * [Groups](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a1e5ca5f83e7c3debe3d63366948ad894) Property - * [Assemblies](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a00afe3dedbc3bb8b8a1cbdf5bd6333a1) Property - * [Components](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ad4c0ef9792a2f760b3639357126e56f6) Property - * [iconID](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1af8ddf59c545db7695b90a2a64bdcc822) Property - * [IndexInParent](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a6e888824a16134a6797ec96745c9dd4f) Property - * [ParentAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a8cccd51f677c2d7c29c734a2c1009f45) Property - * [AssemblyType](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a12692b24f7c9fceec97847b204afecc4) Property - * [userData](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1af405572d6c2bafc56164b2ce5b97b1a3) Property - * [getName](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a4b41d24972378517a23efafc6a0fc403) Function - * [getFullName](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1aa62ac6d1100f85d3f212185812a9e517) Function - * [addAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a1a55454ec16eadd67d23a8e134fccce7) Function - * [addVariable](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1af05ab7c452794c56cc54d77113cefdea) Function - * [rename](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ac180bc4a2120cd22964998c75eed05f5) Function - * [deleteVariable](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a92a8b6a732ebcd29f6fb33a448f9f4c9) Function - * [addAssembly2](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a1c73a3675ee4a70e9b31d2f63c86e630) Function - * [setMetadata](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1aa1e66114f498d0a1238237ad6caa1348) Function - * [getMetadata](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ad0ea6a9bc76c34b8158454e27bbfd9b8) Function - * [getPositionX](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a476766c4bdcb9fb07f1fdd0a12a04ac0) Function - * [getPositionY](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ab58695afb7a8ecb8202a1b20011d384a) Function - * [convertToSubmodel](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1afc8d8acd50c53726272ce0c983aa640f) Function -* [ModelCenter::IBooleanArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray) Interface - * [hasChanged](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a5231acb6d280e70ecf75f906a357e3b4) Property - * [hide](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa6cabd1afd2f36f8e431da7342e9bdb7) Property - * [OwningComponent](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a22fbdf9f77a399b4c536aa78bcd826bf) Property - * [size](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ada4924e975e5e04d2c6f7104f2626212) Property - * [numDimensions](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a3edf21f87f8614c2b603aafba6f10cd2) Property - * [description](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ae3788aac4468e5c4d62e002663e8e729) Property - * [value](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aafaaa11ebda98ac168f489abd5385422) Property - * [value](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a71678d5b3009123d0401d7715c5dcdf6) Property - * [isValid](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d13fb275a266aa85280b6beed8be176) Function - * [validate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa221cef15629c5acf569329c0e089b3a) Function - * [getName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a471100848db5a6f0c08f2920aa283ac6) Function - * [getFullName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a498741fde4d9eeec6eb3f8171e3161d8) Function - * [getType](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad8d2b43dd9f4b3656dba1e8570f7f747) Function - * [isInput](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa87e846de03852ee40e909935c2ec470) Function - * [toString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a39294beb6d830e498ee8aca7a25cc4a6) Function - * [fromString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1af5d6c192774673f4f4bf7514b35f8ccf) Function - * [toStringAbsolute](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa07f73fa1f449045d77725b0fef00739) Function - * [invalidate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a04e162fdfae6e99e6dcfd926adfca7b1) Function - * [directPrecedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a605c25813e75d1709e364eef080f68e9) Function - * [directDependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a6ed20fe44044c682471c7066ae2bd303) Function - * [precedentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a428a6e6a2a2be52d77bfe96323fea64f) Function - * [dependentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1abadb81820fd0b415fa9e78ce6c867c55) Function - * [precedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d7349a2273e5b9eaaab5271918eed6f) Function - * [dependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a386477ffe54e2d0f351f9dc7fbb49712) Function - * [isInputToComponent](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a871c46c1f732b2885e2ef1fa2080a3e8) Function - * [isInputToModel](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a364726a017aca71bdb22d43530cc9426) Function - * [setMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a772ffc624a737a4808eb8dfc9ff41e0d) Function - * [getMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa6b44db219dbaf49be81841dc459f4ae) Function - * [toStringEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1af151b1686dbe379f876131afd8c2c71e) Function - * [fromStringEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a8d7b18dca2bbe96aa0ee3718e433e272) Function - * [toStringAbsoluteEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aaa425c05112e2f9568bb13886800dbba) Function - * [getLength](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad9da4a66a831de9a501a7aca13a6a84f) Function - * [setLength](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a2bf47781f038fae8dc22e6edb04149a9) Function - * [setDimensions](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a6a526c3b8680b1f5ececc326a340d14b) Function - * [getValue](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9aa72924449a81d937830715bbe7503e) Function - * [setValue](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa3bdaab478a67db1dd4cb7921de5ed72) Function - * [getArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ac522da7a239f7d74e52a445351e5996a) Function - * [setArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a783239a87a41ba31461d61df639dd5f4) Function - * [getValueAbsolute](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad975bca587185786df34ddd600d7fe96) Function -* [ModelCenter::IBooleanVariable](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable) Interface - * [hasChanged](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a5b428150a22e87af248e5fc3277c70ae) Property - * [hide](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1aa3a5fa8309ca19d0bf787bbf7cbcbf54) Property - * [OwningComponent](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a67bcc3bdedde454663601bb945dd5bff) Property - * [value](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a025854ed57fb252dde2b341182cd7e7a) Property - * [valueAbsolute](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a875503e8827a33a2d15497b21c50b840) Property - * [description](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a8035fb2b8276762f7b0b2b3e8b7d8cf5) Property - * [isValid](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a877899b0c2bcc8400bcd8cfa31c4eb7a) Function - * [validate](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ae3cb5f6c787efb879f5d85a5ee5ee344) Function - * [getName](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ac4595a4a7f2b81c6c5c2f1f5e3742f56) Function - * [getFullName](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a19c8cfbcba0c9fc8eaae14bfaaa07d39) Function - * [getType](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a6e68844292a9f0b5e1924728465d02c0) Function - * [isInput](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ab8445c95fe06a4eb82ed55034c26d34e) Function - * [toString](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a97263640728fae5de92a272345ce0a01) Function - * [fromString](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a8b9fd88143b7b23e5f3ae9e229774a2b) Function - * [toStringAbsolute](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ad3fdc29d883580eaf57b83a7b796c703) Function - * [invalidate](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a1eecc6708b4fb8e29bfe73ead410adaa) Function - * [directPrecedents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ae54cdcd132e22278b8ddb00aaff236c7) Function - * [directDependents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a40dedf6b7b841a6699d545ea058ad2cd) Function - * [precedentLinks](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ab5b740c028c3b878f1341efea2df0116) Function - * [dependentLinks](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a69e716f024970454d8c555c73df17360) Function - * [precedents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1aa43bd8ee475029fc466b20cd3b1b686d) Function - * [dependents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1afa6ea6f99c9eeb606ebe08b1e7d9c54d) Function - * [isInputToComponent](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1af27600cef7dfba2a97acbeb31e2bbe43) Function - * [isInputToModel](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a38875f7d7b47980f4d78d76a449bbb01) Function - * [setMetadata](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a6771c11a9e1388bc4da11b9fae91e2e8) Function - * [getMetadata](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a74eae8f0c59826ea05228abfc9a9354a) Function - * [setInitialValue](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a37b148f160421cc772d96d616cc58a67) Function -* [ModelCenter::ICachePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin) Interface - * [Url](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1a8dcb7034aa38f98bae308f4a9425ee43) Property - * [LocalPath](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1abfc95b5a36c4544b8f58aaffc0d74751) Property - * [IsValid](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1a6dd8e8226f7d5b089ef7e4ae49ca8b87) Property - * [releasePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1a4349fd2038cad3cc22e04eba3d9effe5) Function - * [checkinOnFlush](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1af839cced75ed11439b0027a55c6ab604) Function -* [TradeStudyPlugIn::ICombinedPlugIn](interfaceTradeStudyPlugIn_1_1ICombinedPlugIn.md#interfaceTradeStudyPlugIn_1_1ICombinedPlugIn) Interface -* [ModelCenter::IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) Interface - * [Variables](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aad57025fe620abbaae1543962ed2676c) Property - * [Groups](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a4393774e2d80bd06dfe8070ef87b146f) Property - * [userData](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1ae7e1acce8fef11c88ba939aba11604ee) Property - * [AssociatedFiles](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aecece7b57424f027ba567415051d3bb5) Property - * [IndexInParent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aafafc5168a78769e88de4505174b0daf) Property - * [ParentAssembly](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a2da9bef2e46c87080698e624d80710f0) Property - * [getName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a19763f04596904ff5cab2f4f72f6f501) Function - * [getFullName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9309a89032b2d7d28baf279a3b76b5e8) Function - * [run](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1adf60ad0c84852250f14d27cfa689d8d0) Function - * [getSource](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a7ee6752f95f3bdfbe83132a3a7794cb2) Function - * [invokeMethod](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afaddb2c21be03b26716594af883a51ee) Function - * [invalidate](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a73c230184c72f5abcb7d3af5f91c9d1e) Function - * [reconnect](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a44d641cc9d4a797f88e56495c466479c) Function - * [downloadValues](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a761c665246557b5b4201873a722d6fed) Function - * [getVariable](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afb270ae53383589c63f87b4e3385f128) Function - * [rename](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9cae71e48e01e94d48c0353d3db4d90c) Function - * [getType](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a04395c5a8d6ceff26ae08e6c001bdd45) Function - * [show](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aa35c0fb45f677b3c2daf475e53107773) Function - * [setMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a41eb816b08e0e89739822ba87e5416c6) Function - * [getMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a2bd6e585619f4cd76426932b62dcf60a) Function - * [getPositionX](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a0c3e0c952584ba25801114e01010eab0) Function - * [getPositionY](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1ad3da2b98a973112ea897cf3b146f0276) Function -* [ComponentPlugIn::IComponentPlugIn](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn) Interface - * [construct](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1ace85f5a1c843051fe7513c591c373164) Function - * [show](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1adeb4964522dc6e485c3de4bef39a9019) Function - * [toString](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1a14fe2c260d7d43a7f6d1cf661a34189d) Function - * [fromString](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1a3e35deaee9587905584aa8926b2076de) Function - * [run](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1a8745a0b6d995a55b708876bcf0b6d7ab) Function - * [onEnd](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1aa280f5643ed0afe304a3ea2556b41159) Function -* [ModelCenter::IComponents](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents) Interface - * [Count](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents_1a657951d45a2e5d44a882ecc04e4abbae) Property - * [Item](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents_1a497784a98d679aa2ed109130ae004e0a) Function -* [ModelCenter::ICustomDesignPoint](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint) Interface - * [addVariable](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint_1a3c20c3bc3fa7ae5fb36154448d3ae13d) Function - * [runFailed](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint_1a7c8bc37e4f17ff29cc066d8e9645d9dd) Function -* [ModelCenter::IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) Interface - * [isVisible](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a986646a10f5885304323ceb7a737c76b) Property - * [storeCurrentDesignPoint](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aed3d0ea61e181d39e6bbf38a5ad0a401) Function - * [enableGraphTab](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa2efe037d15784acff1d3291c482f276) Function - * [show](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a2dcb6077094c93a8484123a0c5633dae) Function - * [addCustom](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1acd3adc12cd4f94a2dbf436e8617cbf8a) Function - * [selectX](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a54fca30f8b9b840cd4d130fffef89ba8) Function - * [selectY](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a82393da70a02822d7184a81430f45b94) Function - * [setNumExpectedRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a2760890872ed478c72439fc063f4e9aa) Function - * [startRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a4c2a3c1d083373801689d9dacc1fd530) Function - * [endRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1af2b0ccb145e2775fc9958d3500cfb4bc) Function - * [getNumFailedRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa169d7ec12253068db8fac00e201f6a9) Function - * [getErrorID](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a5fac36a5e20d349ab8941387af60a576) Function - * [getErrorMessage](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1ac93c96f43f475bc237f396b717bc5408) Function - * [getNumRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1abe6a941ef83e86184ba40149f775d3f8) Function - * [getNumVariables](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1acaa00471b667aa04d3462fa4e26f8d36) Function - * [getValue](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa3502b40206d864d5bebd8cec59c71ed) Function - * [getVariableDescription](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a12a4f4daac61b17022aa54dcbb3ec84e) Function - * [isValid](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a2d858bdac93de126a13ced552898b3f9) Function - * [save](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a7d30505236a3c1c3b804da8f7f924e26) Function - * [exportToCSV](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a75c4f95d0b30e6edb92f98e378f7c4be) Function - * [toString](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1af9938e6a1943072ae9e89a19e4461a3f) Function - * [fromString](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a42e57bafd047e98fff2902f213c48f61) Function - * [getDataExplorer](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa0b0a16e2c3c1f600a8435d6dca0c096) Function - * [hide](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a75d77af56d17b13040ea831d957a4cab) Function - * [enableCarpetPlotTab](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a1e13b83ec71a3274399832bfe3471364) Function - * [storeCustomDesignPoint](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a0beef1e5e859c093f079e64792e9ed8e) Function - * [createEmptyRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1ab152e50d67d452b3f301ea18f732183d) Function - * [setCustomRun](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1ae0c7fcaf40dc9a73c3818e08fda4c954) Function - * [newCustomDesignPoint](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a04f9887e54ecdb60a1f30abbdfbf975b) Function - * [enableMainEffectsTab](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a11a172f0d359597318448e52fd991843) Function -* [PHXDATAEXPLORERLib::IDataExplorerFacadeOwner](interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner.md#interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner) Interface -* [ModelCenter::IDataMonitor](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor) Interface - * [getName](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a69e3af3092c78b0c19d9e3fb719f9b4b) Function - * [setName](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1afbfd0ce277fb01a5539d791b371ab0de) Function - * [isRenamed](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1add033400b2b1694d63f67126639c198f) Function - * [getLink](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a9861b3ad530a4efbe4925c89550e8cc5) Function - * [setLink](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a89561753d60d803cc6427c6af5005484) Function - * [addItem](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a4b0569ecb495f20688d98060df763895) Function - * [addUnlinkedItem](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a8b2b470a890a2177bc1028408c7275e6) Function - * [removeItem](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a6137208858071bb7fa35bebadcbaea47) Function - * [removeLink](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ad8044ca189f473cbbf095756dd2668f9) Function - * [getDisplayFullNames](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a0cd9a14f007afaa719e20b54439ea98d) Function - * [setDisplayFullNames](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a8be2f10ef4448bc73d4dc7c57f3350ca) Function - * [getAutoDelete](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a163f13ac67226dfe0d816950061cc386) Function - * [setAutoDelete](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a19e11dabaf88dae88622b82e9e53954a) Function - * [getDisplayUnits](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ac11b644fdbd9f5e184a120a3bb6c7eb0) Function - * [setDisplayUnits](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1aeac431029c07dddd0397914f6fb4d9d1) Function - * [getColWidth](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1aa7c5595c9eabf857b3adc02d30dcbb8e) Function - * [setColWidth](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ade404d7ea696919bbc331c9027315c0e) Function - * [isValid](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1abc151c7ba70d7f1e6249942a627e2171) Function - * [getTitle](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ae6aab41ece2d9cf2ac4285aa10cf156e) Function - * [setTitle](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a74456073f4bc7e13d954972991583b58) Function - * [getWidth](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1adb51a1067e48f2e1ab9b79874a2d8a66) Function - * [getHeight](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a906ba9f57a9a472e1a70c151a50b1155) Function - * [setSize](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ad76100b2b7c20def871a1ffdc745e5da) Function - * [getX](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a610ec59f3295fe819e3a1aadd043927b) Function - * [getY](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a15d2803f54702b2198a2f0dc3f36d80d) Function - * [setLocation](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1abb2aeef39615e67a90e950314ea02744) Function -* [PHXDATAHISTORYLib::IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) Interface - * [name](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1aecd9b3210d5ef87459cb8a9830bb0f94) Property - * [equation](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a3901f5a0e0dba161b1746d3869d83807) Property - * [isDesignVar](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a6429c927c6b4f5937ed8f046ebb618dc) Property - * [isNumeric](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a72127ffab32587ffbec60628e70df2fc) Property - * [isInput](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a36394ba4430c4f15bd18a02a96ff9c00) Property - * [format](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1aee5d1b31138b410b58410abbc82cf441) Property - * [enumValues](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ac0461a8fca66f784a7f1a66b77c952e7) Property - * [enumAliases](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1af3b9b49e293ed90e0e36ac8cd64a1d5d) Property - * [lowerBound](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a559e14d8841091219ceb4c121ab8d1fb) Property - * [upperBound](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5e7eff43bb2a4ca6eed5cd8e95b0e182) Property - * [type](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ad46181f350249f42a737877eb3ce6c97) Property - * [units](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1aff5fbd1ebbbe6b3d4bd7ce114a09f40e) Property - * [geomScript](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a1fa79813f4fadc3f9f668aa5d433c431) Property - * [isBinary](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a18d61da08976eabab25b4049726415a5) Property - * [fileName](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a441ac734f55bcc3351b2e475524bd890) Property - * [getNumEnumValues](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5f133f6ecf8e21010e1a624221f78d5b) Function - * [getEnumValue](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ad6bfcac769bd40c96db19848232fad3f) Function - * [getEnumAlias](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5c03822c2d28cde3b9d0fdf4f335a594) Function - * [getNumEnumAliases](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ac865d961f3e4aa6fdb21c65f4960e7ee) Function - * [setMetaData](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a9479fcb9ffceb4360b99be62d77eabad) Function - * [getMetaData](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5c33238aa348f88bd3a7c66cde890631) Function - * [SAFEARRAY](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a34d198c9ed66b975c39ed058511a3181) Function - * [copyFrom](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ae9e54933d6dd82e4d4aa5991b58b6ee3) Function - * [removeMetadata](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a7bd9389ff771d6b63aa3643c961e7223) Function -* [ModelCenter::IDoubleArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray) Interface - * [hasChanged](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a91e412d2c7f4955e11e24099601fab8f) Property - * [hide](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a009c7abd22ec22abd5367db1a29305ff) Property - * [OwningComponent](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa2e8150c160c33946dd92d8887b57d1f) Property - * [size](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aeb3ca2a904ddc619edad7828c6c4492f) Property - * [numDimensions](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a8bf3f208059aad7bc8a73fd4e6529053) Property - * [lowerBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a396e13c98a7680bc75354b6bf6b0487a) Property - * [upperBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad4a4c720baa19775898e45381b881fcd) Property - * [description](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a59b6ea0f39cadd0ec7b20b16c8d630ea) Property - * [units](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ae91fd63ce08d3af74fb22132b5626432) Property - * [enumAliases](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a9e195b698057e2d38fbb9c101ebeb827) Property - * [enumValues](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1af625775f6fdd957bb0b37ed1c86a3051) Property - * [format](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad0078a54f0aa1ede8e3d6d78a00a4f7c) Property - * [value](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab6fd11161c6f26426d3205c88025a962) Property - * [value](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aceacfa8c1f90207042abb68d4175679d) Property - * [isValid](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a4d7719052c0b341f91436d3a0da270cc) Function - * [validate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1abc755512c485531a61f10d2bc5d691b0) Function - * [getName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe2789906f30f6a082e5d3d79e2b5bbc) Function - * [getFullName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a225331135b6efad1b05c399869975962) Function - * [getType](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a59535b93acdadae5c47ebb3f148cc8a7) Function - * [isInput](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa0a3e17384092dbeb0cef004db873191) Function - * [toString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1af417ef0e71fabce8379be30e4d176355) Function - * [fromString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3faefed33c99ee3ffb10b5e0e21d239a) Function - * [toStringAbsolute](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1adbd82fbad4622d8c2d91533d536a7ea0) Function - * [invalidate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a032e132c6c6a61f81370942921ab2edf) Function - * [directPrecedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3ab4fe76950c76fbdd2e76ea3f4fb08b) Function - * [directDependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe14e74990edda2c656035bbcd8e2af2) Function - * [precedentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a640715d1e272c8f15d8cc4c2b466d990) Function - * [dependentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a0201276e7d000c4869e4798cfdb68d8b) Function - * [precedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a5973cfc6b1e41db214568a7e95979eef) Function - * [dependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a6e0601946499c985be03e00354c8acb3) Function - * [isInputToComponent](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a86e51010b5f7765c036af36bd9452622) Function - * [isInputToModel](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a78d5b37b715d259e29e0de79fa58508d) Function - * [setMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a56d1d2b85ec3b4c43589c25887c1dd95) Function - * [getMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a1a41489453d177315ae18ef464e8907b) Function - * [toStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ac16f0cbbb0d4c51cb5cc7dfc0c251f88) Function - * [fromStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad068bdf2a8fb66fea7cfb3a3111fb176) Function - * [toStringAbsoluteEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab1252981582cec6fd3662321c9c4ce28) Function - * [getLength](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab0632e518febc3b1549fc35d932fd451) Function - * [setLength](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a5e70599413156ef04aa8ddfd03958320) Function - * [setDimensions](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a397d1abf4ecf0a106e84112b5634efac) Function - * [hasLowerBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a4a319eba200eb23b04f76abf8780c1cd) Function - * [hasUpperBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a1460ab1d3ab8aeef7679c93c07fc8138) Function - * [getValue](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a2e4c0ae7dbfe8869f56ad932ba0b22db) Function - * [setValue](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1acbaaac83aab3ce3951ed1be15ad3f6ca) Function - * [getArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afbdd49bff040a71b2be64a93e6705b21) Function - * [setArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad252c204a64ece94a946dcdd22e569df) Function - * [toFormattedStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aac1d778fd393456a7097eb9f6ac40daa) Function - * [fromFormattedStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a21c8a18bd7cb6544d526fbe1c27e72ea) Function - * [toFormattedStringAbsoluteEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ac4c96b591adc0b61b3db5eaa90c3b3cd) Function - * [clearUpperBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa1657e3679484a86e997a20256eef5b1) Function - * [clearLowerBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab93c1d5caa0fb18eb4d41499f5c708b7) Function - * [getValueAbsolute](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a2d9a833f72d05827c32edda52d0584f3) Function -* [ModelCenter::IDoubleVariable](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable) Interface - * [hasChanged](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a547bbc74c5db046b8d125cfbc3a6ab57) Property - * [hide](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac8bae6ed29215d02364f98a876f2ccfa) Property - * [OwningComponent](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ad15c38a3b89a2fa2be6e2f6b88268fd2) Property - * [value](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1aa7a7d4145814425b6ea93e831854d84c) Property - * [valueAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a364aa148101fa8ea9ddc2d624f96fcf5) Property - * [lowerBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a8d74ea79cd0203c477fa96e2410ba176) Property - * [upperBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a7585c786507e272216ec790ce278fd10) Property - * [units](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ad5b4b178eafbe9ebf4e55b3f5e158622) Property - * [description](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a491df2e849d05621978fe706bb48de85) Property - * [enumValues](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a0c6cd245f4c6bacc15398f88522a2992) Property - * [enumAliases](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a531c146537c198a1c71e5c5826757b01) Property - * [format](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a6181c6c0985068e31fdb725d719ddb35) Property - * [isValid](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1b873587774671d25664c294323beae8) Function - * [validate](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1abddc8770d26e37ac9319be5b90bc6e3e) Function - * [getName](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a10978bbb428eadf01141d2ceb2373c7a) Function - * [getFullName](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a00a7eca52d31c8f86e049dc1896d2434) Function - * [getType](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a974708d2da959d48ee301088918719fd) Function - * [isInput](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a162bb6a2a0c8cf5a2f3ee15daaaf85c2) Function - * [toString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a59f1d75b8e24323ea9bf523159f04f69) Function - * [fromString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1128d6c344adde4e9f9d95b0c19f87b9) Function - * [toStringAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a89797e61eedee333bd67b55b653ec21f) Function - * [invalidate](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a9abf6ea522bbff16d7c2266202b5bdae) Function - * [directPrecedents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a7a14b5ef10935109b178062205b91b7a) Function - * [directDependents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a6178082dc3de5e1f6665f4faebcb8c36) Function - * [precedentLinks](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a8bf056e8b989223191b2e8c7595c0753) Function - * [dependentLinks](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a385019a97e3ddbae4351fd6dd591a49c) Function - * [precedents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac65d0d53de6aee17106700d60161e9cf) Function - * [dependents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a04becbe1d34e232e21208333c0700e3c) Function - * [isInputToComponent](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a18112e5a20ca1711e97f8a5514995a49) Function - * [isInputToModel](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a34bbd8b682a39cbe120f972f0be7b1cd) Function - * [setMetadata](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a499a962844cae63886b79779e39db700) Function - * [getMetadata](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a40ecee96822db8b700fe1a814b2ab3b1) Function - * [setInitialValue](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a34b3939cccf3f8862301863629b63434) Function - * [hasLowerBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a18723d07a18cb720d07bebee26f35d2f) Function - * [hasUpperBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1aa78deb300d4f268523777fcabe898ce5) Function - * [toFormattedString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1fb28d4b74c3d0121725f15773f7d1bb) Function - * [fromFormattedString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac054c3628e2d617a1972dc195cacec60) Function - * [toFormattedStringAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac4e47bfae3990e33c748b44580244be3) Function - * [clearUpperBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1aa8846eb2c93d138bf7b6c31d78f0dc56) Function - * [clearLowerBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a72ee20ae45907f6f6738dbba0ea63655) Function -* [ModelCenter::IFeature](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature) Interface - * [checkin](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature_1a8cb220ceb67de96c199d761396bff884) Function -* [ModelCenter::IFileArray](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray) Interface - * [hasChanged](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ae8928b3be9d425c01df1a6bc1052eeaa) Property - * [hide](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ace9ef38b4495497cd17fc358d675cf58) Property - * [OwningComponent](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aa0d97988f42416ca68f47e1fecfe6e73) Property - * [size](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aed6f1989cc53493063439e96852be675) Property - * [numDimensions](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a757e103b1c6f7e5921adf31b7b1049ca) Property - * [isBinary](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a66fab48ff61be8f9c8e21bf0c9f96f45) Property - * [description](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a8be2e0c977d8808648829d523c841d36) Property - * [saveWithModel](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a2ce9625b3829cc7569fee6949e227dfe) Property - * [value](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a5b7408868a080c3d2b0b6812dc13a536) Property - * [value](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1af89ea57b9feb5597f3e190af1c8b5bf9) Property - * [fileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ac8e13d4f87d1c0b784c5ebafd030fa57) Property - * [fileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a12eb5e82033d54430ee309a0ca2ad254) Property - * [isValid](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a1d3371b70abb06b2eff5d1ada8aa114f) Function - * [validate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a506a66d66cb52b49d7385351bf0cfa46) Function - * [getName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a3f04f85ebe4f50a88c7cc3a61ae597f6) Function - * [getFullName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7aada275954e2fff6bdea69b8a96bd0c) Function - * [getType](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a6614c3d1ae621d218762e8ed8ec58222) Function - * [isInput](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9e45ea90908321e84979e5b8d2f50357) Function - * [toString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7ba909789490822b7ab12891075a9e56) Function - * [fromString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab107312b8a5b1e8e96ae2a3678ef9897) Function - * [toStringAbsolute](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ac8f43fca8b974b224bd64a78bd3bdda3) Function - * [invalidate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7599948212f77bb66f8ef42fc98e53ce) Function - * [directPrecedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9f84f73f3b65f16fa507678c53c67527) Function - * [directDependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab61572acbd0617f5c51b04b2ae4bbdba) Function - * [precedentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a998c2f1327219560aacd3d65d2c178b6) Function - * [dependentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a90373b06919789f06f52dd22a0339847) Function - * [precedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1abf61619be1e057cf2c42189456169041) Function - * [dependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1af16a20eacc6734b343762565ec8b20d6) Function - * [isInputToComponent](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a29e9bceef09e96ad83ce6c0618eb17dd) Function - * [isInputToModel](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1accf93e4a9fe2c9eb205ccdf1704f3f9e) Function - * [setMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a46a06089e51539cdb69a6404db042d28) Function - * [getMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ae315b5cc3acb88a2edabaa8eea7a6690) Function - * [toStringEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1afac8b4ceedd459ad68bed98ae18ea6a8) Function - * [fromStringEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aa104ba67a0164c27a33017aabd29d83d) Function - * [toStringAbsoluteEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a15dfd2825b183a80b93d849ce3429ca3) Function - * [getLength](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1acb6d739a4e50bcbbda5a5cf053ae21db) Function - * [setLength](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a66119cc8d733c8a2d6a8101569768662) Function - * [setDimensions](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a791424f1645b40c0b9b9d509effb1df8) Function - * [getFileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1abea033ef41f0f2ad087b24387772e09b) Function - * [setFileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab92bd8b81525ab620509e01219d733fe) Function - * [toFile](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a21c5941a7054482e4f7fd13e55db2738) Function - * [fromFile](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a83b3e976d1267ab9bb6e59be7bd741d1) Function - * [toFileAbsolute](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a118321f9f4f870bd9ec196813546b6f3) Function -* [ModelCenter::IFileSystemInfo](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo) Interface - * [isValid](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a7df18a18470a00422781d711e56a20be) Property - * [exists](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a5f79e2722103398d5f02e9fbb3c08c8b) Property - * [isWritable](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a349473cf74146c2b8c824e0c47c899e5) Property - * [baseName](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a0f840f7244ed0a52fa4d7c2a19a08264) Property - * [url](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1addbccbd60da206c6fb480eb4fe05e967) Property - * [pin](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1afc052eba4f15b6f7a62b0b0cee7b8e4e) Function -* [ModelCenter::IFileVariable](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable) Interface - * [hasChanged](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa81da335ee85ebf5f806be0b1bc1f39c) Property - * [hide](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a6c602247c4c00069af837d7dcbfb3862) Property - * [OwningComponent](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a75e79199eccdfb4f00ce0d27f2f1c593) Property - * [value](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a44a74adf54ce33e5e11d52ff561b37ad) Property - * [isBinary](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2d900fe8d944b0dceaea355cf64ba5a8) Property - * [fileExtension](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ad161b90c198e19be1132a9e5592e9416) Property - * [description](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac0f28c2d059dc02d18d3dd8eaba19f31) Property - * [saveWithModel](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a4ad8feb4200950e76e3ea66afcee286b) Property - * [directTransfer](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a248392894f6cd7f2662f29c3f110d7af) Property - * [isValid](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2d8ceabbeb9640dffb9f6a9e654bbd79) Function - * [validate](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa3fdf5883f1849f93bf87256b9100d0b) Function - * [getName](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1adbaa029c76034043ccdf2bf84bbd0e7f) Function - * [getFullName](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a5b0b8db5aec4ebfbd8e7918568c71b70) Function - * [getType](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aec7c7bb8f9e43d411c457d7b091e5378) Function - * [isInput](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a92363045c1f3285c5c1127ad149c0250) Function - * [toString](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ae28a776965df5807d9ce8b2e0d995867) Function - * [fromString](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac7654e743af45785904858d2c581058d) Function - * [toStringAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a0dda099769e13bdd8c5c076fc7d9378a) Function - * [invalidate](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2beb5e20db0843a92acf8d0cc961e3af) Function - * [directPrecedents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aea8561351c3ff1e003d463616682a838) Function - * [directDependents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a9347c073e1dc6ca62f1b3c7cd6fbec71) Function - * [precedentLinks](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a4bc52bbf01e5d0a0f95e67e03cce4547) Function - * [dependentLinks](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a46a1da5e2a3f39c2e413b520ec33407f) Function - * [precedents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a8db95046419c83467475175b216efe84) Function - * [dependents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac63897b5927f1ad28965384718c0de6b) Function - * [isInputToComponent](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a8ca654408734e709fddeb945e81a5d29) Function - * [isInputToModel](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a7bd0dbfb0063987f2484dce0cd61c8d1) Function - * [setMetadata](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ad532913f25d0b0d02cc2c27105e7ecc8) Function - * [getMetadata](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a730717369f8ddb8fccfcb3405c56afe3) Function - * [toFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa3da8eb730cd02ed21080272cc41deb5) Function - * [fromFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a9ca208f1854ac22bb31e38119e2e2af5) Function - * [writeFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac5ccf89eeca381ed315bbc4080c5df6b) Function - * [readFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a93be7b40a50c1d8b612037a105f8fd5f) Function - * [toFileAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a45afd477c357c9c3002a4046c1eefd32) Function - * [writeFileAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ae4220f9f0731a8078169bab709fb9198) Function -* [ModelCenter::IGeometryVariable](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable) Interface - * [hasChanged](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a14bb947193a4e5e629d104cadd3159be) Property - * [hide](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a1ed81bb22242904529b71361e954445a) Property - * [OwningComponent](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a9c9a3532f6f0ce9a907824f5e055e89f) Property - * [value](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ae013f10c0800acb5229f245f10d687f3) Property - * [description](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ad6ac49ae6d10a8aef6927eaad49e55f1) Property - * [isValid](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a01fe29466d2371dd25e6d9a473de32c7) Function - * [validate](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a62715d2cd23f7a7daafe7568d1a6e32d) Function - * [getName](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a2ab57d435f315c7afc7bed802b57d9d0) Function - * [getFullName](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a0b0e9f581b1b038395dacb2700d82ce4) Function - * [getType](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a09f10acb36a75c48c2cce4f1925acb55) Function - * [isInput](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a8c9a1d489060c768242c74b57e85aec2) Function - * [toString](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a0bda0cd0ea97014dc4be4ee2af69e55c) Function - * [fromString](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a710bd007c2d1df9c861a33a397c7a9d7) Function - * [toStringAbsolute](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a711f2c70a30362b587b39f5cd3775f71) Function - * [invalidate](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ac80cc84f95b559145c98a82367649d89) Function - * [directPrecedents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a8294d8120195193f3a5fba86abcded57) Function - * [directDependents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a06be08cd5896250dc5b31ec3d90b79e6) Function - * [precedentLinks](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a42168bcdab0805055df8432194d5654c) Function - * [dependentLinks](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a50e3d7ea1d97cd799c29901c2b563208) Function - * [precedents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a6d516295359de158c45bf2a5c0378af0) Function - * [dependents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ab110babf06372919f705e71b64cc733f) Function - * [isInputToComponent](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a3223f3e2305da64ecb24530ed3e1652f) Function - * [isInputToModel](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a324e6df2e0d789abb14a6ab9bbabb119) Function - * [setMetadata](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a3c257357cc786dc18d4187d14b030813) Function - * [getMetadata](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a9fa5015afd1b3cdd651ce2a0e093a6f6) Function - * [setInitialValue](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a61c5bac06b87725ae41b9a17f90b886b) Function -* [ModelCenter::IGlobalParameters](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters) Interface - * [count](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1a53be79855251a6bd40bd71f35c4f6d8d) Property - * [item](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1a1fdee032bf053c5f99b0291bf04dcaec) Property - * [\_item](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1a63a265a486f6a3a5df9cde8b65217d5f) Property - * [setExportToRemoteComponents](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1ad479e08f0fcaf6313a005c4fb3c80235) Function - * [Remove](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1ae838217b346390c972f8173e9a55361c) Function -* [ModelCenter::IGroup](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup) Interface - * [Variables](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1a6e92dee614068ff99c03164e7305119a) Property - * [Groups](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1afab9254fdafc011806a8834430af982f) Property - * [iconID](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1ab263da951c24595b88adc5b86fe93540) Property - * [getName](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1ae9bccfbc2ecd401d1f1403594c0ff513) Function - * [getFullName](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1ab1dc7ab3547d2631e64f683968bd0989) Function -* [ModelCenter::IGroups](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups) Interface - * [Count](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups_1a3bbbf56f26f76f5f051ea065aaf00234) Property - * [Item](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups_1a4a71e44eeb916bcdc8bee4ab891b237d) Function -* [ModelCenter::IIfComponent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent) Interface - * [Variables](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a377c50131d329f7fe0e1508bafff61dc) Property - * [Groups](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a491cb2ba622f73c3338ebbbe92e9da3d) Property - * [userData](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6590d1a787dc12285407656bfc22cbd7) Property - * [AssociatedFiles](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1afeeaebcaeafab038e2cc613078182c6e) Property - * [IndexInParent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a5c8b1a2d576bbdc2ea74f70b499889e0) Property - * [ParentAssembly](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae19efd7aa8ec8a537e3de7234b41ebde) Property - * [exclusive](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae32fcb5e2bd27ce4317da67ea515d40f) Property - * [runLastBranchByDefault](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6b9474faac3cad28e1a5d156438141a0) Property - * [getName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a97c817507e162f9422b2f73ab5c8cef1) Function - * [getFullName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a5766e80ec09baf80e3ad7c28e4dd3bd4) Function - * [run](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a7891e5012feff9e7bbdec3bde6adb8e6) Function - * [getSource](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae4cad8560e705e807f793a2dade750e2) Function - * [invokeMethod](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a583b809498c69beadd39c1e21e2cebab) Function - * [invalidate](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a78101d039853db9e2d989edef97f226b) Function - * [reconnect](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a67e294fa372905721460635514adcd35) Function - * [downloadValues](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a610d24ca2e023e09194b29c3115c6d84) Function - * [getVariable](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1af46fd2a7e5dda89d73e347b2fff75d16) Function - * [getPositionX](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a205b99507e64a1ad621ee6aeb6cd6d0c) Function - * [getPositionY](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6cddb9b21c6b3b60a23f2a28d60ea17a) Function - * [rename](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae64ae2e0082f2379391e6a49d5e57192) Function - * [getType](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a9cbf40ea5229f4240bdb241e8d88329c) Function - * [show](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a344fe33286c0d548dfb35b472cfcc1d6) Function - * [getNumBranches](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a667215e89aa8d7b6ff584ce7c2a9e566) Function - * [getBranchCondition](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a0a01eb7fd3513f7754534c229ef4da08) Function - * [setBranchCondition](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1af539f83e9e44adfccbff2968cfdb3f39) Function - * [getBranchName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1acd033bea89f3ba1ec760d9ad2c47d0ed) Function - * [renameBranch](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1afddf16459949f862d3329e2d6eb79bb2) Function -* [ModelCenter::IIntegerArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray) Interface - * [hasChanged](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a117efbea02cce1afa842341cf3e70bae) Property - * [hide](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5f571b35a242ad8260a3380f75ec5acf) Property - * [OwningComponent](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a9d3e429a72048e669d3e37f814294828) Property - * [size](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a49fc48bf1f28f403f2b96b92fb8e5819) Property - * [numDimensions](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a7b259767761bcb4f84893a2f8baaa139) Property - * [lowerBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ad38b7c1cfa620446572595dba1b607f6) Property - * [upperBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a1a062cc1750c92e8db32de2b53d83e9a) Property - * [description](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a9933e6b9d3328cf70f35075b8556e8ab) Property - * [units](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1afe8daf819657e592587af96079b0a0a9) Property - * [enumAliases](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ade7b31cc762cc412e399fff92260fb99) Property - * [enumValues](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5d823185c095e0c48f696a8ec27a78cb) Property - * [format](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ad328109c650cbcc2ca8cf08b688de6af) Property - * [value](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1aa7b9346ccbe5c4088c45e09ffb8b7d02) Property - * [value](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a2b4b654f1094bfd632e383909ea37bad) Property - * [isValid](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ab3d891c3978182e073923a56b4dbe89b) Function - * [validate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a84ab133f5b1147d475fb8e2c4275b32b) Function - * [getName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a79fdcc3e290b4b0df816f69d8a8d5f9d) Function - * [getFullName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a8c74276fefc00a8b85a576e1d1b58053) Function - * [getType](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a05e311dcfb051f0df6afc99dd01d6773) Function - * [isInput](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a3752394336c9689384efac1005422431) Function - * [toString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a83e5e9905df758b37c901bae5e87430e) Function - * [fromString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af3d5cd8601c1227d439b7b3f74cc2d16) Function - * [toStringAbsolute](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5bc139ce096dbc917734386869a3be78) Function - * [invalidate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a521514c594a1ab4e30669305585530b7) Function - * [directPrecedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae3879cd50b0512f2b5660765393bd24e) Function - * [directDependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a44b3a3cc73cd46ea7661e776b20b4ded) Function - * [precedentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ac71c9a184e57f627b336438de0b7a238) Function - * [dependentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a399b9b49ca3133d2a49923637f19609a) Function - * [precedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a01bd8fce84abbb243a9f7e3c771c185c) Function - * [dependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af6712999aa6e50091a95dd66db088661) Function - * [isInputToComponent](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a2a19aa7ca1e4c4fb862016aede378c05) Function - * [isInputToModel](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a41c321c0260174a4c118e309fbd13085) Function - * [setMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae69f586d5f6a7cf93728f99a47b841cf) Function - * [getMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a76933c6f159d52907c0b9f6ba3d13136) Function - * [toStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae3d6633e9533a68590025dee14298912) Function - * [fromStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a26f9cfd27774a2233ae2cb232cc8fec9) Function - * [toStringAbsoluteEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5794b0c172b46da36d761bf31046db07) Function - * [getLength](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a8167ef387b9cc11bc76e9a0e0694a833) Function - * [setLength](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a91d122341cefcb887c3871d43ea34524) Function - * [setDimensions](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a1010ee85bb6325b98fab48f96b582103) Function - * [hasLowerBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a37a15ea329f97b885f57b2660f8cf519) Function - * [hasUpperBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a4b31b367d82c30fef71bd2412482c25f) Function - * [getValue](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1addb4d3f364f0f952a6341b52616bb0cd) Function - * [setValue](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a18caa8754a18f914632f71675d6821dd) Function - * [getArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5e233233ced66879ff8aa58832981a7d) Function - * [setArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a89811fdbf06146c4bf0b14ea099df689) Function - * [toFormattedStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a895cc520f94cb105b922380b105f448d) Function - * [fromFormattedStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a9a6ac88dcfe81e7651c7cc5d15e4bf59) Function - * [toFormattedStringAbsoluteEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a7a0ff2e8e1875ee5465deadb6496b81c) Function - * [clearUpperBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1aa3f1505493e089a8717c092e37927600) Function - * [clearLowerBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ab51bcc939e91ef1da288c78be99a7fcc) Function - * [getValueAbsolute](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a7c1be797998fc344c26e23ce85d9057d) Function -* [ModelCenter::IIntegerVariable](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable) Interface - * [hasChanged](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a752e2918df57582c7e0639840f2653f7) Property - * [hide](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a0baef047e82cd94c3fe393690a129bb0) Property - * [OwningComponent](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a7156a5b9cb1cd09eced27ffaacd9f521) Property - * [value](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a8626c616deb64d587178b6c1cbdc2974) Property - * [valueAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a5e2a2a61e1c4978200a2009c1f6ab74c) Property - * [lowerBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a15d6fe654e10ea55a5df2e7bea934e75) Property - * [upperBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abc988cc945fcc8e2cf905c885a180542) Property - * [units](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a3752ce74846eb04caed29711d1da302d) Property - * [description](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a746f793efe758a7e3f36ba188d07ccee) Property - * [enumValues](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1af9ee5a112578385dcae1893f96f0143b) Property - * [enumAliases](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac706776dfc20b9410c859471f981f43e) Property - * [format](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac28287849865c6233468b6e1a9034248) Property - * [isValid](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ae03686387c15bc80d2caec8c3a5a913f) Function - * [validate](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a2807c2dd1e70fe7d8eab0af0a64e2d74) Function - * [getName](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abcd09429d47c396bab6dc63690e1a1c1) Function - * [getFullName](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a6bbb377e1c98a99b660cfdfa3c61f191) Function - * [getType](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a38de94bbe44275b88d92522926b1a841) Function - * [isInput](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ab441aa413516cf14c082aa39801250c4) Function - * [toString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a2ec6bbef037c4c0a6ab5e510f9063923) Function - * [fromString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a180292624fd43a95348bd496b0fee8a6) Function - * [toStringAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac13b9c8e85a30831a81cedcdca610e01) Function - * [invalidate](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a07f62e68cae660a8bea1d1e31d754fcf) Function - * [directPrecedents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a5c99fbda3111d689db126a61e0727106) Function - * [directDependents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ad783a3a7e231dd0aa00b869699a5bca4) Function - * [precedentLinks](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a02a977781b36247895725b38a725dca9) Function - * [dependentLinks](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a1328684b4767a3ee6b006feca4f0296d) Function - * [precedents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a902fe35d10c8e25b86a64e13953a62f1) Function - * [dependents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aa8739ff163a52ceed99e867e5126330f) Function - * [isInputToComponent](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a67665668e8c1abee8bc9db708b05e970) Function - * [isInputToModel](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a87d3f8de3185380e368fdb008466dfe3) Function - * [setMetadata](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ad80d2a2e770297e5e57af0cd86601f83) Function - * [getMetadata](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aea17e7f7dc6d8979c2c83aec3f8a0c42) Function - * [setInitialValue](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a4f198a32ba9ba7975e6a81f769a6df0f) Function - * [hasLowerBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a3f0459ca0bc1b7108721b4ee36304bc9) Function - * [hasUpperBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a6434f421569bb898aabc32204d615f1a) Function - * [toFormattedString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abf09981270a02adab12c6bd420e07a22) Function - * [fromFormattedString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a647cc6b6832eefd008c51457a34c9ff5) Function - * [toFormattedStringAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a7c3ea8978f890824c3e08134c7bf7747) Function - * [clearUpperBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aba1030008767dd31ae13f40f90ba58d8) Function - * [clearLowerBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a16f466aa207ea88961361ee69a683850) Function -* [ModelCenter::IJobManager](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager) Interface - * [wasHalted](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a103d78a1bad75512c13080d2467fb11e) Property - * [addInput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ab95c6155dd1c2dbd24441bf3641a5542) Function - * [setInput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1abd6b3fa7a63b620f95141c191cd1c29e) Function - * [addOutput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a4591b4c0b98d14307aa691f42547c97e) Function - * [getValidateAll](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a53f5cbf8459b20f9c748535d8013eafd) Function - * [setValidateAll](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1aefca61419c9622f520429f257aa6061c) Function - * [getNumRuns](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ae63c0e8eda0494dda49ee20141f11ece) Function - * [setNumRuns](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a89e662a1a1c15ed27f8517b5a526b94d) Function - * [submit](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad1b204f5e684c57b28dc1e3dc733e285) Function - * [waitForJobCompletion](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a65bfecf019c1e9c8752fa3c90fd5d3a7) Function - * [addRerun](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a3e06470a8599a950a01c275f75c0d6cb) Function - * [halt](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1aa550897654f63d845e410ac9bda26b8a) Function - * [getNumInputs](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad8dcd18454e462b191092edd4096ab0c) Function - * [getNumOutputs](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a49fae6444ed2747c716f7829f8113969) Function - * [getInput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ac205f68299271d8e97adbc34f7c33655) Function - * [getOutput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1aede4e8c73a70bff3143317d0fa8dca97) Function - * [getInputLabel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a4d6a218d3dfff84908b13db7016a947c) Function - * [getOutputLabel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a7665a71ea25ae6436d201cd2e339e976) Function - * [getNumThreads](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a2a6391025814c8b85861fe9d8eaebf58) Function - * [getRunInParallel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a8893b7830affcf596e4a6d149ab47753) Function - * [setNumThreads](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a034974bf844d74af316ef687be4b84f7) Function - * [setRunInParallel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a660d28f5c25a2efbe370cb162bc58f4e) Function - * [enableCache](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1af28b9a4ab0944f31f2d157ab6826999c) Function - * [clearCache](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a06a3f847d50eb2f10e3b061ea91b453b) Function - * [getRunIndex](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a03b40110aba59370e9eb6aad1b6b2076) Function - * [resume](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a1bce7921ac7cedd5712423589b99afb2) Function - * [setCustomMetadata](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad106f381c9834b32c12e169264f1272a) Function -* [PHXDATAEXPLORERLib::ILegacyVisiblity](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity) Interface - * [showLegacy](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity_1af5b6718a60c0ac08286e7ae40df8332a) Function - * [getLegacyHWND](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity_1a7a2562683a18b86dee7b0cb60564b5e6) Function -* [ModelCenter::ILogger](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger) Interface - * [isTraceEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1acef00afc02324874e8ff47c61dfb4455) Function - * [isDebugEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1adc9ab6356bfc5c95aad04ee887c21588) Function - * [isInfoEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a4472be2e0c0f6302d2e73ad582fe6b9c) Function - * [isWarnEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1aeeb727ee61ec84c356257e23c8ac72da) Function - * [isErrorEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1aea7f6bb4163869086c07a72b5ec14666) Function - * [trace](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a97945d07f653d3cb3e483b512f7c569d) Function - * [debug](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a1ff316d9091c838bcbdeaf5706e8216e) Function - * [info](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a0a400bf773ffc4fd5d9c4440fd2d79da) Function - * [warn](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1acf5456282ad4295bfbb5dc3d6c41b8b2) Function - * [error](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a576c679c95d7e5c38917bcc0bab46296) Function -* [ModelCenter::ILoginCallback](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback) Interface - * [requestAuthCredentials](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback_1a9a1b24d936f4ee5dd2979ad38538929b) Function - * [loginSucceeded](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback_1a4b7dc5df7be75023f025f8d83fff7579) Function - * [verifySslWarning](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback_1a9c27b392b3c109f6abe689251e1e27c7) Function -* [ModelCenter::IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) Interface - * [modelDirectory](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1adf58dfafa5401318de434c22d9e12ef3) Property - * [screenUpdating](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acc9b3db9f6b75b711cf8106947576e89) Property - * [modelFileName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1abb83f0e9475f2ccf8de46b09946d79e3) Property - * [appName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a1a5d90dca23414ddb8ef45e99c091ea4) Property - * [appFullPath](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a999bedcb3195dc2a12b034e0fa0222ec) Property - * [IsInteractive](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7fc1e5b5a0eee411b82f7508243f453f) Property - * [ProcessID](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acb08040260ee9e91a9a455c15d9fc0ad) Property - * [version](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3072c85db32956a1c302668a49b031f8) Property - * [getLastErrorMessage](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5a57f078a8de6d78e6cc4f808c761fe8) Function - * [loadFile](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a21295b971e1a8854d7524b85332fcb3b) Function - * [setValue](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a535535c056577a2306bfd089423a6e8b) Function - * [getValue](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8cacc6c81e217bf7affe180a59d21455) Function - * [createComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa1c2ba41e8aeff2bc97408fd6d5e8832) Function - * [createLink](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac46503f8f560edbcddd87fb9c9045326) Function - * [newModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a90ad7c497e4da5b9474d747ba6bd9715) Function - * [saveModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a16dc53d7c16d4517b6859acc1ee25a50) Function - * [saveModelAs](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab3fcf686594e1e2f81b7814bab8a6752) Function - * [closeModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a00bcefae609c5a453dd1f4e0586820fc) Function - * [loadModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab57546e9e718895bbdfa25bc1b7d1e9d) Function - * [getVariable](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af87c3dde3f5645f1257ba0edb037889b) Function - * [getComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a779902b1a3f3c4c0db2b58484ec75fe0) Function - * [exit](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aba655ef2cf9a8f639acde2697d8319a2) Function - * [createDataCollector](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad91dff33c09345053346ce2d831fd968) Function - * [tradeStudyEnd](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a85f4a4b6557102133fc5dad3ef0a1ff8) Function - * [createJobManager](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5878e18adeeafe78c1920e5544253442) Function - * [tradeStudyStart](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a39de949b1cdace01114ee9391fc4a484) Function - * [getHaltStatus](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa75908bb0ec202342833c666b10fcb66) Function - * [getModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5d42323e20b243257f4cef533dd58e7d) Function - * [MessageBox](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa31343d27c063cc384336028b12abac2) Function - * [getValueAbsolute](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a04408aef2e249b325db44eb8e0ca6758) Function - * [setScheduler](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa312b4e6e4585bd0f4d7cc9a69d1d7ec) Function - * [removeComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7bbd736a48c08e2eb90c4af45872e6f5) Function - * [breakLink](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a231cd11fa3198cc4a22db3ee0483b59c) Function - * [getHWND](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aaaa18b9967d91f5e9afa0f663fb4ddae) Function - * [checkout](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5ea6a58aa4def0e7d48f5c48dfc46d35) Function - * [checkout2](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3b8e21abd2354b4fd537084f36c9a180) Function - * [runMacro](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a762c9d09a2d611300bc3e09f9891c86e) Function - * [createAssembly](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a402db0953a58ac7573cf3585c938eafa) Function - * [createAssemblyVariable](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a72e28e9146e37b0854aaa3274b60362c) Function - * [autoLink](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1adea9c027f61fb0c23ce34a0e47924679) Function - * [getLinks](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac83decf1799275a0d13ecadeffb008cd) Function - * [getModelUUID](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a499de038ba95ad40b52862e5239bf18c) Function - * [getFormatter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a1533da4a5c2e70aa5b196215af7637bc) Function - * [invokeHelp](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2a8f95eb131aad5e03597ada8251ef30) Function - * [launchTradeStudy](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a24726ff2cf91ef85884d6b2bea513ed4) Function - * [createPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1afb0f2d3715e4a48c1ee1c865864c5314) Function - * [displayAboutBox](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa9057344d6d2ffc28569709efdbdb5ad) Function - * [halt](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a4cde569f8ca3555ede7fd8d3d2cd4387) Function - * [displayPreferencesDialog](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae8f7829bf075209faf0fcecf742e76be) Function - * [run](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a158d8bbb37d23dd35bbf87b1340c95d6) Function - * [getDataMonitor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a6212fa2f41e2132f8f40d78164059eb7) Function - * [createDataMonitor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad86e8cd5714f0d22dc84b1b71979fdc5) Function - * [isOkToClose](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af91d7535a069da55220c52b759ca5238) Function - * [addIcon](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ada4b443f077f7c53744ada601a3c12be) Function - * [removeDataMonitor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2dd2279b4d0250af8ae6d3506f55c57a) Function - * [setUserName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a359b38b4b8bc935b9eb5cf9e68a3a34f) Function - * [setPassword](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a677e2965bfb8998dc4546673f95355de) Function - * [getModelCenterPath](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1adc47ef3cf5fa8d766117ec19c7dfab92) Function - * [getDataExplorer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae1bdc8f0abc612490b737852f189027a) Function - * [getDataCollector](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a29b8af2a820e24e728425e6467881067) Function - * [getLogger](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af2d28cb0c0290a80ebe0e31f91497f11) Function - * [createPlugInFrame2](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acd338a67839da36df138a0521ee3aead) Function - * [moveComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a70986fc1018ab96fdbd507b4ebe568fc) Function - * [setAssemblyStyle](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af1bef892aa57d153cd63b6f4ba9037f4) Function - * [getAssemblyStyle](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab1d7ce6494121cd997115f91e91d795a) Function - * [getAssembly](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a461a8c0e8efdd3353da6feb22b232029) Function - * [createAndInitComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a049e13b6d3ba54dd40a162a16d03bb66) Function - * [getLicensingPath](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af5bdeb0442c6f35c0e5db849b1a166fd) Function - * [getMacroScript](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a16bc3b79ea75a2c2e9c6aaf48591f840) Function - * [setMacroScript](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae2b0614b8c0367ab7893c5fb32e14b96) Function - * [getMacroScriptLanguage](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8c930544d5f9fc2e49afb076b5ccee76) Function - * [setMacroScriptLanguage](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7b92a22213e11d5f4b3ad8dfe7a894f9) Function - * [addNewMacro](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a9d209b30adb83ac9fe48f8efd1959f3a) Function - * [launchMacroEditor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab180eb62170146926e7a6c2384d5ad66) Function - * [startGUIMode](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a06c77786a3965c9ca7c72c6ba7af7ad3) Function - * [getNumUnitCategories](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a0f6aab6d238cbe899af59725ab0de842) Function - * [getUnitCategoryName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1abe07ee5b95ed640b926a165f2e02b7f1) Function - * [getNumUnits](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad6a35e6ac78e89ddcd4a68023bcdd651) Function - * [getUnitName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aab8bb46de63e10f150e9614ea36d0b9a) Function - * [createTradeStudy](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab18e9a5fa259695357cd26f155ee95dd) Function - * [getNetworkLocations](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a375ab85c506633857e960502c208ed79) Function - * [saveVersionedModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac658a0c1392f2fd8b851794c9ac1896f) Function - * [saveVersionedModelAs](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab65847c07b712a58acfe6a21659518b5) Function - * [getVariableMetaData](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aebbf42a396f1eea5b917d13b85e0fb8e) Function - * [dumpComDebug](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a27b453e8058a238c25049c8fcb5121e4) Function - * [showFileBrowseDialog](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a9dabff9569cfbb6c65ccdae26aab3ff7) Function - * [showFileSaveDialog](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a23ea9bc699e8f31401f96d2594f79ae6) Function - * [setLoginCallback](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a156c716bde56ad5bc070f00e2037a2da) Function - * [createDataHistoryVariable](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5f2d90be1a4bed0126993b3021d24981) Function - * [getRunOnlyMode](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a38682504615aef9e603a9c2f3d4bd2e8) Function - * [setRunOnlyMode](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aba91dde2a4c0674816c3781ed873457e) Function - * [createDataExplorer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3edba311337bb171b956e0d331cfa05f) Function - * [getFileSystemInfo](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a6d6d38245d99b3f53fda689a1adee17f) Function - * [SAFEARRAY](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa2ca200dd05dc8257c35af74035459e1) Function - * [saveTradeStudy](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af139d41f66681c63c80243adbd48cbc0) Function - * [getDataCollectorForDataExplorer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a59b46ca7b15c869fb190ecfeb70bf90a) Function - * [launchDataCollectorPlugIn](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a434995395fc673c8197bfde7e1256240) Function - * [guiLoadFile](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a255ea30feb95451802aa280bdffcd7b8) Function - * [guiSaveModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8ad33e25dfad91e8ba248d399a1b6449) Function - * [getMacroTimeout](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a18766ae9a0fda73f8febdb709adfceea) Function - * [setMacroTimeout](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a559cd3b9f0e68e5ecc2c4006c8014667) Function - * [guiCloseAllMultiplexers](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8708a9033fcd77731539b085a1c6c047) Function - * [setAlternateParentFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a83b97e8dd461f4bc8fbe5cdc63809b74) Function - * [destroyPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a24cc8bd489975150c9d5c5c3e9502b87) Function - * [showPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad1fc33915ad5917cd645e795251f01de) Function - * [hidePlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a806cc1860aaadaa5496d4caa0a51fe91) Function - * [setIconPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a65a6502ad779fd4394d06f45adabc398) Function - * [launchHTMLViewer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aae5eb45abe323ca501a777f31b9ae5b8) Function - * [runAntFile](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2d684049210e4062f14cf2e3e2abb031) Function - * [getGlobalParameters](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2fac8021991150ab97e3673e4b0c0dc1) Function - * [closeHTMLViewer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a46b4e01256fa252da2f589af87833ac1) Function - * [HTMLViewerWaitForClose](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad62471b3a17a7b182d7f8fa0df7048b7) Function - * [HTMLViewerGetMyHWND](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad6f56123c0b435ffca19628deaa4169f) Function - * [getActiveJobManager](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a931fee19976a7a03e263284ec0ee9d53) Function - * [getPreference](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aadc031780e0355e1ca2bba83cb13441a) Function - * [internalLicensing](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae91fcfa7f9dfe5fa3df62fb9d3c703c8) Function - * [transformAVPoint](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a23a3683a4c5b5f4380e33232e2ca30be) Function - * [parallelInstance](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7dc06d52fa432893eaf74db606db3864) Function - * [unAssociatedInstance](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a21a60528e3b43cbbbbc131adaf5a1151) Function - * [configureLogging](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acb8cad870e072bee4a80b1902476929a) Function - * [setXMLExtension](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a70666088b3363b2c9738cd15ec446d8e) Function - * [getXMLExtension](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af94e33f84d46652cfad0af931db0d59b) Function - * [setPreference](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac7c886a8b0333b565333d6b16d9ab824) Function -* [ModelCenter::INetworkLocations](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations) Interface - * [add](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations_1a86769591b49fd0bf2ce90bfd45c24bdf) Function - * [exists](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations_1a6e6cf7b365025116e67b9ddd575b10b1) Function - * [removeAddress](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations_1aa7869edab5e7d597c67804e2d5dcf561) Function -* [ModelCenter::IObjectVariable](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable) Interface - * [hasChanged](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a221928e7f8f5b8f5ff309f6e768a8d96) Property - * [hide](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a70d41ee491cb94eaa45dd1e3e6c805c9) Property - * [OwningComponent](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a2cd4745b4fe97b79d205b876bd91835d) Property - * [value](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a778d71ffd4daf5160b2594672b0cb7c8) Property - * [description](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a73b60bd367cc0e6783f9e5ad0bf96811) Property - * [isValid](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a88a80a771329337246e883b3ce034400) Function - * [validate](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a56e476d33f05ee8b4faa077396704fa6) Function - * [getName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1ec0c0bce4884b2c8c1decf29f4d5b86) Function - * [getFullName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7d1acdd7a964ceb7d189c87a19e9bcb3) Function - * [getType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a40cc49ff4f6fd51695549d4ad32a4384) Function - * [isInput](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1adb2ffa6d382f3874d63cab8c53f956c6) Function - * [toString](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acc675e2c9045387d4ceb956d7d7d9f70) Function - * [fromString](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aca195574fffbfac6577eb4b0d54f3dd8) Function - * [toStringAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af042cdd3c4908daa767f6b0dce043e75) Function - * [invalidate](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aff411bdfa6a95ccc904878f1ffecba6b) Function - * [directPrecedents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aac5eb818fb62f131d6ecb13fd3f6aa34) Function - * [directDependents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af1b4238d92307aa3586b4f7070e497be) Function - * [precedentLinks](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a25a478d55d4855cdbf4f8753b6cd6062) Function - * [dependentLinks](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af52780ea6b4984f40b16c8c072e1b005) Function - * [precedents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a8c987c7df5766ca31115f25ce36f1f91) Function - * [dependents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ae106e94dca5f19c46ed9f82c67772660) Function - * [isInputToComponent](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aff062edf68ee2b0ff7db9b81cba0899a) Function - * [isInputToModel](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa0e5a61596a334437a407396c4a38e44) Function - * [setMetadata](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1d611e44da36abed0a41c6f688344841) Function - * [getMetadata](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6fe6bbfed4b08df8c9f9a4c86cb49ca5) Function - * [getClassURL](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7cd400b4cd38cacd370b5c2b6246375c) Function - * [getMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7143a8eed8b14b1b6b7772e82f472cd8) Function - * [getMemberValueAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a75f4995da0954629b58243f202e1681e) Function - * [setMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a44df8b08cf7cb9cf6d1a5b72136d5f52) Function - * [setMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6cef469cbdd030f510d7bb51e686c257) Function - * [deleteMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a30200ac90fd4115c2eb6c5641a77eddb) Function - * [deleteAllMembers](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a763852aed64e16a58160d166c8addd23) Function - * [callMethod](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ab1c0d770f00a0c466eacecda838b3850) Function - * [isNonStrictType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac232ce8558a68f9f27661644fbcee3b8) Function - * [toXML](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a9e16b89241b7593088803ace922f5ced) Function - * [fromXML](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a4697fd5d09c8ade51e7a905a4202e5e9) Function - * [hasMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1b153917fd978107a15c2b2283d9f1a0) Function - * [isNumericMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a068348508497bc740975b56559316baf) Function - * [reinitialize](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a481f787db359b10b814f9ff279bb1471) Function - * [getMemberLength](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acc1266cc18716f9973ec60f57c4a657d) Function - * [setMemberLength](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aec74047ec9cf7e9b93b0b4509da57f15) Function - * [setMemberDimensions](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a4e889147b9f6274163e2ede028fbf1b5) Function - * [getMemberNumDimensions](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a558bd8128469e74dacaae9236e57eed0) Function - * [getMemberDimensions](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac7ead6acd3c9f25b85e9670c396babbe) Function - * [getMemberType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa0e74d911fa3c06e65ae0061bb0a1740) Function - * [hasMemberLowerBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a2870271930867129b9102eec3c778b28) Function - * [hasMemberUpperBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac291b12d8f349c09c18162cda4299a4a) Function - * [getMemberLowerBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1afd9fba6ca47b0bf5fc48a2d210654d1c) Function - * [setMemberLowerBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1af9965da5833253a2234df86f677093) Function - * [getMemberUpperBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acbf0879d4bf1acfaf7cac4f32ef9df0e) Function - * [setMemberUpperBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac86c323427541c659a79974e19ad2692) Function - * [getMemberEnumValues](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a58394bc10f092128be001e36d890c0be) Function - * [setMemberEnumValues](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa2399f22fd7fc4daf9687fab4e4e512a) Function - * [getMemberEnumAliases](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ae8008b1c066e802a5838dfdc9775785d) Function - * [setMemberEnumAliases](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a18bf5de57cd2d0343bb90267608621d8) Function - * [getMemberDescription](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1abb5cd702a72b774a9b93a50c1a4a4270) Function - * [setMemberDescription](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7f78fbf9eec449dd61dd06f9d18cbfd6) Function - * [getMemberUnits](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa893e48f7214f7b0c31f5628c16ebb0a) Function - * [setMemberUnits](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a033310bf93afceacc24f097ce738a135) Function - * [getMemberProperty](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac9fe0949b94f5f8243a2b783ed2a65b1) Function - * [setMemberProperty](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a15c71dd9da7797408006e31677e9901f) Function - * [getMemberList](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a06be37e0fa407f4197aff2e534f61eb7) Function - * [getMethodList](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1ad90418c9d492ed35dbb1d20943035e) Function - * [toFile](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6bd774581876d61cdeaf9637e470b0fe) Function - * [fromFile](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a5e4a925c2918b6ac9da355b2287e3d04) Function - * [toFileAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a4904889be1812816c742b23763d0229e) Function - * [getIsBinary](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1afaad0639d6eeb9543d9ead12e9164094) Function - * [setIsBinary](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ad6f0e0cc2595b7a2726f8d38ec573e2e) Function - * [getFileName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a8f71ab194f3468c084aea4beca2c43b9) Function - * [setFileName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6824345c22985533b8e284b84e1c83f0) Function - * [getFileExtension](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a610338503721a3cd0992fa5af793b718) Function - * [setFileExtension](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ab1a52e485c1d4c0384d17dca0a2f74be) Function - * [getArrayMemberValueAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7b6b51c7f0eb9a262d1ba0a2bf831368) Function - * [getArrayMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a13f1700a491d9f13070a854092887b20) Function - * [setArrayMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1adc14eb60074b51d08f58f5f080f830b3) Function - * [getArrayMemberAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a24b1cc73d5868b9e8a3014209689d088) Function - * [getArrayMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a5dc9de363afe0659af36716807543b05) Function - * [setArrayMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a667cf875a43fda4c97325c3734ef9ed1) Function -* [PHXDATAEXPLORERLib::IPageVisibility](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility) Interface - * [hide](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1aed414820e7a805ab6ba5d08c437d7347) Function - * [show](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1a0e233fef605747c79f16a6032e4ebd01) Function - * [isVisible](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1aa52adfedbec735ae4d1e34c4daf66455) Function - * [getDataViewHWND](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1a00bc608cb2e87ea6a12c4da4497c4768) Function - * [getViewHWND](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1a19d4d225ecc6463333715ddde8c5f65f) Function -* [PHXDATAEXPLORERLib::IPHXDataExplorerPointer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer) Interface - * [getDataExplorer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer_1aa6b13b15afbe694654cbba4b3fa1157e) Function -* [PHXDATAEXPLORERLib::IPHXDEKeepalive](interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive.md#interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive) Interface -* [ModelCenter::IPHXFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat) Interface - * [setFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1aa34d6054f4542a34efb60a961ad78519) Function - * [stringToLong](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a9e0774cef531d24731ac6c320cfd837c) Function - * [stringToDouble](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a2576f20eaa4ec6133a734ea09d86130a) Function - * [longToString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a175332e4916d1d86855b1b707831e308) Function - * [doubleToString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1afdb6c65e615c3d5176129b51a1d44318) Function - * [getFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a6c3566f301404af75e38676198a8bf1e) Function - * [stringToString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1ac1b65cffaf6712d53e58935e3c1592c9) Function - * [longToEditableString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a2d5f201c8a8166ffeca606bac90d4b3d) Function - * [doubleToEditableString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a596665cb30835ccad7c6df17afffd8bd) Function -* [PHXDATAHISTORYLib::IPHXMenuItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems) Interface - * [numItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1a74bd895a7bdaa2b6786bb4dc2c4d12a1) Property - * [setMenuItem](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1aa76ac2aefb1a69021d5f536db66c0c4b) Function - * [getMenuItemName](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1aa8491483ad472e4f1f9e51ea028561eb) Function - * [getMenuItemDescription](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1a3213c537df82b4c00dd7f4df96b90712) Function -* [PlugInMetaData::IPlugInMetaData](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData) Interface - * [getDescription](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1aea971d69e4505696518f69057dde4863) Function - * [getAuthor](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a302223e3912f3e34a512a5ef323e0939) Function - * [getVersion](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a7cb8178dec412b370f22e7a9905eb3d9) Function - * [getHelpURL](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a81605db892f6e5dc71aa7a4f2d00686e) Function - * [getKeywords](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a38d839895f9ee3493710062d2bf67c34) Function - * [getIconLocation](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1af49ffd75001ae0bfd3dade7f5b9562db) Function -* [ModelCenter::IRefArrayProp](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp) Interface - * [enumValues](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a2b488ae83e3f61e8f0924b781b0fac1a) Property - * [isInput](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a6a71677c0367f53bb39861474c8ce11e) Property - * [title](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1aaa7d8507dbf83d2cad6eea2266fa98fb) Property - * [description](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a0b98819f11c5c2e7c916a4e629199d48) Property - * [getName](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a625e640f8adae51bd6f65a88c7f67299) Function - * [getType](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a60190ee41cfbc6624a138dba5c790d00) Function -* [ModelCenter::IReferenceArray](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray) Interface - * [hasChanged](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a32bab88b29119d84a6429364fd651411) Property - * [hide](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a35c7c4ee97058e1636c56d4863c58e00) Property - * [OwningComponent](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a4b37dc07f0e626f6b833b772d57b06a3) Property - * [size](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a0ec169188c7e660a32e9a3bc6792d26f) Property - * [numDimensions](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a05a8f727001f8d1794bc33960736fd18) Property - * [autoGrow](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a74f194b29d46aacb12b7d4c445df729b) Property - * [value](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad9e0cf09c5c40b6272808d3ba83489ba) Property - * [value](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a902f599bd7fe0bed1c5f1f51a49e291e) Property - * [reference](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a60216339479fb364f7e97cb5d9ea0b66) Property - * [reference](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1acd5c00c533970d30757f90445ec376cd) Property - * [referencedVariables](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad2c0541925f15b29800a9e924916615a) Property - * [referencedVariable](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1abb922c879568308b8c074165d596777e) Property - * [isValid](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a366cf132edcae4c78ff3c3c29d81ad03) Function - * [validate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1af1dd28c351fcda3e3fea31facbd4fca3) Function - * [getName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a282d98574e8d65d85c9908b6799321b7) Function - * [getFullName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a44ebe17869a3b1b95568ea46299a9f3f) Function - * [getType](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac3c3f33a239fe1182da434d7570346df) Function - * [isInput](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ae7e5c76cfd592a71fc7e5785c7cf6394) Function - * [toString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aaa37debc6216a5419715e0c542555850) Function - * [fromString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9cb9dab871b4e86ed66fb53cc5473ebd) Function - * [toStringAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a1a0ecbbccb3fe3404c79976e9f07b8db) Function - * [invalidate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a56ea1d83eb42dda4a7c06b6fbbf6ffd5) Function - * [directPrecedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aa8041fca418266f2bee129804654abab) Function - * [directDependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a862a4306dbf867e3db316d9547cea277) Function - * [precedentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a084d49d02b9ff5812166721fcdc86018) Function - * [dependentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1add9bd8c41cd4a5c77f7e762768b441a5) Function - * [precedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aea1973c58e45bafe3aeea797b91a4f6b) Function - * [dependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a7a3b136537fb09914b87b5997b937df0) Function - * [isInputToComponent](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a317b7b47fa55798e212c426b4ac8f014) Function - * [isInputToModel](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2d16dbc50ee0f77d5ca99b8a600e5023) Function - * [setMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a31e14e94dd9316f40bf963a9da9939f7) Function - * [getMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac6becc1bb1c5206e972c266164f838ca) Function - * [toStringEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1af2ff697565c81552d49c0237cfc89ef7) Function - * [fromStringEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2a286a07b606f7e90ac4e1d281a49d38) Function - * [toStringAbsoluteEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aac2b33985ad310362db7c8c878096ae8) Function - * [getLength](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad88eff947daa184ab953839666729ae5) Function - * [setLength](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2cfaecd2a821841d414f0d9ac505659f) Function - * [setDimensions](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a3526172d364bb842ab3bc25f1cedf31b) Function - * [getValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a32db352eed1650697f8b164546ea3eeb) Function - * [setValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a8ef388f09dd24fd704b46a7446016951) Function - * [createRefProp](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9e2914c70c8c77002c0dbc502cdfa056) Function - * [getRefPropValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aecab78945a16a827081638609b48318d) Function - * [setRefPropValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a93e2bd4cf0f592ca8ec2a626fbd57432) Function - * [getRefPropValueAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a76d1cee0ac71a9682e7ff9af6df9cf77) Function - * [getValueAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9233b22b8ad38b1abf30bc68d543d789) Function -* [ModelCenter::IReferenceVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable) Interface - * [hasChanged](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0f4d80365facbc0cfea5745f131e9d10) Property - * [hide](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a598cb6023fcbcb265cc44618529c3040) Property - * [OwningComponent](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a853702bf341480c261b01988dfd15513) Property - * [value](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a2e307144f16d81645b5ce2cc30b01ae3) Property - * [reference](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1abfacc6a5417c7fab810ac6e34a885657) Property - * [referencedVariables](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a21758071b908ac4fe720dffdafe75592) Property - * [referencedVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3ae2ecb1742ecac66cec298a6d2cd011) Property - * [isValid](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1adbc66e2276350867c0b977bf5cf192cf) Function - * [validate](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a16aec4b64f98c5dfb3f66c497691e447) Function - * [getName](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa01b77111d4a975cc12ca3e0a16d845b) Function - * [getFullName](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3e427b90dbf2f763c2486cdd774c2d49) Function - * [getType](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ab946d679180e3e65433c8b4b2d61d39e) Function - * [isInput](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa61fe715fadff86e98c35d4bf6aa16e0) Function - * [toString](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a6675d6a6451c20b11b43ad594af28bcc) Function - * [fromString](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa52a8fe2a76861302ee8ab0f8f3a614c) Function - * [toStringAbsolute](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a510fd4577f2a29cf0fef6d1c8fe43c94) Function - * [invalidate](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3a460ef81527173ce0c272d2bdf69da6) Function - * [directPrecedents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0e11aede2642dd050f0c5254a36b4a71) Function - * [directDependents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a24fa52bf29a92c4f1d6a79e2991e9ae5) Function - * [precedentLinks](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ac4f846dce2494b7c4a9b8482af321c96) Function - * [dependentLinks](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a4c704741da375408b052eeddc6ed90dc) Function - * [precedents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ae2d07bb6bf73c064a1a492bb6ff2806a) Function - * [dependents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aceffce4238d22a19c211658f675491ee) Function - * [isInputToComponent](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ac551ae6997c725cbb3ef71bd6217f89a) Function - * [isInputToModel](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ad8a6169868d4d186b658946403eae2ab) Function - * [setMetadata](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1afee8a9cb2ea3d6728cacba4aeaa9ff7a) Function - * [getMetadata](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a122afef9ff20a0de02d08ab41eb4e5bb) Function - * [createRefProp](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0063ff442e879a9ca2986bc63eb9adc7) Function - * [getRefPropValue](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ad90bbc18df836afc454157bd06523d75) Function - * [setRefPropValue](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1af41e2e8abdbc5959543416e21bc73793) Function - * [getRefPropValueAbsolute](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ae45fa34070d38d9de3593d815e86b1fc) Function -* [ModelCenter::IRefProp](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp) Interface - * [enumValues](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1a11d289581d9118de3f3a86d7d643fb85) Property - * [isInput](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1a0a8ec20895618292855526596a534f06) Property - * [title](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1ad9f9fdbe48e40c42f7d80eb57b072ae7) Property - * [description](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1ade4ceb94fec2ee5eab541cce187b1eb3) Property - * [getName](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1a2b2ac899757c8dbd31a9c38b6d08f2c2) Function - * [getType](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1aa05642b60b5a5e44e9954c130d4686e1) Function -* [PHXDATAHISTORYLib::ISaveContext](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext) Interface - * [saveFile](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ae85020cbcdca30d63c0dc803f19b7599) Function - * [restoreFile](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a90cd640253dfeb285c7c66803e61f6ac) Function - * [close](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a314e254f112778f1bb9839e157fcc532) Function - * [getSaveLocation](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a02bf3019e5a957a4db2daff6dda6ca28) Function - * [saveFileStream](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a840d41a9c874a046867c9d25c8a0d628) Function - * [restoreFileStream](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ad11ce33d8317c86c335597d0e8389578) Function - * [getFileFormat](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ab69f2a1eba739bfa1e95a1b5ba2cc8c8) Function - * [setFileFormat](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ad30b0ac3ddc36ac47b0f03662d3d4d0a) Function -* [ModelCenter::IScriptComponent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent) Interface - * [Variables](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a54219eed78fa8eed485e8da974458ea1) Property - * [Groups](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a6d041596bb6e0be6dd0710c6c9e0e8c9) Property - * [userData](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ade9f3ed3c58d1f3eb9914c3a395eb7a6) Property - * [AssociatedFiles](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a42162de74b1b046b277b927ace2dd403) Property - * [IndexInParent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a20f2c6a05beb38eb4d95a010cb48f94e) Property - * [ParentAssembly](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a48996a90eb72b62a9dff1119708c9d42) Property - * [language](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1af3d2bdfd6cd0c29ada055bee3686b2ff) Property - * [timeout](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a3a0d87f35ccd9845a8dc70e1ccf531eb) Property - * [forwardSchedule](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aedc1fa62c68c5512ccfe6913e018610c) Property - * [prevalidate](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a0f82cdd3e9fa556568265ef51c8bc0de) Property - * [getName](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a88c3162ff460faee36d43d3903c7a498) Function - * [getFullName](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a7e4a9eb5127e60bfbbd90640e35b32a7) Function - * [run](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1afcc83d74aabc7ddd66da4fccb708f0e9) Function - * [getSource](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a3dc2690409dd67fc5b3023e50d7abed0) Function - * [invokeMethod](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a03484bf5c7636d2015b3b11c3849ac30) Function - * [invalidate](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a70b40fcdb20ca2991b3db649f77eb55f) Function - * [reconnect](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a716d694026d6ef45a78ab51a8d1f6eae) Function - * [downloadValues](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ae380bd13a2c92b3392432f879e87baf2) Function - * [getVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ad88148c419a4c75c4c79b9d5e3c41eb6) Function - * [getPositionX](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aa032eb6b3c27a69052a8eb81053dfc34) Function - * [getPositionY](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a7b5ce3f6ce5bfd44702ff1fb874fb9fd) Function - * [rename](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a775db6663f994e82bb2529efe6585c8d) Function - * [getType](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a551d15c4f328f341d8cba0fe28bfd2b0) Function - * [show](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ad7d6f94d38270f36b80ed3c0109312dd) Function - * [setSourceFromString](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ab41aea5c06252f82fc831ea6af40e1b1) Function - * [setSourceFromFile](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aa34064721143d9012bfe5c0c899415a8) Function - * [addVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a04bbcea36b9bb694385e8620fa0a6b11) Function - * [removeVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a6b191d44fea8ec432315202d094acdb0) Function - * [setVariables](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a03a16eed6dbd98df2286d42f3a47db56) Function - * [getSourceScript](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1af377a582a930edbc7b4a56b57cd54375) Function -* [ModelCenter::IShowHelpEvents](interfaceModelCenter_1_1IShowHelpEvents.md#interfaceModelCenter_1_1IShowHelpEvents) Interface - * [ShowHelp](interfaceModelCenter_1_1IShowHelpEvents.md#interfaceModelCenter_1_1IShowHelpEvents_1a9e94376ebaa4b126ce37c5c541e8f5cb) Function -* [ModelCenter::IStringArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray) Interface - * [hasChanged](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a7d7a0e45d355883535175f060d150a25) Property - * [hide](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a39446dbc4a63268669450640360a10ca) Property - * [OwningComponent](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8c1ac6e84d73e34b12cc5e9397bb83a4) Property - * [size](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4164bff5f32408083a55fc9a327ebc66) Property - * [numDimensions](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1abaa61cb129a23c20be499a61ec4c8443) Property - * [description](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a9a336c7daf4b7f248103e2a3654139e6) Property - * [enumAliases](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a75eca0b30d1c439ddae44c33b03f9797) Property - * [enumValues](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ad3575ae96f975b212aaea0739a0c363d) Property - * [value](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ae449bcebd78b7ec3fe365cd8fbd3dac7) Property - * [value](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1afd9e0eaba3274e5802f25fe40f039c16) Property - * [isValid](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8b738f7eef3f9a3f8a723cede3809f47) Function - * [validate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a86b82bcfb1ccfa2428968307eaa07108) Function - * [getName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a0a90870618bd396edc53c27ff0b8c9af) Function - * [getFullName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4ca185e60b69ce2ff41d19a2270bc28b) Function - * [getType](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a582f9e8e47e60eca8041b98c996a4f4f) Function - * [isInput](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a3b7b397239f04cf9ea9358f9477ee2c4) Function - * [toString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1aa735025db3ac6e13cb486f8629b86a69) Function - * [fromString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a65a839b63dfb0495f577bf70ca87a320) Function - * [toStringAbsolute](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1adfb1dee0a1fd5b541eacba1e4cbba7ad) Function - * [invalidate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac6dd084c61d7ce2631d207242eca89bf) Function - * [directPrecedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a40c76b900187ef244f14c5c8e9bb65bf) Function - * [directDependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4820176e7ca9e1c3173d602308144c62) Function - * [precedentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a19c1ae9d08b968bae4b6fdd1ec74fc3e) Function - * [dependentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4227d6aca4e2d7791cea69efeb5b81fd) Function - * [precedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a913272799193e5d02033c63c746ead9e) Function - * [dependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a392d8e4080854c954c165833bb89a7db) Function - * [isInputToComponent](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ad59d273bea1a7e02540520e9b4428264) Function - * [isInputToModel](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1af1da4c99c6359d527ad57c9433333a36) Function - * [setMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a495551c5a05027a8537ffce75f333f8e) Function - * [getMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac730dc0fbfc8ae56788048e6c0fb80fa) Function - * [toStringEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a9013b29e3ca18c5a0ecaff8dc6d19b5f) Function - * [fromStringEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8fa6aff7c64224c1c488d5866dfc4865) Function - * [toStringAbsoluteEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a3684e3b0b2d36a599f75236a6f5e90e7) Function - * [getLength](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a39098992a1f29458010e4d18385d3681) Function - * [setLength](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ab20a6b27ddb532d0186532a52a148d91) Function - * [setDimensions](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1aa3a9cdee8b632a3adda4e2d1814c66f8) Function - * [getValue](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a7ba8cf139385e0630061f9ccfc8dc55e) Function - * [setValue](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a34205a2be0ffe6695721d957cd90f963) Function - * [getArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a499c8a85632b8c29f36a4832ae0a2ba6) Function - * [setArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1addf446b647e3f8946e8e72825241e0d3) Function - * [getValueAbsolute](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4e082d20ea2f1b47c95d26152595d05d) Function -* [ModelCenter::IStringVariable](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable) Interface - * [hasChanged](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a846973fd74773de77e95f5a686059b8a) Property - * [hide](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1acd58e2a3356b8297a5cc491f5a3ce9ac) Property - * [OwningComponent](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1aedaac8e1d883db0e5d9fa4f9ccd6403f) Property - * [value](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ab56992c6033247f7a5c262e63e728467) Property - * [valueAbsolute](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1abe143a72a2b1f663e41bf0af0118d5db) Property - * [description](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1af60bf6fec0621b386c755c9adc5cf4b5) Property - * [enumValues](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a26a049d4c093a364a5e03c577b6937b1) Property - * [enumAliases](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a55c58e3ba1d7b7b9985a32c8f9b88954) Property - * [isValid](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a16c6e45e1967f427b3a7123d7da384b1) Function - * [validate](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a7bddbd595f981680f8eb062d950f20d7) Function - * [getName](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a50cf9efbe23ed25a027f6df1d7132577) Function - * [getFullName](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ac8c712e2b8f8136f59cffd1665d6cb5e) Function - * [getType](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a9468a019a8bfaaa771c5bf97e206ea5a) Function - * [isInput](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a2268414421505ee4c0fb49de92953007) Function - * [toString](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a46f43be460cbd0d90493a6f9f26eb65d) Function - * [fromString](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a587cc7ce24785d0110b86ff815a68d89) Function - * [toStringAbsolute](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ae9ed673188c2c46e2c3883cdd65b3af5) Function - * [invalidate](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a7b29d24168420440191f35e6ad382d03) Function - * [directPrecedents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a98031c7081831a57f35dcfd18bef2279) Function - * [directDependents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6cd07e865097669f307d3d8ee9ace1c1) Function - * [precedentLinks](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6fcaecc0f0d1bdbd827e507ae1307fa4) Function - * [dependentLinks](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a019771c2e685c90ef2b4f53a0a3acf7c) Function - * [precedents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a4affcdc7391a9327db4c828e54c71703) Function - * [dependents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6ce38d07c0dc470d96eec4077c2c38b8) Function - * [isInputToComponent](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a940488ff3ad42baa064349a43fe9eac6) Function - * [isInputToModel](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a52f14ae0f304152748e0373e91701708) Function - * [setMetadata](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ac5062f1a9bcf780f891c6abeb0bcb391) Function - * [getMetadata](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1aa094d1b1e7b20a631c92c9ec9d936d71) Function - * [setInitialValue](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1af05313d1d5dce644dc1e0fb7217e18a0) Function -* [TradeStudyPlugIn::ITradeStudy3JobInfo](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo) Interface - * [numRuns](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1a27982338f106af2e2b89a29c66c2d8f1) Property - * [numVariables](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1ae684750b56d166406294cfc78bda83b3) Property - * [getVariableEquation](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1aed1386a6f6cef8c6c4ec1d94b3d07009) Function - * [getVariableDisplayName](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1a6e0f4277d79e93bd5d08fa7e548394a0) Function - * [isDesignVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1abbcbe48e293004c4cd609b574ecf94fa) Function - * [isInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1a02ddc66a224fd3c8fe04ec8ec60959e5) Function -* [TradeStudyPlugIn::ITradeStudy3JobManager](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager) Interface - * [dataHistory](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aec4a15702e1f9565f7564914cfef534a) Property - * [validateAll](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a913715f9bb137763d7b099cfe8bd9b57) Property - * [runInParallel](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a1e97168b7c275486400eaaf14e9a88d2) Property - * [numThreads](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a2b92bb066c911d4102902525a3feae5f) Property - * [numRuns](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1ac665a3e053e07b9bf007c5b798af743e) Property - * [numVariables](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aafb31c9ee4a9e013e3f7f77900217492) Property - * [supportsParallelExecution](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1afc7560080c238a34ac8d339d80175327) Property - * [canNewJob](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a0736cdac1a4c8573ec1332477849458b) Property - * [getVariableEquation](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1ae152b41da461434289f61a5f4c327fb6) Function - * [getVariableDisplayName](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a6fbac6e4218e6b82ed61d2f38f9b7af6) Function - * [isDesignVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aa53ea93d24fd4476de06e3226a5b2e69) Function - * [isInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a4f1199571453c7b851c484e88fb43a1a) Function - * [newJob](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a49263a87ff0aacb9e2231bbe0e726d1a) Function - * [clear](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aeb34f0cf410ef02f4eee10d611b4a740) Function - * [addVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a44f6cc3111c89abd357dfcfeed23cf4a) Function - * [setInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a44b3d2bd5e6037197449aaa92c6fd725) Function - * [setRunInputs](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a2d73e6a448ba816d2f4025d5f95b285e) Function - * [setVariableInputs](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a5f77ca1741019e90b1d348a7b4c20b04) Function - * [runJobAsync](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a7cdc64aa2ca295ed608347a61e79b8ac) Function - * [getMetaDataProvider](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a2f8bcf1cea9355a81d408919e479013f) Function -* [TradeStudyPlugIn::ITradeStudy3JobResult](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult) Interface - * [numRuns](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ae5299ad977b8ef2294350733bdff6912) Property - * [numVariables](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a3d8795dd3559fce3f610e63872b8808b) Property - * [dataHistory](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a5889d5d7712934aa30c0983452c875bb) Property - * [isRunning](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a56114078a1e476ce5e5ec70314f6fb73) Property - * [isCanceled](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a2248d0fcfa9dbf3b0de48e5b75ff4df5) Property - * [getVariableEquation](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ad63d367bc060e84ccd0edc96747bd082) Function - * [getVariableDisplayName](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a84850e887d89eb20d7793933316ad752) Function - * [isDesignVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ac933f79559b7a0cf45fe49a6cb1e77d0) Function - * [isInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a01b2afba0cae246a236a56555ffd3e05) Function - * [cancelAsync](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1aa5d136ea9f5d9dce819e2c6414f1febe) Function - * [waitForCompletion](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ad76c0b31771a31a827235d0306529ebc) Function -* [TradeStudyPlugIn::ITradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback) Interface - * [dataCollectorCreated](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1a21e1253a708b1e6177c5998ad7583c59) Function - * [runStarting](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1a05d371f3256cbd0515c1786d4ca42b46) Function - * [runEnded](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1af1ec5576a28a72b94eca35294a49dff1) Function - * [tradeStudyClosed](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1a9434138abbfd489946e6657ce904dcac) Function -* [ModelCenter::ITradeStudyEvents](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents) Interface - * [StartToolRun](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1a4bd376f4406023fdb8c562c3e530e32c) Function - * [EndToolRun](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1a2fd4f50429de83a6469ff4146c2202eb) Function - * [ToolClosed](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1aceebb769e27511c9b87462b8fa9ef16f) Function - * [ModelXMLExtensionsChanged](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1a09c0d68be95fb162874e4da3d0965749) Function -* [TradeStudyPlugIn::ITradeStudyPlugIn](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn) Interface - * [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a2b883bd3725cefb35daf8b629124a57f) Function - * [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a7238385b054e9afddbe65c65644826e4) Function - * [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a58cdb46e4e8dca27761d7bd976c8fcf2) Function - * [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a8c4352f776b3919a9a56aa61ff78c5d0) Function -* [TradeStudyPlugIn::ITradeStudyPlugIn2](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2) Interface - * [TradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ad9db0e1ec3dee4b67da4fd2bd197f497) Property - * [saveAllAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1afeb8dd96abface7ec4a37de262c88c85) Property - * [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ad233e5489d31c81b6b1fe09d9a3a886e) Function - * [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a81aebef74679c6364f184219c22da93a) Function - * [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1aaff0d58b0b3d2d90566fae1277ea4a45) Function - * [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a3dd50d2ce70b8e0534dd9be60e9bec5c) Function - * [onEnd](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a955659c71fd798c3d2be2d98a277e28d) Function - * [addAnalyzerVariable](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a614a39c2d8dd38f47d840aa6d5bb34f2) Function - * [clearAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ae184db6af8802c77918103c4bf0f0564) Function -* [TradeStudyPlugIn::ITradeStudyPlugIn3](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3) Interface - * [TradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a781692e887426951e2913672d9f94a78) Property - * [saveAllAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a98649448b98aa71aef4adc1e33c47570) Property - * [id](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a2c98e62414b0d01303d7a009449f0871) Property - * [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1ac84a2866cfcedd306eeabd757d8c0877) Property - * [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a3f6d767abcf9b50ee14ac7be20ef964a) Property - * [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a541ccb54affa550f0ea2694b39e16c7c) Property - * [onEnd](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1afa9a6faf24f730938ea94ba9e846a381) Property - * [addAnalyzerVariable](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a9e044579568a49b3f42c8771ccf8bbc3) Property - * [clearAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a1a94e6d8431bf19dee3fcf446e781070) Property -* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) Interface - * [hasChanged](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a70aa745d819120f3f13d8f5cac099e44) Property - * [hide](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a2b79ae605f5b5864f5470d730a845f7c) Property - * [OwningComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a2b61c0eea38b2b20a08b75041dc20f63) Property - * [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) Function - * [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) Function - * [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) Function - * [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) Function - * [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) Function - * [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) Function - * [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) Function - * [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) Function - * [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) Function - * [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) Function - * [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) Function - * [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) Function - * [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) Function - * [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) Function - * [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) Function - * [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) Function - * [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) Function - * [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) Function - * [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) Function - * [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) Function -* [ModelCenter::IVariableDescription](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription) Interface - * [name](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1a5430f2b928f3f8fc672dc2dcf8c6db03) Property - * [fullName](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1aa3c8267507d2f0d6cbbd35a33de0fca3) Property - * [state](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1ace7a19354a1c40a3f64464fb87b992ba) Property - * [units](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1abea210199b644bc3da685775950b9368) Property - * [isCustom](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1ae6ba3b64b599b6df11a39f0c3fa1b078) Property - * [equation](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1aa42abd87b11af98fcb67926472408801) Property - * [type](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1a8fc783420e2ab3163a2552436d694d0a) Property - * [isNumeric](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1ac7d823563278b1abbc458b61aa5eb686) Property -* [ModelCenter::IVariableLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink) Interface - * [LHS](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1ae3805787afceef57db6297e72632650a) Property - * [RHS](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a05eff77b1fab3100869de855008d8b02) Property - * [suspendLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a8a637411378f91597e5612e2e03c959d) Function - * [resumeLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a38ec9f0f44714dd151f7683721bd7ce8) Function - * [breakLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a0e2397280fb0a53c07ecee27bdff89bd) Function -* [ModelCenter::IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) Interface - * [Count](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks_1a65d1ab625bcdab41639028c42f712b26) Property - * [Item](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks_1af1e6de7d83b5af2ae699785b1d61fb1c) Function -* [TradeStudyPlugIn::IVariableMetaDataProvider](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider) Interface - * [getVariableMetaData](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider_1ab17303c17efd43f87d95991b2245bc72) Function - * [SAFEARRAY](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider_1aa2d00c56cf6df0f49ed49a864e281f45) Function -* [ModelCenter::IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) Interface - * [Count](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables_1a5805886fd173e6fc77a3387d5f1c6b95) Property - * [Item](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables_1a68b42951fd19cf993eef52d372dbdb84) Function -* [ModelCenter::IVizContainer](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer) Interface - * [Visible](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a4e7368bd0265ae9a637cfd675b5bd264) Property - * [HWnd](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a4971d80a859be3f620c329dbc5019d7d) Property - * [id](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a1022454788e8b96f6e84ad60e652bbe3) Property - * [hide](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a12129753b07898622d2e8a55801ef19d) Function - * [show](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1ae8ccfc592c21eb6adffad9502e4b28fb) Function - * [fileSaved](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a380f514b047b16f7cfb2fa4bacba4e6c) Function - * [showAt](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a69bf3249d5ef44ef0eee2152724f9457) Function -* [TradeStudyPlugIn::IWindowed](interfaceTradeStudyPlugIn_1_1IWindowed.md#interfaceTradeStudyPlugIn_1_1IWindowed) Interface - * [closeWindow](interfaceTradeStudyPlugIn_1_1IWindowed.md#interfaceTradeStudyPlugIn_1_1IWindowed_1af9dab02ffb5223028fae48563bbab27b) Function -* [PHXDATAEXPLORERLib::PHXDataExplorer](classPHXDATAEXPLORERLib_1_1PHXDataExplorer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorer) Class -* [PHXDATAHISTORYLib::PHXDataExplorerExportPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn) Interface - * [exportImage](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn_1a6e04dc894ad504d6c349d36ae7384e09) Function -* [PHXDATAHISTORYLib::PHXDataExplorerPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) Interface - * [getDataHistory](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a2add0041717f37ff0c72761de93af815) Function - * [setDataHistory](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a530e372d5d75f87574b4f5a7f8f25347) Function - * [getModelCenter](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ab914e1d1c1dd883a0a1b6201cde0577f) Function - * [setModelCenter](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a38e366a60626a29afa74869e40f156c6) Function - * [getPageTitle](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a38ed1207dbcb350057bc22b0450eb009) Function - * [toString](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a075c34c41b0461b36077d19c314fdc2a) Function - * [fromString](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a889e85b07599a03c7a262297629d0763) Function - * [getMenuItems](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ad899f49a6bef9cd0f56292b7c92d8503) Function - * [invokeMenuItem](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1afe6db966ff1b5790a8ae887d70294dc3) Function - * [isMenuItemEnabled](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a7259c195e2711d0fb54579e22752adb2) Function - * [updateHint](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a6394212eddc67589ac43fbd85826bbc2) Function - * [setStartContext](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ab7f82a38962d77ab437299dd6cbe50a1) Function - * [getThumbnail](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1af5f2203aace2cd54bac6c8789b1782c5) Function -* [PHXDATAEXPLORERLib::PHXDataExplorerPointer](classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer) Class -* [PHXDATAHISTORYLib::PHXDataHistory](classPHXDATAHISTORYLib_1_1PHXDataHistory.md#classPHXDATAHISTORYLib_1_1PHXDataHistory) Class -* [TradeStudyPlugIn::TradeStudyPlugIn](classTradeStudyPlugIn_1_1TradeStudyPlugIn.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn) Class -* [TradeStudyPlugIn::TradeStudyPlugIn2](classTradeStudyPlugIn_1_1TradeStudyPlugIn2.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn2) Class -* [ComponentPlugIn](namespaceComponentPlugIn.md#namespaceComponentPlugIn) Namespace - * [importlib](namespaceComponentPlugIn.md#ComponentPlugIn_8odl_1a1176e44e4d62af0ed162d7221dc5f53f) Function - * [importlib](namespaceComponentPlugIn.md#ComponentPlugIn_8odl_1a2cf599b993bafcd3fef5f5b7c34495e3) Function -* [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) Namespace - * [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) Enumeration type - * [METADATA\_TYPE\_STRING](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153ab0ea415d391c664f7c4c20e41e6a5b5b) Enumerator - * [METADATA\_TYPE\_DOUBLE](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153a1ef8fb522f41ea233866f7058fde8a23) Enumerator - * [METADATA\_TYPE\_LONG](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153a7f0cc46935e8f50a3ff7125e9ccac82a) Enumerator - * [METADATA\_TYPE\_BOOLEAN](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153a0cb9ab8e21174262b86c899965d618c5) Enumerator - * [METADATA\_TYPE\_XML](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153a934405f69eb259b948fdda69fda36cdd) Enumerator - * [METADATA\_TYPE\_FORCE\_TO\_32\_BITS](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153afd2104e48eb6bb48323751a8b15395c2) Enumerator - * [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) Enumeration type - * [METADATA\_ACCESS\_PRIVATE](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dca193d415dae56a753d64d37bcb67a2285) Enumerator - * [METADATA\_ACCESS\_READONLY](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dcae1023b575b4ff76a772e10c9162dd467) Enumerator - * [METADATA\_ACCESS\_PUBLIC](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dcaed115b108b3a38e88e5f5a3a1e17cf13) Enumerator - * [METADATA\_ACCESS\_FORCE\_TO\_32\_BITS](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dca637668ae8a3b4e7805346e7f1db302d5) Enumerator - * [TradeStudyFormat](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dca) Enumeration type - * [TS\_FORMAT\_PXTZ](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaac6d6ad08981541727efbbf8c181674cf) Enumerator - * [TS\_FORMAT\_PXT\_COMPRESSED](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaac387037adbfc62827fa1523fc69a1278) Enumerator - * [TS\_FORMAT\_PXT\_UNCOMPRESSED](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaaeead4e562c092545f613d220eb2df08e) Enumerator - * [TS\_FORMAT\_TSTUDY](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaa3332e2d8a655365e5c1fee1d8f1fa436) Enumerator - * [VersionStatus](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0) Enumeration type - * [DO\_VERSIONING](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0a1db01871f227cbb9c0ff450f45faeb85) Enumerator - * [DO\_NOT\_VERSION](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0ab728b53581051a989c0a4a20d5a0b7ac) Enumerator - * [DO\_VERSIONING\_IF\_POSSIBLE](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0a0f9c1842a82241069e6d7de3b1164023) Enumerator - * [AssemblyStyle](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625) Enumeration type - * [ASSEMBLY\_STYLE\_COLLAPSED](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625a6b01dbb284343f3c49f9ac2318be4aa3) Enumerator - * [ASSEMBLY\_STYLE\_EXPANDED](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625ae5a9a245bacc433385a01acb31722bf8) Enumerator - * [ASSEMBLY\_STYLE\_CLASSIC](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625a853070b6a8d1299e8d9e7f846a1f2e69) Enumerator - * [ASSEMBLY\_STYLE\_N\_SQUARED](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625af225405c171ad35d8e7caad44414d736) Enumerator - * [ASSEMBLY\_STYLE\_AUTO\_N\_SQUARED](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625a53d3ac52946f367fea3960b418f30626) Enumerator - * [ASSEMBLY\_STYLE\_FORCE\_32\_BITS](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625ae20fa83961bd74d6133ceec0849d4c1c) Enumerator - * [OnConnectionErrorMode](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2) Enumeration type - * [CONN\_ERR\_ERROR](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2a32466c6ffbbfd1d8cae3f96e7565e049) Enumerator - * [CONN\_ERR\_IGNORE](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2aa1a76a2bf1e5b53785d9e1c8389b9369) Enumerator - * [CONN\_ERR\_USEDIALOG](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2a4e520a601326fcb3e1324c9a950a541d) Enumerator - * [importlib](namespaceModelCenter.md#namespaceModelCenter_1ac27ed4a9b1a4fd02d9a3191c3ffbfbed) Function -* [PHXDATAEXPLORERLib](namespacePHXDATAEXPLORERLib.md#namespacePHXDATAEXPLORERLib) Namespace - * [importlib](namespacePHXDATAEXPLORERLib.md#namespacePHXDATAEXPLORERLib_1ad9ad6f6589cc63d798e289289f567b68) Function - * [importlib](namespacePHXDATAEXPLORERLib.md#namespacePHXDATAEXPLORERLib_1adfc3e518adcb9b631d6b3cd9f7dd728b) Function -* [PHXDATAHISTORYLib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib) Namespace - * [PHXMENU\_PREDEFS](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daa) Enumeration type - * [PHXMENU\_CUT](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaabf2c6817e4dffe7bc31ef64ab9ddcdb2) Enumerator - * [PHXMENU\_COPY](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaa4dd9a98729c118faa83f0c0ed3f29dbf) Enumerator - * [PHXMENU\_PASTE](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaafa9df5b66d50b8e6ec10faff0eadfa9c) Enumerator - * [PHXMENU\_DELETE](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaa5e8804d589a5617739cf74eb4bc3920b) Enumerator - * [PHXMENU\_PAGESETTINGS](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaabf2d504b4c5e2360d5902eb2eadfb45c) Enumerator - * [PHXMENU\_PRINT](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaa7e25b0e3c45465e3b3cdbad98b6d0f72) Enumerator - * [PHXMENU\_EXPORT](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaaed6d6e7b1fedd6b023274169374bc7d6) Enumerator - * [PHXMENU\_TOOLTIP](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaae48476ba1f1babc81be7b7db890b69c2) Enumerator - * [importlib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1aebeea567338ef111ceead76bc59bf072) Function - * [importlib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1a0e2d7a999f42bdf583341c632c923d8e) Function -* [PlugInMetaData](namespacePlugInMetaData.md#namespacePlugInMetaData) Namespace - * [importlib](namespacePlugInMetaData.md#PlugInMetaData_8odl_1a64427c7c968384bb40b716dd4f058fc7) Function - * [importlib](namespacePlugInMetaData.md#PlugInMetaData_8odl_1ac015988798e4dff85180232ea6f9f0c5) Function -* [TradeStudyPlugIn](namespaceTradeStudyPlugIn.md#namespaceTradeStudyPlugIn) Namespace - * [importlib](namespaceTradeStudyPlugIn.md#TradeStudyPlugIn_8odl_1ab9cd75f3f81835d0383377354faea30a) Function - * [importlib](namespaceTradeStudyPlugIn.md#TradeStudyPlugIn_8odl_1a6f9be822941ca29fb4380a23d65b3994) Function -* [PHXDataExplorer.odl](PHXDataExplorer_8odl.md#PHXDataExplorer_8odl) File -* [PHXDataHistory.odl](PHXDataHistory_8odl.md#PHXDataHistory_8odl) File -* [ComponentPlugIn.odl](ComponentPlugIn_8odl.md#ComponentPlugIn_8odl) File -* [PlugInMetaData.odl](PlugInMetaData_8odl.md#PlugInMetaData_8odl) File -* [TradeStudyPlugIn.odl](TradeStudyPlugIn_8odl.md#TradeStudyPlugIn_8odl) File -* [ModelCenter.odl](ModelCenter_8odl.md#ModelCenter_8odl) File -* [Deprecated List](deprecated.md#deprecated) Page -* [LIBS/DataExplorer](dir_4c5da7dd69977c70a414920e45f0e4dd.md#dir_4c5da7dd69977c70a414920e45f0e4dd) Directory -* [ModelCenter/src/InterfaceDLL\_ComponentPlugIn](dir_f4b71a0ee7c6b8122721a969fd158e55.md#dir_f4b71a0ee7c6b8122721a969fd158e55) Directory -* [ModelCenter/src/InterfaceDLL\_PlugInMetaData](dir_254da5db084e40f61f0f3ecf2de92ae0.md#dir_254da5db084e40f61f0f3ecf2de92ae0) Directory -* [ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn](dir_6384486296a61296aa9794364431ed6d.md#dir_6384486296a61296aa9794364431ed6d) Directory -* [LIBS](dir_3deb6222fdd4eb7b0f76591cf78ec6d0.md#dir_3deb6222fdd4eb7b0f76591cf78ec6d0) Directory -* [ModelCenter](dir_e61251abb0949c61ea8ea7dc5fba4af2.md#dir_e61251abb0949c61ea8ea7dc5fba4af2) Directory -* [LIBS/DataExplorer/PHXDataExplorer](dir_f8085194870fe60668985a445c75a643.md#dir_f8085194870fe60668985a445c75a643) Directory -* [LIBS/DataExplorer/PHXDataHistory](dir_b61c1eebc2b964146e7860adc8b8cd2e.md#dir_b61c1eebc2b964146e7860adc8b8cd2e) Directory +# Contents + +* [PHXDATAEXPLORERLib::\_DPHXDataExplorer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer) Interface + * [author](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a8acab1f7a5d2caa0ab47d0d74247497e) Property + * [description](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a29b8b160371c7db191f6e3dd0e1fc414) Property + * [displayName](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a5f8b196a046e313bc7d50d6ac80ec29d) Property + * [id](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa3402e5d6822ebe510cc7fec192d5094) Property + * [id](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a75bed8e4832c534f7d7842ec7921e652) Property + * [associatedModelFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a145b2ba8b5de9c0bac5b0ac89ad7f960) Property + * [associatedModelFileUUID](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad91c318a844622c7673df74c0f92128b) Property + * [creationDate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a4e0ab1e84c6e9f6ddd62ec774c75f42c) Property + * [tradeStudyUri](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aefa05eb2c41402bebce7e388d06d08e8) Property + * [isVisible](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a876e3d3fad4e109897eb41df8252cee4) Property + * [getNumPages](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a389bca42567d788cb1c1c619a400109f) Function + * [getPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a3da50454f5e424f4aa3971d84f7387c4) Function + * [addPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af65679f9d81fa741896f22fb959f81d1) Function + * [removePage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a75118395c50e7e2dc424d3f3eeba8fa6) Function + * [movePage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa890fee8f830a7ca7e04840962c2cece) Function + * [selectPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2110d97cf0636bd118ea3197ef9ba134) Function + * [getSelectedPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2dfa9fbb916798751f0fbac5ca3d2fa8) Function + * [pageCut](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1925e33cfa2ae4e284cef4b8255c92dd) Function + * [pageCopy](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1241ff0682653a4b92dd9b6064d0bf42) Function + * [pagePaste](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a08c390d4e7e3ff7f93a60283464c7826) Function + * [invokeInsertPageGUI](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a0f0eb77a79bbc31706335b91e6a2923a) Function + * [toXMLFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a889efcee9f2e90cf7de94b3d521f4cdd) Function + * [getPageType](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2e8a2fc452e5d1bad94bedf2edfe3ca5) Function + * [fromXMLFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a4ea300c891cc45556fdd4b1e7988274d) Function + * [toXML](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1afc2dbe6d642993070f320d76f0b1f6b6) Function + * [fromXML](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aef1e4bfd5cd8b8e28d6e26b06483629f) Function + * [getMenuItems](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1c15433a3ca058372e666abbaa1e1fa6) Function + * [invokeMenuItem](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2a636f7492de925506cd78a80e37deca) Function + * [isMenuItemEnabled](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a23f32ddd6ea2d2d268351327a03e46b5) Function + * [updateThumbHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1adda950ce0660029538ab7bdb541c6f2c) Function + * [getPageSetup](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ac36fc1456cb55f50ccf9046d617b7187) Function + * [exportImage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2dc01f47f79342cc3893c66a8be1fb12) Function + * [multiPageCut](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ae2457af6aec2f86ffb328421ad2051e7) Function + * [multiPageCopy](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1eca7b9ded4f6956ccfa95b11629021d) Function + * [multiDelete](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad9dc21008ad2ddd47dfc339328d454da) Function + * [loadTemplate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1945a9df23ff32406e48f560a14ea592) Function + * [saveTemplate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a3919d10a314c536703149f6377f7f924) Function + * [toXMLSaveContext](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a9ce95b6c36069c784ea2389d85dde7ec) Function + * [fromXMLSaveContext](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a237c798449d1bd63e69905b53fe17d06) Function + * [show](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad1f82e4921ee4c4db89b43fe92bf171d) Function + * [hide](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1adcc3bc6f74b07b516bbc98361b36d4d6) Function + * [getPageTitle](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a91b7a788be45f38d1cea9579731e794c) Function + * [fromCenterLink](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab68593eb479ef9f2684e7e8e683ed0bd) Function + * [ignoreDefaultPlotSetup](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a0c7a09c2192beadb073ce041aa0e8893) Function + * [setupPlotsPre](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a21238a932694565dbf0e2115c80ae59b) Function + * [setupPlotsPost](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2f726b811f8e11e39612bfd8b082ef68) Function + * [showGeomTooltip](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a89fb0170b61fdd2e320c52a8b370e99c) Function + * [showGeomViewer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a7d467a6fb859b8cb7f63c04f84f75dfa) Function + * [updateGeomViewerHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab9e6e926290d9a829d5e90b17911fb22) Function + * [setGeomViewerRunID](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af1cd6cc367767eafd9ee19b54cac0305) Function + * [updateComparisonViewHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad687c055e59a0bb50aac411174fa9a70) Function + * [isMenuItemChecked](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa6aabcb973d32ab328fa815d38d2da7f) Function + * [removeFromComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa30551e6356933878904d49df1239bd3) Function + * [addToComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2b46272c7cead32a5f75319eecddbc87) Function + * [addRunsToComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a7e608fa73c8645388956a6c1538438af) Function + * [getDaXType](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af8150d8d7d5f6fc37eb3bdf0a27fc817) Function + * [getDaXFormat](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2559ee7d7f32bbcebd0d18bb145bd012) Function + * [ensureRunDataAction](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab5a2bb675d76aca81691538b7ef55ef9) Function + * [getKeepalive](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa49db3c3a511089125f6ce44a1ec838f) Function + * [getHWND](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a27e733b7b61329799abe081c40b00394) Function +* [PHXDATAEXPLORERLib::\_DPHXDataExplorerEvents](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents) Interface +* [PHXDATAHISTORYLib::\_DPHXDataHistory](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory) Interface + * [suggestedIndependantVar](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3b5732bdccab13e2a7ed55c852d4c55b) Property + * [suggestedIndependentVar](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a1713976f65a0fdc2d37e9606bbc8672b) Property + * [suggestedDependentVars](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae1e8705d32948c759d3ab3e59bf6306b) Property + * [suggestedCountFrom](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a07162878a7dcf1c2a6ea41a56c9ddb6b) Property + * [id](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a1a709440522385b3161831eea313c15d) Property + * [centerLinkServer](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a226709acf22397c41215acd7f0ab0605) Property + * [centerLinkRunMatrixID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a61514463a5c0f82163d4789cd9e60f8a) Property + * [centerLinkJobConnector](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1af8f87624e919e067935bb5403261b63f) Property + * [centerLinkQueue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aac2a1a4d2bc65319ac7e94f0f20368b1) Property + * [dataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a4c0b3167dd18062593fb1a221bce40af) Property + * [warmStartStudyComplete](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac68974459907dcaf6b35ea631bba2801) Property + * [tradeStudyModelFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aeecce56460ab6c1c203c9d56433f4371) Property + * [addVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9a819127adb7f83be0acfa4e79f4643d) Function + * [setNumExpectedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a8ee93fde7260e85a34331b2c32a1289c) Function + * [startRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a74028f784809522e15bf71133d8fd23c) Function + * [endRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a0576632449bf05bc8b0274fb341a3332) Function + * [getNumFailedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac08c8abcc799991d7b12548ae1172378) Function + * [getErrorID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a90e9fc9cfb0d469c4169504e6f2c9cd4) Function + * [getErrorMessage](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a876302a3d26eda812e93bdd8b15bb26d) Function + * [setError](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a51fddca34fae5fbd0a5f5c858eddac26) Function + * [getNumRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a59b24c674a512a94640f4c5a890e9309) Function + * [getNumVariables](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aca767f94c4b80412c79eba62214eebfd) Function + * [setResult](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9260828e57d6cee2ec51e26dcef48ea7) Function + * [getValue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a43d806edede4bc2efa5e88c7615189ed) Function + * [isValid](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a55e6f50a94f58d4c39bb6fe06c5398da) Function + * [isModified](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1af7b8598fa12d5b516344517c0593a983) Function + * [toCSVFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a582bd6a4ad61e03070dcde9e4df76812) Function + * [toXML](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac6e672dc87278a4037bbf085b76f6aa4) Function + * [toXMLFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a7d11e224b1eaac4fab085ed9fa3d183b) Function + * [fromXML](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a1649ee497672683a575cc6cd6b78c9a6) Function + * [fromXMLFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3b65f441a218c193aae8863e6354cc2d) Function + * [toCSV](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ada3b86a293b267a74999e35c70fea775) Function + * [getNumNonEmptyRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac1ad590e863b19678c6e47ae4ff3e521) Function + * [getVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a074ed759e40eb4931c5b6e23f2c72e02) Function + * [createVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a68acd508b225f5c74c27daf848f3ae27) Function + * [isRunning](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab045302c25ef3b584eb3736b9071569b) Function + * [getNumExpectedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a250340a6fc41c19a43783cd3171db63d) Function + * [getRunName](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a42f819d3a26184898d9487b42894d4e2) Function + * [setRunName](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1adff96af9fbbb349cd4d0d69aab8a1b43) Function + * [insertRun](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab64f03fca9f43b3a491393d44c9144d5) Function + * [deleteRun](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a0be98d87ed201827314037c9100e8fce) Function + * [deleteVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1af26d20927c5ef5ccd3304b1c3ba220c4) Function + * [getFormattedValue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a45bea3dd1938199a0846f46c3d024503) Function + * [setFormattedResult](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9d98950fdb4e2e3f07519c40580c8ae9) Function + * [getNumCustomVars](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a0b2e2ab12279325bc63b9db7330d6bab) Function + * [getUniqueID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a01538f2f06fba2512c31fb7a35a04b4d) Function + * [getVariableValues](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a03fd55d685a75a6041202d00e676e052) Function + * [createDesignVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1adb61a037918e5f45dfc6a43541023970) Function + * [addVariableAt](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a156c9828bc7c8251e68886297349ccab) Function + * [setVariableValues](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aff837e76c92ab15ac33eebfe3f348c99) Function + * [isHighlighted](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a81c862c59a3b280376afc1b9bd221116) Function + * [highlight](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a77749479f2bbdf8caa1f90119e6112fd) Function + * [getNumDesignVariables](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ade57b335d32a772b6de31d129b6374bc) Function + * [setTradeStudySetup](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1acfc1654be0cc6fbe5469b487f9576bb9) Function + * [getTradeStudySetup](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a5f068466f0c9b18f8ba1681d97c2ddf9) Function + * [setTradeStudyType](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a7e9c912ffb74926c67437bf50b8b944f) Function + * [getTradeStudyType](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9f51a8f280c8bc80f4cebcb9de40ab5e) Function + * [setShortVariableNames](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae53e12cca23a7988b0d8c7dfdbe14308) Function + * [setRunValues](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aa6fcc8d517001f5b1e1c2b4cb9d6a95c) Function + * [getFailedRunIndexes](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a2acdef5238b168dae7f3294ba1629c77) Function + * [toXMLSaveContext](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a21df6ed38dc18c8cc9054f40f1f9daaf) Function + * [fromXMLSaveContext](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ad00d42b514b490170b0d28930b4bd32b) Function + * [getCompletedRunIndices](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a434f332ecfce0734f8f940da4b722cc6) Function + * [isRunComplete](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ad0d48129784f8ce140ff3dfb76ee8ba3) Function + * [addCheckpoint](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9e6d72c9c2f589323e745f69426aaefb) Function + * [getNumCheckpoints](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae1070b5293d700b8e095477fbb54b80c) Function + * [getCheckpointValue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae28168a3a789a8d8c2413e6c58c635d0) Function + * [getCheckpointRunNumber](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a71781fe2343b7ef49d1fb80ed91d295a) Function + * [setUniqueID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1adc572aab955548292d15997e1b519434) Function + * [getNumCompletedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a023f64de843e0e97d47e37b9cfbac5ae) Function + * [getCompletedRunData](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a76a5d19e76fdfe69e61d6910917acb32) Function + * [getHighlightedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab7998245db9550b3e7c21a25b37ce7bf) Function + * [setHighlightedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aea1fd966af29d2f3d0f7d95ac8f93ce3) Function + * [addVariableStructs](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9bf37e7831e0c32cfe17225f019c9cc4) Function + * [fromCenterLink](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3ff1b9e535edf561dfa7f575814f1792) Function + * [setUsernamePassword](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab6b36fde7ab38b09357add72dcbaf225) Function + * [setResultAsFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a8fe368442becfe48a2642b16d9a73e3c) Function + * [getDatabaseFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aaecbc010eb87c6a2fbe894a646d83a4e) Function + * [setDatabaseFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae38c2eeccd0c6e3c6c2e68063bd7008a) Function + * [removeAutosave](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a222463b648be93775c026887adf9d75f) Function + * [getVariable2](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a03430a06338ca51c6f5c45421a47f320) Function + * [getVariableTempDir](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aee367d3da3f483f1d9d476e832c7bb9a) Function +* [PHXDATAHISTORYLib::\_DPHXDataHistoryEvents](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents) Interface + * [variablesChanged](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a9a2402c1679d7707f2f274399276107d) Function + * [progressMeterChange](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a2f121535f7eedf77ce9e6edb9b512a51) Function + * [progressMeterStart](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1aca4688267a060ab301972886d0c04d6e) Function + * [progressMeterStop](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a0fb85ceb307de0a1c2a449be77890447) Function + * [dataChanged](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1aa6f5dbeba5082e060cb68696cd07d44f) Function + * [progressMeterEstimate](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1af43f03e636994de756db750668ac86d6) Function + * [highlightChanged](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a84baf9536c489fbb318a5e13cbf6fef5) Function +* [PHXDATAHISTORYLib::\_DPHXDataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel) Interface + * [canSaveToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a3123522cb86b3daa95c56f60b99a4f9e) Function + * [saveToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a6efbbc76935609344ddfe8b48eaac5c1) Function + * [canRerunRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a080673db51fe153fd870e46b9dd4f221) Function + * [rerunRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a2d1c0808d8fcdfe748d3194c45eda87a) Function + * [closeDataHistory](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a9ead478fc2486a3ac01b73ee8b3962be) Function +* [ModelCenter::Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) Class +* [PHXDATAHISTORYLib::DataHistoryVariableMetadata](classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata.md#classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata) Class +* [PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct) Structure + * [name](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a539d4b4f21c4c53505a6c39534fb2c3f) Variable + * [isNumeric](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1ae0822979f6b70670a347c98c67d367b2) Variable + * [isInput](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a1f4709d547b2d872fd404f7fc5b6566a) Variable + * [isBinary](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a121de67cd4278a5b008d416a2579bcf0) Variable + * [isDesignVar](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a09f46ea4820a3341554e2bad9a052f7e) Variable + * [equation](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a32fdc64aa5113896a4a962a5c3cbaf93) Variable + * [format](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a5d2b591cdaa6ce26e344f11ab6e1b76f) Variable + * [type](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1ab613172a10fa02c2756813e75944536a) Variable + * [units](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a48e1dedfd188d030f71a196434ebaf3b) Variable + * [fileName](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1aa624273f5c3fb5af9baa0272caa971e0) Variable + * [geomScript](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a8f89e59faab48afc96e4a0dde2f457c3) Variable + * [enumValues](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a3388bf5cf3b1f7de69b343b81669e6ff) Variable + * [enumAliases](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1ab0241db307b35f1e5d19adbd2d1f17df) Variable + * [lowerBound](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1aa8335d587fd45435098d82f59751071d) Variable + * [upperBound](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1aeda7394339c56c5493cfad15d26b0b3e) Variable + * [customMetadata](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a5e4dfb223db7287d798efb5b8078a3e2) Variable +* [PHXDATAHISTORYLib::DataHistoryVariableStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct) Structure + * [index](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a331317f8f767933429cce81e8ada5385) Variable + * [varValue](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a44619a37f14a5ff181483dcf993d1424) Variable + * [isValid](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a55153c5a8cc53d611839b0b55bb3e8a2) Variable + * [isModified](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a0e1c5e9cd74d1f2516fc1d35eea45b17) Variable + * [metadata](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1adad4bb3cc571df3df8a8df37d634fe72) Variable +* [ModelCenter::IAddToModel](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel) Interface + * [prevalidateInputs](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac59a55cf1a42f612e494d429c3879595) Property + * [autoRun](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1aa714911e950223667ee525a435b00b7a) Property + * [addToModel](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a58f5f3bc676a7c683ea4fc9b531d608f) Function + * [updateComponent](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a7f5a3a1914714827435dfd59e9be5e32) Function + * [getComponent](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ae5ee8b89f3b20182eb2ab707460fe751) Function + * [getRegID](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac0dd856b24d06484c6ded0aba0199016) Function + * [addInput](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a62816c713535ea573159c78f709aa04e) Function + * [addOutput](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a073c5f4a93c492f05fe361ca1799974e) Function + * [getProgID](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a0b7490ab8fe0d89e8ecb6478cfbee8e9) Function + * [setAuthor](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a0799afa68197fad61909e0a271e28993) Function + * [setDescription](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a04419d1a39017fa8f13b83720fdca196) Function + * [setVersion](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a13e4e0a07dfd282fa44afcb16c06aac8) Function + * [setHelpURL](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1af83b75cc2e88ab4935fdbd04e094bc21) Function + * [setKeywords](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a1cafe3fad847bbafcea6adc616c2f97b) Function + * [clearBusyFlag](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1aa73cb2b559ec21ef817b241e7f943e8a) Function + * [addToModel2](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ab0bc1abd000532d2d89d6179868431fc) Function + * [setComponentRequirements](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a0b44c7a2dbdcac528e00911168a8ae05) Function + * [setIcon](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ad14bf669563d84f430c220a1bc1bd94c) Function + * [addMethod](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a1ef6ce942ff5def3c8faa1c4d6d52106) Function + * [addInput2](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a915f8989fd54300d4ce830d37c2682bf) Function + * [addOutput2](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a34633d249d8fd7b02a28c3158c6dbae6) Function + * [addToModel3](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac2d1861e463ef89757948bb091502dbb) Function +* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) Interface + * [hasChanged](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad7310b48379f9d4f8d4688d11ccf0185) Property + * [hide](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac7ae926ce6dea385cb26901c86c7fccd) Property + * [OwningComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aab060b2f29895c77882494f7194f55e0) Property + * [size](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a9a38726b51caed75a30ae66b82959f64) Property + * [autoSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aca63a47369d69cbbf53532286b64a611) Property + * [numDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a29af128098031d3d75f20bb0fafe633a) Property + * [length](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af118bdf4b120050d6700a7ceae7f5bec) Property + * [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) Function + * [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) Function + * [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) Function + * [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) Function + * [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) Function + * [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) Function + * [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) Function + * [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) Function + * [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) Function + * [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) Function + * [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) Function + * [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) Function + * [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) Function + * [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) Function + * [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) Function + * [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) Function + * [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) Function + * [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) Function + * [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) Function + * [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) Function + * [toStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a37c622ae9f50579f714ce98c0379cd98) Function + * [fromStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad23f4082662c464be07251d6d1695a2d) Function + * [toStringAbsoluteEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a2e3041440581aab716c684fe88d2ee87) Function + * [getLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) Function + * [setLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) Function + * [setDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) Function + * [getSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a3d171136e0b219dd4e2d0d1b4bb9aa1f) Function + * [setSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b7b41ca5463a86aecb2368d73464c0e) Function + * [getDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a83abe70ccf5e8a0a582748d84e3d7956) Function +* [ModelCenter::IAssemblies](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies) Interface + * [Count](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies_1aee7be5ec0b95eaea973eb669981b4804) Property + * [Item](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies_1ae6f3debe976f58187639b34a900ea2b1) Function +* [ModelCenter::IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) Interface + * [Variables](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a88d34960f336b71cc7f4beff3b4bbaba) Property + * [Groups](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a1e5ca5f83e7c3debe3d63366948ad894) Property + * [Assemblies](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a00afe3dedbc3bb8b8a1cbdf5bd6333a1) Property + * [Components](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ad4c0ef9792a2f760b3639357126e56f6) Property + * [iconID](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1af8ddf59c545db7695b90a2a64bdcc822) Property + * [IndexInParent](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a6e888824a16134a6797ec96745c9dd4f) Property + * [ParentAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a8cccd51f677c2d7c29c734a2c1009f45) Property + * [AssemblyType](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a12692b24f7c9fceec97847b204afecc4) Property + * [userData](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1af405572d6c2bafc56164b2ce5b97b1a3) Property + * [getName](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a4b41d24972378517a23efafc6a0fc403) Function + * [getFullName](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1aa62ac6d1100f85d3f212185812a9e517) Function + * [addAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a1a55454ec16eadd67d23a8e134fccce7) Function + * [addVariable](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1af05ab7c452794c56cc54d77113cefdea) Function + * [rename](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ac180bc4a2120cd22964998c75eed05f5) Function + * [deleteVariable](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a92a8b6a732ebcd29f6fb33a448f9f4c9) Function + * [addAssembly2](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a1c73a3675ee4a70e9b31d2f63c86e630) Function + * [setMetadata](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1aa1e66114f498d0a1238237ad6caa1348) Function + * [getMetadata](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ad0ea6a9bc76c34b8158454e27bbfd9b8) Function + * [getPositionX](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a476766c4bdcb9fb07f1fdd0a12a04ac0) Function + * [getPositionY](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ab58695afb7a8ecb8202a1b20011d384a) Function + * [convertToSubmodel](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1afc8d8acd50c53726272ce0c983aa640f) Function +* [ModelCenter::IBooleanArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray) Interface + * [hasChanged](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a5231acb6d280e70ecf75f906a357e3b4) Property + * [hide](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa6cabd1afd2f36f8e431da7342e9bdb7) Property + * [OwningComponent](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a22fbdf9f77a399b4c536aa78bcd826bf) Property + * [size](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ada4924e975e5e04d2c6f7104f2626212) Property + * [numDimensions](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a3edf21f87f8614c2b603aafba6f10cd2) Property + * [description](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ae3788aac4468e5c4d62e002663e8e729) Property + * [value](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aafaaa11ebda98ac168f489abd5385422) Property + * [value](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a71678d5b3009123d0401d7715c5dcdf6) Property + * [isValid](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d13fb275a266aa85280b6beed8be176) Function + * [validate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa221cef15629c5acf569329c0e089b3a) Function + * [getName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a471100848db5a6f0c08f2920aa283ac6) Function + * [getFullName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a498741fde4d9eeec6eb3f8171e3161d8) Function + * [getType](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad8d2b43dd9f4b3656dba1e8570f7f747) Function + * [isInput](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa87e846de03852ee40e909935c2ec470) Function + * [toString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a39294beb6d830e498ee8aca7a25cc4a6) Function + * [fromString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1af5d6c192774673f4f4bf7514b35f8ccf) Function + * [toStringAbsolute](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa07f73fa1f449045d77725b0fef00739) Function + * [invalidate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a04e162fdfae6e99e6dcfd926adfca7b1) Function + * [directPrecedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a605c25813e75d1709e364eef080f68e9) Function + * [directDependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a6ed20fe44044c682471c7066ae2bd303) Function + * [precedentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a428a6e6a2a2be52d77bfe96323fea64f) Function + * [dependentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1abadb81820fd0b415fa9e78ce6c867c55) Function + * [precedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d7349a2273e5b9eaaab5271918eed6f) Function + * [dependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a386477ffe54e2d0f351f9dc7fbb49712) Function + * [isInputToComponent](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a871c46c1f732b2885e2ef1fa2080a3e8) Function + * [isInputToModel](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a364726a017aca71bdb22d43530cc9426) Function + * [setMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a772ffc624a737a4808eb8dfc9ff41e0d) Function + * [getMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa6b44db219dbaf49be81841dc459f4ae) Function + * [toStringEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1af151b1686dbe379f876131afd8c2c71e) Function + * [fromStringEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a8d7b18dca2bbe96aa0ee3718e433e272) Function + * [toStringAbsoluteEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aaa425c05112e2f9568bb13886800dbba) Function + * [getLength](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad9da4a66a831de9a501a7aca13a6a84f) Function + * [setLength](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a2bf47781f038fae8dc22e6edb04149a9) Function + * [setDimensions](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a6a526c3b8680b1f5ececc326a340d14b) Function + * [getValue](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9aa72924449a81d937830715bbe7503e) Function + * [setValue](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa3bdaab478a67db1dd4cb7921de5ed72) Function + * [getArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ac522da7a239f7d74e52a445351e5996a) Function + * [setArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a783239a87a41ba31461d61df639dd5f4) Function + * [getValueAbsolute](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad975bca587185786df34ddd600d7fe96) Function +* [ModelCenter::IBooleanVariable](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable) Interface + * [hasChanged](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a5b428150a22e87af248e5fc3277c70ae) Property + * [hide](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1aa3a5fa8309ca19d0bf787bbf7cbcbf54) Property + * [OwningComponent](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a67bcc3bdedde454663601bb945dd5bff) Property + * [value](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a025854ed57fb252dde2b341182cd7e7a) Property + * [valueAbsolute](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a875503e8827a33a2d15497b21c50b840) Property + * [description](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a8035fb2b8276762f7b0b2b3e8b7d8cf5) Property + * [isValid](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a877899b0c2bcc8400bcd8cfa31c4eb7a) Function + * [validate](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ae3cb5f6c787efb879f5d85a5ee5ee344) Function + * [getName](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ac4595a4a7f2b81c6c5c2f1f5e3742f56) Function + * [getFullName](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a19c8cfbcba0c9fc8eaae14bfaaa07d39) Function + * [getType](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a6e68844292a9f0b5e1924728465d02c0) Function + * [isInput](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ab8445c95fe06a4eb82ed55034c26d34e) Function + * [toString](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a97263640728fae5de92a272345ce0a01) Function + * [fromString](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a8b9fd88143b7b23e5f3ae9e229774a2b) Function + * [toStringAbsolute](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ad3fdc29d883580eaf57b83a7b796c703) Function + * [invalidate](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a1eecc6708b4fb8e29bfe73ead410adaa) Function + * [directPrecedents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ae54cdcd132e22278b8ddb00aaff236c7) Function + * [directDependents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a40dedf6b7b841a6699d545ea058ad2cd) Function + * [precedentLinks](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ab5b740c028c3b878f1341efea2df0116) Function + * [dependentLinks](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a69e716f024970454d8c555c73df17360) Function + * [precedents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1aa43bd8ee475029fc466b20cd3b1b686d) Function + * [dependents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1afa6ea6f99c9eeb606ebe08b1e7d9c54d) Function + * [isInputToComponent](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1af27600cef7dfba2a97acbeb31e2bbe43) Function + * [isInputToModel](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a38875f7d7b47980f4d78d76a449bbb01) Function + * [setMetadata](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a6771c11a9e1388bc4da11b9fae91e2e8) Function + * [getMetadata](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a74eae8f0c59826ea05228abfc9a9354a) Function + * [setInitialValue](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a37b148f160421cc772d96d616cc58a67) Function +* [ModelCenter::ICachePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin) Interface + * [Url](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1a8dcb7034aa38f98bae308f4a9425ee43) Property + * [LocalPath](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1abfc95b5a36c4544b8f58aaffc0d74751) Property + * [IsValid](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1a6dd8e8226f7d5b089ef7e4ae49ca8b87) Property + * [releasePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1a4349fd2038cad3cc22e04eba3d9effe5) Function + * [checkinOnFlush](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1af839cced75ed11439b0027a55c6ab604) Function +* [TradeStudyPlugIn::ICombinedPlugIn](interfaceTradeStudyPlugIn_1_1ICombinedPlugIn.md#interfaceTradeStudyPlugIn_1_1ICombinedPlugIn) Interface +* [ModelCenter::IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) Interface + * [Variables](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aad57025fe620abbaae1543962ed2676c) Property + * [Groups](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a4393774e2d80bd06dfe8070ef87b146f) Property + * [userData](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1ae7e1acce8fef11c88ba939aba11604ee) Property + * [AssociatedFiles](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aecece7b57424f027ba567415051d3bb5) Property + * [IndexInParent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aafafc5168a78769e88de4505174b0daf) Property + * [ParentAssembly](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a2da9bef2e46c87080698e624d80710f0) Property + * [getName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a19763f04596904ff5cab2f4f72f6f501) Function + * [getFullName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9309a89032b2d7d28baf279a3b76b5e8) Function + * [run](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1adf60ad0c84852250f14d27cfa689d8d0) Function + * [getSource](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a7ee6752f95f3bdfbe83132a3a7794cb2) Function + * [invokeMethod](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afaddb2c21be03b26716594af883a51ee) Function + * [invalidate](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a73c230184c72f5abcb7d3af5f91c9d1e) Function + * [reconnect](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a44d641cc9d4a797f88e56495c466479c) Function + * [downloadValues](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a761c665246557b5b4201873a722d6fed) Function + * [getVariable](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afb270ae53383589c63f87b4e3385f128) Function + * [rename](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9cae71e48e01e94d48c0353d3db4d90c) Function + * [getType](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a04395c5a8d6ceff26ae08e6c001bdd45) Function + * [show](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aa35c0fb45f677b3c2daf475e53107773) Function + * [setMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a41eb816b08e0e89739822ba87e5416c6) Function + * [getMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a2bd6e585619f4cd76426932b62dcf60a) Function + * [getPositionX](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a0c3e0c952584ba25801114e01010eab0) Function + * [getPositionY](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1ad3da2b98a973112ea897cf3b146f0276) Function +* [ComponentPlugIn::IComponentPlugIn](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn) Interface + * [construct](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1ace85f5a1c843051fe7513c591c373164) Function + * [show](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1adeb4964522dc6e485c3de4bef39a9019) Function + * [toString](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1a14fe2c260d7d43a7f6d1cf661a34189d) Function + * [fromString](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1a3e35deaee9587905584aa8926b2076de) Function + * [run](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1a8745a0b6d995a55b708876bcf0b6d7ab) Function + * [onEnd](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1aa280f5643ed0afe304a3ea2556b41159) Function +* [ModelCenter::IComponents](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents) Interface + * [Count](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents_1a657951d45a2e5d44a882ecc04e4abbae) Property + * [Item](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents_1a497784a98d679aa2ed109130ae004e0a) Function +* [ModelCenter::ICustomDesignPoint](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint) Interface + * [addVariable](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint_1a3c20c3bc3fa7ae5fb36154448d3ae13d) Function + * [runFailed](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint_1a7c8bc37e4f17ff29cc066d8e9645d9dd) Function +* [ModelCenter::IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) Interface + * [isVisible](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a986646a10f5885304323ceb7a737c76b) Property + * [storeCurrentDesignPoint](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aed3d0ea61e181d39e6bbf38a5ad0a401) Function + * [enableGraphTab](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa2efe037d15784acff1d3291c482f276) Function + * [show](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a2dcb6077094c93a8484123a0c5633dae) Function + * [addCustom](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1acd3adc12cd4f94a2dbf436e8617cbf8a) Function + * [selectX](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a54fca30f8b9b840cd4d130fffef89ba8) Function + * [selectY](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a82393da70a02822d7184a81430f45b94) Function + * [setNumExpectedRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a2760890872ed478c72439fc063f4e9aa) Function + * [startRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a4c2a3c1d083373801689d9dacc1fd530) Function + * [endRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1af2b0ccb145e2775fc9958d3500cfb4bc) Function + * [getNumFailedRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa169d7ec12253068db8fac00e201f6a9) Function + * [getErrorID](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a5fac36a5e20d349ab8941387af60a576) Function + * [getErrorMessage](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1ac93c96f43f475bc237f396b717bc5408) Function + * [getNumRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1abe6a941ef83e86184ba40149f775d3f8) Function + * [getNumVariables](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1acaa00471b667aa04d3462fa4e26f8d36) Function + * [getValue](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa3502b40206d864d5bebd8cec59c71ed) Function + * [getVariableDescription](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a12a4f4daac61b17022aa54dcbb3ec84e) Function + * [isValid](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a2d858bdac93de126a13ced552898b3f9) Function + * [save](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a7d30505236a3c1c3b804da8f7f924e26) Function + * [exportToCSV](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a75c4f95d0b30e6edb92f98e378f7c4be) Function + * [toString](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1af9938e6a1943072ae9e89a19e4461a3f) Function + * [fromString](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a42e57bafd047e98fff2902f213c48f61) Function + * [getDataExplorer](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa0b0a16e2c3c1f600a8435d6dca0c096) Function + * [hide](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a75d77af56d17b13040ea831d957a4cab) Function + * [enableCarpetPlotTab](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a1e13b83ec71a3274399832bfe3471364) Function + * [storeCustomDesignPoint](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a0beef1e5e859c093f079e64792e9ed8e) Function + * [createEmptyRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1ab152e50d67d452b3f301ea18f732183d) Function + * [setCustomRun](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1ae0c7fcaf40dc9a73c3818e08fda4c954) Function + * [newCustomDesignPoint](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a04f9887e54ecdb60a1f30abbdfbf975b) Function + * [enableMainEffectsTab](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a11a172f0d359597318448e52fd991843) Function +* [PHXDATAEXPLORERLib::IDataExplorerFacadeOwner](interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner.md#interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner) Interface +* [ModelCenter::IDataMonitor](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor) Interface + * [getName](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a69e3af3092c78b0c19d9e3fb719f9b4b) Function + * [setName](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1afbfd0ce277fb01a5539d791b371ab0de) Function + * [isRenamed](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1add033400b2b1694d63f67126639c198f) Function + * [getLink](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a9861b3ad530a4efbe4925c89550e8cc5) Function + * [setLink](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a89561753d60d803cc6427c6af5005484) Function + * [addItem](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a4b0569ecb495f20688d98060df763895) Function + * [addUnlinkedItem](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a8b2b470a890a2177bc1028408c7275e6) Function + * [removeItem](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a6137208858071bb7fa35bebadcbaea47) Function + * [removeLink](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ad8044ca189f473cbbf095756dd2668f9) Function + * [getDisplayFullNames](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a0cd9a14f007afaa719e20b54439ea98d) Function + * [setDisplayFullNames](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a8be2f10ef4448bc73d4dc7c57f3350ca) Function + * [getAutoDelete](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a163f13ac67226dfe0d816950061cc386) Function + * [setAutoDelete](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a19e11dabaf88dae88622b82e9e53954a) Function + * [getDisplayUnits](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ac11b644fdbd9f5e184a120a3bb6c7eb0) Function + * [setDisplayUnits](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1aeac431029c07dddd0397914f6fb4d9d1) Function + * [getColWidth](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1aa7c5595c9eabf857b3adc02d30dcbb8e) Function + * [setColWidth](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ade404d7ea696919bbc331c9027315c0e) Function + * [isValid](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1abc151c7ba70d7f1e6249942a627e2171) Function + * [getTitle](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ae6aab41ece2d9cf2ac4285aa10cf156e) Function + * [setTitle](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a74456073f4bc7e13d954972991583b58) Function + * [getWidth](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1adb51a1067e48f2e1ab9b79874a2d8a66) Function + * [getHeight](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a906ba9f57a9a472e1a70c151a50b1155) Function + * [setSize](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ad76100b2b7c20def871a1ffdc745e5da) Function + * [getX](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a610ec59f3295fe819e3a1aadd043927b) Function + * [getY](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a15d2803f54702b2198a2f0dc3f36d80d) Function + * [setLocation](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1abb2aeef39615e67a90e950314ea02744) Function +* [PHXDATAHISTORYLib::IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) Interface + * [name](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1aecd9b3210d5ef87459cb8a9830bb0f94) Property + * [equation](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a3901f5a0e0dba161b1746d3869d83807) Property + * [isDesignVar](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a6429c927c6b4f5937ed8f046ebb618dc) Property + * [isNumeric](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a72127ffab32587ffbec60628e70df2fc) Property + * [isInput](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a36394ba4430c4f15bd18a02a96ff9c00) Property + * [format](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1aee5d1b31138b410b58410abbc82cf441) Property + * [enumValues](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ac0461a8fca66f784a7f1a66b77c952e7) Property + * [enumAliases](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1af3b9b49e293ed90e0e36ac8cd64a1d5d) Property + * [lowerBound](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a559e14d8841091219ceb4c121ab8d1fb) Property + * [upperBound](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5e7eff43bb2a4ca6eed5cd8e95b0e182) Property + * [type](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ad46181f350249f42a737877eb3ce6c97) Property + * [units](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1aff5fbd1ebbbe6b3d4bd7ce114a09f40e) Property + * [geomScript](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a1fa79813f4fadc3f9f668aa5d433c431) Property + * [isBinary](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a18d61da08976eabab25b4049726415a5) Property + * [fileName](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a441ac734f55bcc3351b2e475524bd890) Property + * [getNumEnumValues](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5f133f6ecf8e21010e1a624221f78d5b) Function + * [getEnumValue](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ad6bfcac769bd40c96db19848232fad3f) Function + * [getEnumAlias](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5c03822c2d28cde3b9d0fdf4f335a594) Function + * [getNumEnumAliases](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ac865d961f3e4aa6fdb21c65f4960e7ee) Function + * [setMetaData](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a9479fcb9ffceb4360b99be62d77eabad) Function + * [getMetaData](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5c33238aa348f88bd3a7c66cde890631) Function + * [SAFEARRAY](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a34d198c9ed66b975c39ed058511a3181) Function + * [copyFrom](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ae9e54933d6dd82e4d4aa5991b58b6ee3) Function + * [removeMetadata](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a7bd9389ff771d6b63aa3643c961e7223) Function +* [ModelCenter::IDoubleArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray) Interface + * [hasChanged](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a91e412d2c7f4955e11e24099601fab8f) Property + * [hide](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a009c7abd22ec22abd5367db1a29305ff) Property + * [OwningComponent](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa2e8150c160c33946dd92d8887b57d1f) Property + * [size](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aeb3ca2a904ddc619edad7828c6c4492f) Property + * [numDimensions](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a8bf3f208059aad7bc8a73fd4e6529053) Property + * [lowerBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a396e13c98a7680bc75354b6bf6b0487a) Property + * [upperBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad4a4c720baa19775898e45381b881fcd) Property + * [description](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a59b6ea0f39cadd0ec7b20b16c8d630ea) Property + * [units](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ae91fd63ce08d3af74fb22132b5626432) Property + * [enumAliases](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a9e195b698057e2d38fbb9c101ebeb827) Property + * [enumValues](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1af625775f6fdd957bb0b37ed1c86a3051) Property + * [format](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad0078a54f0aa1ede8e3d6d78a00a4f7c) Property + * [value](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab6fd11161c6f26426d3205c88025a962) Property + * [value](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aceacfa8c1f90207042abb68d4175679d) Property + * [isValid](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a4d7719052c0b341f91436d3a0da270cc) Function + * [validate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1abc755512c485531a61f10d2bc5d691b0) Function + * [getName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe2789906f30f6a082e5d3d79e2b5bbc) Function + * [getFullName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a225331135b6efad1b05c399869975962) Function + * [getType](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a59535b93acdadae5c47ebb3f148cc8a7) Function + * [isInput](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa0a3e17384092dbeb0cef004db873191) Function + * [toString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1af417ef0e71fabce8379be30e4d176355) Function + * [fromString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3faefed33c99ee3ffb10b5e0e21d239a) Function + * [toStringAbsolute](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1adbd82fbad4622d8c2d91533d536a7ea0) Function + * [invalidate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a032e132c6c6a61f81370942921ab2edf) Function + * [directPrecedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3ab4fe76950c76fbdd2e76ea3f4fb08b) Function + * [directDependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe14e74990edda2c656035bbcd8e2af2) Function + * [precedentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a640715d1e272c8f15d8cc4c2b466d990) Function + * [dependentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a0201276e7d000c4869e4798cfdb68d8b) Function + * [precedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a5973cfc6b1e41db214568a7e95979eef) Function + * [dependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a6e0601946499c985be03e00354c8acb3) Function + * [isInputToComponent](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a86e51010b5f7765c036af36bd9452622) Function + * [isInputToModel](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a78d5b37b715d259e29e0de79fa58508d) Function + * [setMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a56d1d2b85ec3b4c43589c25887c1dd95) Function + * [getMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a1a41489453d177315ae18ef464e8907b) Function + * [toStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ac16f0cbbb0d4c51cb5cc7dfc0c251f88) Function + * [fromStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad068bdf2a8fb66fea7cfb3a3111fb176) Function + * [toStringAbsoluteEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab1252981582cec6fd3662321c9c4ce28) Function + * [getLength](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab0632e518febc3b1549fc35d932fd451) Function + * [setLength](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a5e70599413156ef04aa8ddfd03958320) Function + * [setDimensions](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a397d1abf4ecf0a106e84112b5634efac) Function + * [hasLowerBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a4a319eba200eb23b04f76abf8780c1cd) Function + * [hasUpperBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a1460ab1d3ab8aeef7679c93c07fc8138) Function + * [getValue](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a2e4c0ae7dbfe8869f56ad932ba0b22db) Function + * [setValue](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1acbaaac83aab3ce3951ed1be15ad3f6ca) Function + * [getArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afbdd49bff040a71b2be64a93e6705b21) Function + * [setArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad252c204a64ece94a946dcdd22e569df) Function + * [toFormattedStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aac1d778fd393456a7097eb9f6ac40daa) Function + * [fromFormattedStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a21c8a18bd7cb6544d526fbe1c27e72ea) Function + * [toFormattedStringAbsoluteEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ac4c96b591adc0b61b3db5eaa90c3b3cd) Function + * [clearUpperBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa1657e3679484a86e997a20256eef5b1) Function + * [clearLowerBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab93c1d5caa0fb18eb4d41499f5c708b7) Function + * [getValueAbsolute](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a2d9a833f72d05827c32edda52d0584f3) Function +* [ModelCenter::IDoubleVariable](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable) Interface + * [hasChanged](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a547bbc74c5db046b8d125cfbc3a6ab57) Property + * [hide](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac8bae6ed29215d02364f98a876f2ccfa) Property + * [OwningComponent](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ad15c38a3b89a2fa2be6e2f6b88268fd2) Property + * [value](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1aa7a7d4145814425b6ea93e831854d84c) Property + * [valueAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a364aa148101fa8ea9ddc2d624f96fcf5) Property + * [lowerBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a8d74ea79cd0203c477fa96e2410ba176) Property + * [upperBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a7585c786507e272216ec790ce278fd10) Property + * [units](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ad5b4b178eafbe9ebf4e55b3f5e158622) Property + * [description](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a491df2e849d05621978fe706bb48de85) Property + * [enumValues](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a0c6cd245f4c6bacc15398f88522a2992) Property + * [enumAliases](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a531c146537c198a1c71e5c5826757b01) Property + * [format](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a6181c6c0985068e31fdb725d719ddb35) Property + * [isValid](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1b873587774671d25664c294323beae8) Function + * [validate](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1abddc8770d26e37ac9319be5b90bc6e3e) Function + * [getName](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a10978bbb428eadf01141d2ceb2373c7a) Function + * [getFullName](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a00a7eca52d31c8f86e049dc1896d2434) Function + * [getType](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a974708d2da959d48ee301088918719fd) Function + * [isInput](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a162bb6a2a0c8cf5a2f3ee15daaaf85c2) Function + * [toString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a59f1d75b8e24323ea9bf523159f04f69) Function + * [fromString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1128d6c344adde4e9f9d95b0c19f87b9) Function + * [toStringAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a89797e61eedee333bd67b55b653ec21f) Function + * [invalidate](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a9abf6ea522bbff16d7c2266202b5bdae) Function + * [directPrecedents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a7a14b5ef10935109b178062205b91b7a) Function + * [directDependents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a6178082dc3de5e1f6665f4faebcb8c36) Function + * [precedentLinks](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a8bf056e8b989223191b2e8c7595c0753) Function + * [dependentLinks](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a385019a97e3ddbae4351fd6dd591a49c) Function + * [precedents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac65d0d53de6aee17106700d60161e9cf) Function + * [dependents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a04becbe1d34e232e21208333c0700e3c) Function + * [isInputToComponent](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a18112e5a20ca1711e97f8a5514995a49) Function + * [isInputToModel](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a34bbd8b682a39cbe120f972f0be7b1cd) Function + * [setMetadata](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a499a962844cae63886b79779e39db700) Function + * [getMetadata](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a40ecee96822db8b700fe1a814b2ab3b1) Function + * [setInitialValue](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a34b3939cccf3f8862301863629b63434) Function + * [hasLowerBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a18723d07a18cb720d07bebee26f35d2f) Function + * [hasUpperBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1aa78deb300d4f268523777fcabe898ce5) Function + * [toFormattedString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1fb28d4b74c3d0121725f15773f7d1bb) Function + * [fromFormattedString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac054c3628e2d617a1972dc195cacec60) Function + * [toFormattedStringAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac4e47bfae3990e33c748b44580244be3) Function + * [clearUpperBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1aa8846eb2c93d138bf7b6c31d78f0dc56) Function + * [clearLowerBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a72ee20ae45907f6f6738dbba0ea63655) Function +* [ModelCenter::IFeature](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature) Interface + * [checkin](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature_1a8cb220ceb67de96c199d761396bff884) Function +* [ModelCenter::IFileArray](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray) Interface + * [hasChanged](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ae8928b3be9d425c01df1a6bc1052eeaa) Property + * [hide](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ace9ef38b4495497cd17fc358d675cf58) Property + * [OwningComponent](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aa0d97988f42416ca68f47e1fecfe6e73) Property + * [size](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aed6f1989cc53493063439e96852be675) Property + * [numDimensions](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a757e103b1c6f7e5921adf31b7b1049ca) Property + * [isBinary](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a66fab48ff61be8f9c8e21bf0c9f96f45) Property + * [description](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a8be2e0c977d8808648829d523c841d36) Property + * [saveWithModel](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a2ce9625b3829cc7569fee6949e227dfe) Property + * [value](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a5b7408868a080c3d2b0b6812dc13a536) Property + * [value](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1af89ea57b9feb5597f3e190af1c8b5bf9) Property + * [fileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ac8e13d4f87d1c0b784c5ebafd030fa57) Property + * [fileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a12eb5e82033d54430ee309a0ca2ad254) Property + * [isValid](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a1d3371b70abb06b2eff5d1ada8aa114f) Function + * [validate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a506a66d66cb52b49d7385351bf0cfa46) Function + * [getName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a3f04f85ebe4f50a88c7cc3a61ae597f6) Function + * [getFullName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7aada275954e2fff6bdea69b8a96bd0c) Function + * [getType](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a6614c3d1ae621d218762e8ed8ec58222) Function + * [isInput](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9e45ea90908321e84979e5b8d2f50357) Function + * [toString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7ba909789490822b7ab12891075a9e56) Function + * [fromString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab107312b8a5b1e8e96ae2a3678ef9897) Function + * [toStringAbsolute](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ac8f43fca8b974b224bd64a78bd3bdda3) Function + * [invalidate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7599948212f77bb66f8ef42fc98e53ce) Function + * [directPrecedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9f84f73f3b65f16fa507678c53c67527) Function + * [directDependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab61572acbd0617f5c51b04b2ae4bbdba) Function + * [precedentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a998c2f1327219560aacd3d65d2c178b6) Function + * [dependentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a90373b06919789f06f52dd22a0339847) Function + * [precedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1abf61619be1e057cf2c42189456169041) Function + * [dependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1af16a20eacc6734b343762565ec8b20d6) Function + * [isInputToComponent](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a29e9bceef09e96ad83ce6c0618eb17dd) Function + * [isInputToModel](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1accf93e4a9fe2c9eb205ccdf1704f3f9e) Function + * [setMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a46a06089e51539cdb69a6404db042d28) Function + * [getMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ae315b5cc3acb88a2edabaa8eea7a6690) Function + * [toStringEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1afac8b4ceedd459ad68bed98ae18ea6a8) Function + * [fromStringEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aa104ba67a0164c27a33017aabd29d83d) Function + * [toStringAbsoluteEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a15dfd2825b183a80b93d849ce3429ca3) Function + * [getLength](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1acb6d739a4e50bcbbda5a5cf053ae21db) Function + * [setLength](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a66119cc8d733c8a2d6a8101569768662) Function + * [setDimensions](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a791424f1645b40c0b9b9d509effb1df8) Function + * [getFileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1abea033ef41f0f2ad087b24387772e09b) Function + * [setFileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab92bd8b81525ab620509e01219d733fe) Function + * [toFile](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a21c5941a7054482e4f7fd13e55db2738) Function + * [fromFile](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a83b3e976d1267ab9bb6e59be7bd741d1) Function + * [toFileAbsolute](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a118321f9f4f870bd9ec196813546b6f3) Function +* [ModelCenter::IFileSystemInfo](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo) Interface + * [isValid](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a7df18a18470a00422781d711e56a20be) Property + * [exists](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a5f79e2722103398d5f02e9fbb3c08c8b) Property + * [isWritable](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a349473cf74146c2b8c824e0c47c899e5) Property + * [baseName](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a0f840f7244ed0a52fa4d7c2a19a08264) Property + * [url](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1addbccbd60da206c6fb480eb4fe05e967) Property + * [pin](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1afc052eba4f15b6f7a62b0b0cee7b8e4e) Function +* [ModelCenter::IFileVariable](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable) Interface + * [hasChanged](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa81da335ee85ebf5f806be0b1bc1f39c) Property + * [hide](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a6c602247c4c00069af837d7dcbfb3862) Property + * [OwningComponent](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a75e79199eccdfb4f00ce0d27f2f1c593) Property + * [value](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a44a74adf54ce33e5e11d52ff561b37ad) Property + * [isBinary](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2d900fe8d944b0dceaea355cf64ba5a8) Property + * [fileExtension](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ad161b90c198e19be1132a9e5592e9416) Property + * [description](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac0f28c2d059dc02d18d3dd8eaba19f31) Property + * [saveWithModel](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a4ad8feb4200950e76e3ea66afcee286b) Property + * [directTransfer](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a248392894f6cd7f2662f29c3f110d7af) Property + * [isValid](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2d8ceabbeb9640dffb9f6a9e654bbd79) Function + * [validate](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa3fdf5883f1849f93bf87256b9100d0b) Function + * [getName](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1adbaa029c76034043ccdf2bf84bbd0e7f) Function + * [getFullName](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a5b0b8db5aec4ebfbd8e7918568c71b70) Function + * [getType](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aec7c7bb8f9e43d411c457d7b091e5378) Function + * [isInput](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a92363045c1f3285c5c1127ad149c0250) Function + * [toString](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ae28a776965df5807d9ce8b2e0d995867) Function + * [fromString](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac7654e743af45785904858d2c581058d) Function + * [toStringAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a0dda099769e13bdd8c5c076fc7d9378a) Function + * [invalidate](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2beb5e20db0843a92acf8d0cc961e3af) Function + * [directPrecedents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aea8561351c3ff1e003d463616682a838) Function + * [directDependents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a9347c073e1dc6ca62f1b3c7cd6fbec71) Function + * [precedentLinks](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a4bc52bbf01e5d0a0f95e67e03cce4547) Function + * [dependentLinks](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a46a1da5e2a3f39c2e413b520ec33407f) Function + * [precedents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a8db95046419c83467475175b216efe84) Function + * [dependents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac63897b5927f1ad28965384718c0de6b) Function + * [isInputToComponent](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a8ca654408734e709fddeb945e81a5d29) Function + * [isInputToModel](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a7bd0dbfb0063987f2484dce0cd61c8d1) Function + * [setMetadata](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ad532913f25d0b0d02cc2c27105e7ecc8) Function + * [getMetadata](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a730717369f8ddb8fccfcb3405c56afe3) Function + * [toFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa3da8eb730cd02ed21080272cc41deb5) Function + * [fromFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a9ca208f1854ac22bb31e38119e2e2af5) Function + * [writeFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac5ccf89eeca381ed315bbc4080c5df6b) Function + * [readFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a93be7b40a50c1d8b612037a105f8fd5f) Function + * [toFileAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a45afd477c357c9c3002a4046c1eefd32) Function + * [writeFileAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ae4220f9f0731a8078169bab709fb9198) Function +* [ModelCenter::IGeometryVariable](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable) Interface + * [hasChanged](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a14bb947193a4e5e629d104cadd3159be) Property + * [hide](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a1ed81bb22242904529b71361e954445a) Property + * [OwningComponent](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a9c9a3532f6f0ce9a907824f5e055e89f) Property + * [value](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ae013f10c0800acb5229f245f10d687f3) Property + * [description](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ad6ac49ae6d10a8aef6927eaad49e55f1) Property + * [isValid](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a01fe29466d2371dd25e6d9a473de32c7) Function + * [validate](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a62715d2cd23f7a7daafe7568d1a6e32d) Function + * [getName](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a2ab57d435f315c7afc7bed802b57d9d0) Function + * [getFullName](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a0b0e9f581b1b038395dacb2700d82ce4) Function + * [getType](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a09f10acb36a75c48c2cce4f1925acb55) Function + * [isInput](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a8c9a1d489060c768242c74b57e85aec2) Function + * [toString](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a0bda0cd0ea97014dc4be4ee2af69e55c) Function + * [fromString](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a710bd007c2d1df9c861a33a397c7a9d7) Function + * [toStringAbsolute](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a711f2c70a30362b587b39f5cd3775f71) Function + * [invalidate](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ac80cc84f95b559145c98a82367649d89) Function + * [directPrecedents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a8294d8120195193f3a5fba86abcded57) Function + * [directDependents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a06be08cd5896250dc5b31ec3d90b79e6) Function + * [precedentLinks](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a42168bcdab0805055df8432194d5654c) Function + * [dependentLinks](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a50e3d7ea1d97cd799c29901c2b563208) Function + * [precedents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a6d516295359de158c45bf2a5c0378af0) Function + * [dependents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ab110babf06372919f705e71b64cc733f) Function + * [isInputToComponent](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a3223f3e2305da64ecb24530ed3e1652f) Function + * [isInputToModel](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a324e6df2e0d789abb14a6ab9bbabb119) Function + * [setMetadata](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a3c257357cc786dc18d4187d14b030813) Function + * [getMetadata](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a9fa5015afd1b3cdd651ce2a0e093a6f6) Function + * [setInitialValue](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a61c5bac06b87725ae41b9a17f90b886b) Function +* [ModelCenter::IGlobalParameters](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters) Interface + * [count](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1a53be79855251a6bd40bd71f35c4f6d8d) Property + * [item](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1a1fdee032bf053c5f99b0291bf04dcaec) Property + * [\_item](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1a63a265a486f6a3a5df9cde8b65217d5f) Property + * [setExportToRemoteComponents](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1ad479e08f0fcaf6313a005c4fb3c80235) Function + * [Remove](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1ae838217b346390c972f8173e9a55361c) Function +* [ModelCenter::IGroup](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup) Interface + * [Variables](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1a6e92dee614068ff99c03164e7305119a) Property + * [Groups](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1afab9254fdafc011806a8834430af982f) Property + * [iconID](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1ab263da951c24595b88adc5b86fe93540) Property + * [getName](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1ae9bccfbc2ecd401d1f1403594c0ff513) Function + * [getFullName](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1ab1dc7ab3547d2631e64f683968bd0989) Function +* [ModelCenter::IGroups](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups) Interface + * [Count](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups_1a3bbbf56f26f76f5f051ea065aaf00234) Property + * [Item](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups_1a4a71e44eeb916bcdc8bee4ab891b237d) Function +* [ModelCenter::IIfComponent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent) Interface + * [Variables](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a377c50131d329f7fe0e1508bafff61dc) Property + * [Groups](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a491cb2ba622f73c3338ebbbe92e9da3d) Property + * [userData](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6590d1a787dc12285407656bfc22cbd7) Property + * [AssociatedFiles](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1afeeaebcaeafab038e2cc613078182c6e) Property + * [IndexInParent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a5c8b1a2d576bbdc2ea74f70b499889e0) Property + * [ParentAssembly](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae19efd7aa8ec8a537e3de7234b41ebde) Property + * [exclusive](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae32fcb5e2bd27ce4317da67ea515d40f) Property + * [runLastBranchByDefault](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6b9474faac3cad28e1a5d156438141a0) Property + * [getName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a97c817507e162f9422b2f73ab5c8cef1) Function + * [getFullName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a5766e80ec09baf80e3ad7c28e4dd3bd4) Function + * [run](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a7891e5012feff9e7bbdec3bde6adb8e6) Function + * [getSource](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae4cad8560e705e807f793a2dade750e2) Function + * [invokeMethod](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a583b809498c69beadd39c1e21e2cebab) Function + * [invalidate](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a78101d039853db9e2d989edef97f226b) Function + * [reconnect](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a67e294fa372905721460635514adcd35) Function + * [downloadValues](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a610d24ca2e023e09194b29c3115c6d84) Function + * [getVariable](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1af46fd2a7e5dda89d73e347b2fff75d16) Function + * [getPositionX](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a205b99507e64a1ad621ee6aeb6cd6d0c) Function + * [getPositionY](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6cddb9b21c6b3b60a23f2a28d60ea17a) Function + * [rename](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae64ae2e0082f2379391e6a49d5e57192) Function + * [getType](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a9cbf40ea5229f4240bdb241e8d88329c) Function + * [show](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a344fe33286c0d548dfb35b472cfcc1d6) Function + * [getNumBranches](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a667215e89aa8d7b6ff584ce7c2a9e566) Function + * [getBranchCondition](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a0a01eb7fd3513f7754534c229ef4da08) Function + * [setBranchCondition](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1af539f83e9e44adfccbff2968cfdb3f39) Function + * [getBranchName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1acd033bea89f3ba1ec760d9ad2c47d0ed) Function + * [renameBranch](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1afddf16459949f862d3329e2d6eb79bb2) Function +* [ModelCenter::IIntegerArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray) Interface + * [hasChanged](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a117efbea02cce1afa842341cf3e70bae) Property + * [hide](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5f571b35a242ad8260a3380f75ec5acf) Property + * [OwningComponent](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a9d3e429a72048e669d3e37f814294828) Property + * [size](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a49fc48bf1f28f403f2b96b92fb8e5819) Property + * [numDimensions](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a7b259767761bcb4f84893a2f8baaa139) Property + * [lowerBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ad38b7c1cfa620446572595dba1b607f6) Property + * [upperBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a1a062cc1750c92e8db32de2b53d83e9a) Property + * [description](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a9933e6b9d3328cf70f35075b8556e8ab) Property + * [units](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1afe8daf819657e592587af96079b0a0a9) Property + * [enumAliases](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ade7b31cc762cc412e399fff92260fb99) Property + * [enumValues](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5d823185c095e0c48f696a8ec27a78cb) Property + * [format](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ad328109c650cbcc2ca8cf08b688de6af) Property + * [value](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1aa7b9346ccbe5c4088c45e09ffb8b7d02) Property + * [value](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a2b4b654f1094bfd632e383909ea37bad) Property + * [isValid](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ab3d891c3978182e073923a56b4dbe89b) Function + * [validate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a84ab133f5b1147d475fb8e2c4275b32b) Function + * [getName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a79fdcc3e290b4b0df816f69d8a8d5f9d) Function + * [getFullName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a8c74276fefc00a8b85a576e1d1b58053) Function + * [getType](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a05e311dcfb051f0df6afc99dd01d6773) Function + * [isInput](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a3752394336c9689384efac1005422431) Function + * [toString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a83e5e9905df758b37c901bae5e87430e) Function + * [fromString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af3d5cd8601c1227d439b7b3f74cc2d16) Function + * [toStringAbsolute](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5bc139ce096dbc917734386869a3be78) Function + * [invalidate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a521514c594a1ab4e30669305585530b7) Function + * [directPrecedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae3879cd50b0512f2b5660765393bd24e) Function + * [directDependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a44b3a3cc73cd46ea7661e776b20b4ded) Function + * [precedentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ac71c9a184e57f627b336438de0b7a238) Function + * [dependentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a399b9b49ca3133d2a49923637f19609a) Function + * [precedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a01bd8fce84abbb243a9f7e3c771c185c) Function + * [dependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af6712999aa6e50091a95dd66db088661) Function + * [isInputToComponent](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a2a19aa7ca1e4c4fb862016aede378c05) Function + * [isInputToModel](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a41c321c0260174a4c118e309fbd13085) Function + * [setMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae69f586d5f6a7cf93728f99a47b841cf) Function + * [getMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a76933c6f159d52907c0b9f6ba3d13136) Function + * [toStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae3d6633e9533a68590025dee14298912) Function + * [fromStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a26f9cfd27774a2233ae2cb232cc8fec9) Function + * [toStringAbsoluteEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5794b0c172b46da36d761bf31046db07) Function + * [getLength](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a8167ef387b9cc11bc76e9a0e0694a833) Function + * [setLength](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a91d122341cefcb887c3871d43ea34524) Function + * [setDimensions](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a1010ee85bb6325b98fab48f96b582103) Function + * [hasLowerBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a37a15ea329f97b885f57b2660f8cf519) Function + * [hasUpperBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a4b31b367d82c30fef71bd2412482c25f) Function + * [getValue](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1addb4d3f364f0f952a6341b52616bb0cd) Function + * [setValue](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a18caa8754a18f914632f71675d6821dd) Function + * [getArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5e233233ced66879ff8aa58832981a7d) Function + * [setArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a89811fdbf06146c4bf0b14ea099df689) Function + * [toFormattedStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a895cc520f94cb105b922380b105f448d) Function + * [fromFormattedStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a9a6ac88dcfe81e7651c7cc5d15e4bf59) Function + * [toFormattedStringAbsoluteEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a7a0ff2e8e1875ee5465deadb6496b81c) Function + * [clearUpperBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1aa3f1505493e089a8717c092e37927600) Function + * [clearLowerBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ab51bcc939e91ef1da288c78be99a7fcc) Function + * [getValueAbsolute](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a7c1be797998fc344c26e23ce85d9057d) Function +* [ModelCenter::IIntegerVariable](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable) Interface + * [hasChanged](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a752e2918df57582c7e0639840f2653f7) Property + * [hide](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a0baef047e82cd94c3fe393690a129bb0) Property + * [OwningComponent](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a7156a5b9cb1cd09eced27ffaacd9f521) Property + * [value](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a8626c616deb64d587178b6c1cbdc2974) Property + * [valueAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a5e2a2a61e1c4978200a2009c1f6ab74c) Property + * [lowerBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a15d6fe654e10ea55a5df2e7bea934e75) Property + * [upperBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abc988cc945fcc8e2cf905c885a180542) Property + * [units](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a3752ce74846eb04caed29711d1da302d) Property + * [description](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a746f793efe758a7e3f36ba188d07ccee) Property + * [enumValues](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1af9ee5a112578385dcae1893f96f0143b) Property + * [enumAliases](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac706776dfc20b9410c859471f981f43e) Property + * [format](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac28287849865c6233468b6e1a9034248) Property + * [isValid](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ae03686387c15bc80d2caec8c3a5a913f) Function + * [validate](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a2807c2dd1e70fe7d8eab0af0a64e2d74) Function + * [getName](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abcd09429d47c396bab6dc63690e1a1c1) Function + * [getFullName](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a6bbb377e1c98a99b660cfdfa3c61f191) Function + * [getType](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a38de94bbe44275b88d92522926b1a841) Function + * [isInput](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ab441aa413516cf14c082aa39801250c4) Function + * [toString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a2ec6bbef037c4c0a6ab5e510f9063923) Function + * [fromString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a180292624fd43a95348bd496b0fee8a6) Function + * [toStringAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac13b9c8e85a30831a81cedcdca610e01) Function + * [invalidate](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a07f62e68cae660a8bea1d1e31d754fcf) Function + * [directPrecedents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a5c99fbda3111d689db126a61e0727106) Function + * [directDependents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ad783a3a7e231dd0aa00b869699a5bca4) Function + * [precedentLinks](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a02a977781b36247895725b38a725dca9) Function + * [dependentLinks](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a1328684b4767a3ee6b006feca4f0296d) Function + * [precedents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a902fe35d10c8e25b86a64e13953a62f1) Function + * [dependents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aa8739ff163a52ceed99e867e5126330f) Function + * [isInputToComponent](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a67665668e8c1abee8bc9db708b05e970) Function + * [isInputToModel](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a87d3f8de3185380e368fdb008466dfe3) Function + * [setMetadata](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ad80d2a2e770297e5e57af0cd86601f83) Function + * [getMetadata](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aea17e7f7dc6d8979c2c83aec3f8a0c42) Function + * [setInitialValue](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a4f198a32ba9ba7975e6a81f769a6df0f) Function + * [hasLowerBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a3f0459ca0bc1b7108721b4ee36304bc9) Function + * [hasUpperBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a6434f421569bb898aabc32204d615f1a) Function + * [toFormattedString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abf09981270a02adab12c6bd420e07a22) Function + * [fromFormattedString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a647cc6b6832eefd008c51457a34c9ff5) Function + * [toFormattedStringAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a7c3ea8978f890824c3e08134c7bf7747) Function + * [clearUpperBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aba1030008767dd31ae13f40f90ba58d8) Function + * [clearLowerBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a16f466aa207ea88961361ee69a683850) Function +* [ModelCenter::IJobManager](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager) Interface + * [wasHalted](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a103d78a1bad75512c13080d2467fb11e) Property + * [addInput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ab95c6155dd1c2dbd24441bf3641a5542) Function + * [setInput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1abd6b3fa7a63b620f95141c191cd1c29e) Function + * [addOutput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a4591b4c0b98d14307aa691f42547c97e) Function + * [getValidateAll](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a53f5cbf8459b20f9c748535d8013eafd) Function + * [setValidateAll](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1aefca61419c9622f520429f257aa6061c) Function + * [getNumRuns](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ae63c0e8eda0494dda49ee20141f11ece) Function + * [setNumRuns](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a89e662a1a1c15ed27f8517b5a526b94d) Function + * [submit](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad1b204f5e684c57b28dc1e3dc733e285) Function + * [waitForJobCompletion](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a65bfecf019c1e9c8752fa3c90fd5d3a7) Function + * [addRerun](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a3e06470a8599a950a01c275f75c0d6cb) Function + * [halt](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1aa550897654f63d845e410ac9bda26b8a) Function + * [getNumInputs](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad8dcd18454e462b191092edd4096ab0c) Function + * [getNumOutputs](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a49fae6444ed2747c716f7829f8113969) Function + * [getInput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ac205f68299271d8e97adbc34f7c33655) Function + * [getOutput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1aede4e8c73a70bff3143317d0fa8dca97) Function + * [getInputLabel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a4d6a218d3dfff84908b13db7016a947c) Function + * [getOutputLabel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a7665a71ea25ae6436d201cd2e339e976) Function + * [getNumThreads](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a2a6391025814c8b85861fe9d8eaebf58) Function + * [getRunInParallel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a8893b7830affcf596e4a6d149ab47753) Function + * [setNumThreads](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a034974bf844d74af316ef687be4b84f7) Function + * [setRunInParallel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a660d28f5c25a2efbe370cb162bc58f4e) Function + * [enableCache](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1af28b9a4ab0944f31f2d157ab6826999c) Function + * [clearCache](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a06a3f847d50eb2f10e3b061ea91b453b) Function + * [getRunIndex](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a03b40110aba59370e9eb6aad1b6b2076) Function + * [resume](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a1bce7921ac7cedd5712423589b99afb2) Function + * [setCustomMetadata](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad106f381c9834b32c12e169264f1272a) Function +* [PHXDATAEXPLORERLib::ILegacyVisiblity](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity) Interface + * [showLegacy](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity_1af5b6718a60c0ac08286e7ae40df8332a) Function + * [getLegacyHWND](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity_1a7a2562683a18b86dee7b0cb60564b5e6) Function +* [ModelCenter::ILogger](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger) Interface + * [isTraceEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1acef00afc02324874e8ff47c61dfb4455) Function + * [isDebugEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1adc9ab6356bfc5c95aad04ee887c21588) Function + * [isInfoEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a4472be2e0c0f6302d2e73ad582fe6b9c) Function + * [isWarnEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1aeeb727ee61ec84c356257e23c8ac72da) Function + * [isErrorEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1aea7f6bb4163869086c07a72b5ec14666) Function + * [trace](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a97945d07f653d3cb3e483b512f7c569d) Function + * [debug](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a1ff316d9091c838bcbdeaf5706e8216e) Function + * [info](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a0a400bf773ffc4fd5d9c4440fd2d79da) Function + * [warn](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1acf5456282ad4295bfbb5dc3d6c41b8b2) Function + * [error](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a576c679c95d7e5c38917bcc0bab46296) Function +* [ModelCenter::ILoginCallback](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback) Interface + * [requestAuthCredentials](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback_1a9a1b24d936f4ee5dd2979ad38538929b) Function + * [loginSucceeded](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback_1a4b7dc5df7be75023f025f8d83fff7579) Function + * [verifySslWarning](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback_1a9c27b392b3c109f6abe689251e1e27c7) Function +* [ModelCenter::IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) Interface + * [modelDirectory](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1adf58dfafa5401318de434c22d9e12ef3) Property + * [screenUpdating](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acc9b3db9f6b75b711cf8106947576e89) Property + * [modelFileName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1abb83f0e9475f2ccf8de46b09946d79e3) Property + * [appName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a1a5d90dca23414ddb8ef45e99c091ea4) Property + * [appFullPath](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a999bedcb3195dc2a12b034e0fa0222ec) Property + * [IsInteractive](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7fc1e5b5a0eee411b82f7508243f453f) Property + * [ProcessID](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acb08040260ee9e91a9a455c15d9fc0ad) Property + * [version](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3072c85db32956a1c302668a49b031f8) Property + * [getLastErrorMessage](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5a57f078a8de6d78e6cc4f808c761fe8) Function + * [loadFile](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a21295b971e1a8854d7524b85332fcb3b) Function + * [setValue](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a535535c056577a2306bfd089423a6e8b) Function + * [getValue](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8cacc6c81e217bf7affe180a59d21455) Function + * [createComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa1c2ba41e8aeff2bc97408fd6d5e8832) Function + * [createLink](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac46503f8f560edbcddd87fb9c9045326) Function + * [newModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a90ad7c497e4da5b9474d747ba6bd9715) Function + * [saveModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a16dc53d7c16d4517b6859acc1ee25a50) Function + * [saveModelAs](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab3fcf686594e1e2f81b7814bab8a6752) Function + * [closeModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a00bcefae609c5a453dd1f4e0586820fc) Function + * [loadModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab57546e9e718895bbdfa25bc1b7d1e9d) Function + * [getVariable](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af87c3dde3f5645f1257ba0edb037889b) Function + * [getComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a779902b1a3f3c4c0db2b58484ec75fe0) Function + * [exit](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aba655ef2cf9a8f639acde2697d8319a2) Function + * [createDataCollector](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad91dff33c09345053346ce2d831fd968) Function + * [tradeStudyEnd](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a85f4a4b6557102133fc5dad3ef0a1ff8) Function + * [createJobManager](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5878e18adeeafe78c1920e5544253442) Function + * [tradeStudyStart](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a39de949b1cdace01114ee9391fc4a484) Function + * [getHaltStatus](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa75908bb0ec202342833c666b10fcb66) Function + * [getModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5d42323e20b243257f4cef533dd58e7d) Function + * [MessageBox](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa31343d27c063cc384336028b12abac2) Function + * [getValueAbsolute](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a04408aef2e249b325db44eb8e0ca6758) Function + * [setScheduler](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa312b4e6e4585bd0f4d7cc9a69d1d7ec) Function + * [removeComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7bbd736a48c08e2eb90c4af45872e6f5) Function + * [breakLink](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a231cd11fa3198cc4a22db3ee0483b59c) Function + * [getHWND](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aaaa18b9967d91f5e9afa0f663fb4ddae) Function + * [checkout](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5ea6a58aa4def0e7d48f5c48dfc46d35) Function + * [checkout2](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3b8e21abd2354b4fd537084f36c9a180) Function + * [runMacro](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a762c9d09a2d611300bc3e09f9891c86e) Function + * [createAssembly](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a402db0953a58ac7573cf3585c938eafa) Function + * [createAssemblyVariable](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a72e28e9146e37b0854aaa3274b60362c) Function + * [autoLink](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1adea9c027f61fb0c23ce34a0e47924679) Function + * [getLinks](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac83decf1799275a0d13ecadeffb008cd) Function + * [getModelUUID](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a499de038ba95ad40b52862e5239bf18c) Function + * [getFormatter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a1533da4a5c2e70aa5b196215af7637bc) Function + * [invokeHelp](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2a8f95eb131aad5e03597ada8251ef30) Function + * [launchTradeStudy](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a24726ff2cf91ef85884d6b2bea513ed4) Function + * [createPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1afb0f2d3715e4a48c1ee1c865864c5314) Function + * [displayAboutBox](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa9057344d6d2ffc28569709efdbdb5ad) Function + * [halt](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a4cde569f8ca3555ede7fd8d3d2cd4387) Function + * [displayPreferencesDialog](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae8f7829bf075209faf0fcecf742e76be) Function + * [run](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a158d8bbb37d23dd35bbf87b1340c95d6) Function + * [getDataMonitor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a6212fa2f41e2132f8f40d78164059eb7) Function + * [createDataMonitor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad86e8cd5714f0d22dc84b1b71979fdc5) Function + * [isOkToClose](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af91d7535a069da55220c52b759ca5238) Function + * [addIcon](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ada4b443f077f7c53744ada601a3c12be) Function + * [removeDataMonitor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2dd2279b4d0250af8ae6d3506f55c57a) Function + * [setUserName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a359b38b4b8bc935b9eb5cf9e68a3a34f) Function + * [setPassword](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a677e2965bfb8998dc4546673f95355de) Function + * [getModelCenterPath](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1adc47ef3cf5fa8d766117ec19c7dfab92) Function + * [getDataExplorer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae1bdc8f0abc612490b737852f189027a) Function + * [getDataCollector](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a29b8af2a820e24e728425e6467881067) Function + * [getLogger](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af2d28cb0c0290a80ebe0e31f91497f11) Function + * [createPlugInFrame2](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acd338a67839da36df138a0521ee3aead) Function + * [moveComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a70986fc1018ab96fdbd507b4ebe568fc) Function + * [setAssemblyStyle](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af1bef892aa57d153cd63b6f4ba9037f4) Function + * [getAssemblyStyle](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab1d7ce6494121cd997115f91e91d795a) Function + * [getAssembly](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a461a8c0e8efdd3353da6feb22b232029) Function + * [createAndInitComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a049e13b6d3ba54dd40a162a16d03bb66) Function + * [getLicensingPath](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af5bdeb0442c6f35c0e5db849b1a166fd) Function + * [getMacroScript](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a16bc3b79ea75a2c2e9c6aaf48591f840) Function + * [setMacroScript](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae2b0614b8c0367ab7893c5fb32e14b96) Function + * [getMacroScriptLanguage](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8c930544d5f9fc2e49afb076b5ccee76) Function + * [setMacroScriptLanguage](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7b92a22213e11d5f4b3ad8dfe7a894f9) Function + * [addNewMacro](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a9d209b30adb83ac9fe48f8efd1959f3a) Function + * [launchMacroEditor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab180eb62170146926e7a6c2384d5ad66) Function + * [startGUIMode](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a06c77786a3965c9ca7c72c6ba7af7ad3) Function + * [getNumUnitCategories](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a0f6aab6d238cbe899af59725ab0de842) Function + * [getUnitCategoryName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1abe07ee5b95ed640b926a165f2e02b7f1) Function + * [getNumUnits](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad6a35e6ac78e89ddcd4a68023bcdd651) Function + * [getUnitName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aab8bb46de63e10f150e9614ea36d0b9a) Function + * [createTradeStudy](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab18e9a5fa259695357cd26f155ee95dd) Function + * [getNetworkLocations](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a375ab85c506633857e960502c208ed79) Function + * [saveVersionedModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac658a0c1392f2fd8b851794c9ac1896f) Function + * [saveVersionedModelAs](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab65847c07b712a58acfe6a21659518b5) Function + * [getVariableMetaData](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aebbf42a396f1eea5b917d13b85e0fb8e) Function + * [dumpComDebug](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a27b453e8058a238c25049c8fcb5121e4) Function + * [showFileBrowseDialog](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a9dabff9569cfbb6c65ccdae26aab3ff7) Function + * [showFileSaveDialog](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a23ea9bc699e8f31401f96d2594f79ae6) Function + * [setLoginCallback](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a156c716bde56ad5bc070f00e2037a2da) Function + * [createDataHistoryVariable](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5f2d90be1a4bed0126993b3021d24981) Function + * [getRunOnlyMode](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a38682504615aef9e603a9c2f3d4bd2e8) Function + * [setRunOnlyMode](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aba91dde2a4c0674816c3781ed873457e) Function + * [createDataExplorer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3edba311337bb171b956e0d331cfa05f) Function + * [getFileSystemInfo](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a6d6d38245d99b3f53fda689a1adee17f) Function + * [SAFEARRAY](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa2ca200dd05dc8257c35af74035459e1) Function + * [saveTradeStudy](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af139d41f66681c63c80243adbd48cbc0) Function + * [getDataCollectorForDataExplorer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a59b46ca7b15c869fb190ecfeb70bf90a) Function + * [launchDataCollectorPlugIn](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a434995395fc673c8197bfde7e1256240) Function + * [guiLoadFile](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a255ea30feb95451802aa280bdffcd7b8) Function + * [guiSaveModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8ad33e25dfad91e8ba248d399a1b6449) Function + * [getMacroTimeout](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a18766ae9a0fda73f8febdb709adfceea) Function + * [setMacroTimeout](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a559cd3b9f0e68e5ecc2c4006c8014667) Function + * [guiCloseAllMultiplexers](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8708a9033fcd77731539b085a1c6c047) Function + * [setAlternateParentFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a83b97e8dd461f4bc8fbe5cdc63809b74) Function + * [destroyPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a24cc8bd489975150c9d5c5c3e9502b87) Function + * [showPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad1fc33915ad5917cd645e795251f01de) Function + * [hidePlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a806cc1860aaadaa5496d4caa0a51fe91) Function + * [setIconPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a65a6502ad779fd4394d06f45adabc398) Function + * [launchHTMLViewer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aae5eb45abe323ca501a777f31b9ae5b8) Function + * [runAntFile](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2d684049210e4062f14cf2e3e2abb031) Function + * [getGlobalParameters](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2fac8021991150ab97e3673e4b0c0dc1) Function + * [closeHTMLViewer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a46b4e01256fa252da2f589af87833ac1) Function + * [HTMLViewerWaitForClose](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad62471b3a17a7b182d7f8fa0df7048b7) Function + * [HTMLViewerGetMyHWND](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad6f56123c0b435ffca19628deaa4169f) Function + * [getActiveJobManager](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a931fee19976a7a03e263284ec0ee9d53) Function + * [getPreference](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aadc031780e0355e1ca2bba83cb13441a) Function + * [internalLicensing](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae91fcfa7f9dfe5fa3df62fb9d3c703c8) Function + * [transformAVPoint](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a23a3683a4c5b5f4380e33232e2ca30be) Function + * [parallelInstance](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7dc06d52fa432893eaf74db606db3864) Function + * [unAssociatedInstance](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a21a60528e3b43cbbbbc131adaf5a1151) Function + * [configureLogging](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acb8cad870e072bee4a80b1902476929a) Function + * [setXMLExtension](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a70666088b3363b2c9738cd15ec446d8e) Function + * [getXMLExtension](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af94e33f84d46652cfad0af931db0d59b) Function + * [setPreference](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac7c886a8b0333b565333d6b16d9ab824) Function +* [ModelCenter::INetworkLocations](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations) Interface + * [add](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations_1a86769591b49fd0bf2ce90bfd45c24bdf) Function + * [exists](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations_1a6e6cf7b365025116e67b9ddd575b10b1) Function + * [removeAddress](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations_1aa7869edab5e7d597c67804e2d5dcf561) Function +* [ModelCenter::IObjectVariable](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable) Interface + * [hasChanged](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a221928e7f8f5b8f5ff309f6e768a8d96) Property + * [hide](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a70d41ee491cb94eaa45dd1e3e6c805c9) Property + * [OwningComponent](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a2cd4745b4fe97b79d205b876bd91835d) Property + * [value](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a778d71ffd4daf5160b2594672b0cb7c8) Property + * [description](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a73b60bd367cc0e6783f9e5ad0bf96811) Property + * [isValid](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a88a80a771329337246e883b3ce034400) Function + * [validate](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a56e476d33f05ee8b4faa077396704fa6) Function + * [getName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1ec0c0bce4884b2c8c1decf29f4d5b86) Function + * [getFullName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7d1acdd7a964ceb7d189c87a19e9bcb3) Function + * [getType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a40cc49ff4f6fd51695549d4ad32a4384) Function + * [isInput](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1adb2ffa6d382f3874d63cab8c53f956c6) Function + * [toString](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acc675e2c9045387d4ceb956d7d7d9f70) Function + * [fromString](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aca195574fffbfac6577eb4b0d54f3dd8) Function + * [toStringAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af042cdd3c4908daa767f6b0dce043e75) Function + * [invalidate](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aff411bdfa6a95ccc904878f1ffecba6b) Function + * [directPrecedents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aac5eb818fb62f131d6ecb13fd3f6aa34) Function + * [directDependents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af1b4238d92307aa3586b4f7070e497be) Function + * [precedentLinks](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a25a478d55d4855cdbf4f8753b6cd6062) Function + * [dependentLinks](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af52780ea6b4984f40b16c8c072e1b005) Function + * [precedents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a8c987c7df5766ca31115f25ce36f1f91) Function + * [dependents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ae106e94dca5f19c46ed9f82c67772660) Function + * [isInputToComponent](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aff062edf68ee2b0ff7db9b81cba0899a) Function + * [isInputToModel](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa0e5a61596a334437a407396c4a38e44) Function + * [setMetadata](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1d611e44da36abed0a41c6f688344841) Function + * [getMetadata](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6fe6bbfed4b08df8c9f9a4c86cb49ca5) Function + * [getClassURL](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7cd400b4cd38cacd370b5c2b6246375c) Function + * [getMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7143a8eed8b14b1b6b7772e82f472cd8) Function + * [getMemberValueAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a75f4995da0954629b58243f202e1681e) Function + * [setMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a44df8b08cf7cb9cf6d1a5b72136d5f52) Function + * [setMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6cef469cbdd030f510d7bb51e686c257) Function + * [deleteMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a30200ac90fd4115c2eb6c5641a77eddb) Function + * [deleteAllMembers](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a763852aed64e16a58160d166c8addd23) Function + * [callMethod](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ab1c0d770f00a0c466eacecda838b3850) Function + * [isNonStrictType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac232ce8558a68f9f27661644fbcee3b8) Function + * [toXML](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a9e16b89241b7593088803ace922f5ced) Function + * [fromXML](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a4697fd5d09c8ade51e7a905a4202e5e9) Function + * [hasMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1b153917fd978107a15c2b2283d9f1a0) Function + * [isNumericMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a068348508497bc740975b56559316baf) Function + * [reinitialize](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a481f787db359b10b814f9ff279bb1471) Function + * [getMemberLength](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acc1266cc18716f9973ec60f57c4a657d) Function + * [setMemberLength](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aec74047ec9cf7e9b93b0b4509da57f15) Function + * [setMemberDimensions](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a4e889147b9f6274163e2ede028fbf1b5) Function + * [getMemberNumDimensions](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a558bd8128469e74dacaae9236e57eed0) Function + * [getMemberDimensions](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac7ead6acd3c9f25b85e9670c396babbe) Function + * [getMemberType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa0e74d911fa3c06e65ae0061bb0a1740) Function + * [hasMemberLowerBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a2870271930867129b9102eec3c778b28) Function + * [hasMemberUpperBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac291b12d8f349c09c18162cda4299a4a) Function + * [getMemberLowerBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1afd9fba6ca47b0bf5fc48a2d210654d1c) Function + * [setMemberLowerBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1af9965da5833253a2234df86f677093) Function + * [getMemberUpperBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acbf0879d4bf1acfaf7cac4f32ef9df0e) Function + * [setMemberUpperBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac86c323427541c659a79974e19ad2692) Function + * [getMemberEnumValues](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a58394bc10f092128be001e36d890c0be) Function + * [setMemberEnumValues](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa2399f22fd7fc4daf9687fab4e4e512a) Function + * [getMemberEnumAliases](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ae8008b1c066e802a5838dfdc9775785d) Function + * [setMemberEnumAliases](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a18bf5de57cd2d0343bb90267608621d8) Function + * [getMemberDescription](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1abb5cd702a72b774a9b93a50c1a4a4270) Function + * [setMemberDescription](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7f78fbf9eec449dd61dd06f9d18cbfd6) Function + * [getMemberUnits](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa893e48f7214f7b0c31f5628c16ebb0a) Function + * [setMemberUnits](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a033310bf93afceacc24f097ce738a135) Function + * [getMemberProperty](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac9fe0949b94f5f8243a2b783ed2a65b1) Function + * [setMemberProperty](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a15c71dd9da7797408006e31677e9901f) Function + * [getMemberList](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a06be37e0fa407f4197aff2e534f61eb7) Function + * [getMethodList](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1ad90418c9d492ed35dbb1d20943035e) Function + * [toFile](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6bd774581876d61cdeaf9637e470b0fe) Function + * [fromFile](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a5e4a925c2918b6ac9da355b2287e3d04) Function + * [toFileAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a4904889be1812816c742b23763d0229e) Function + * [getIsBinary](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1afaad0639d6eeb9543d9ead12e9164094) Function + * [setIsBinary](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ad6f0e0cc2595b7a2726f8d38ec573e2e) Function + * [getFileName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a8f71ab194f3468c084aea4beca2c43b9) Function + * [setFileName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6824345c22985533b8e284b84e1c83f0) Function + * [getFileExtension](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a610338503721a3cd0992fa5af793b718) Function + * [setFileExtension](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ab1a52e485c1d4c0384d17dca0a2f74be) Function + * [getArrayMemberValueAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7b6b51c7f0eb9a262d1ba0a2bf831368) Function + * [getArrayMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a13f1700a491d9f13070a854092887b20) Function + * [setArrayMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1adc14eb60074b51d08f58f5f080f830b3) Function + * [getArrayMemberAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a24b1cc73d5868b9e8a3014209689d088) Function + * [getArrayMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a5dc9de363afe0659af36716807543b05) Function + * [setArrayMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a667cf875a43fda4c97325c3734ef9ed1) Function +* [PHXDATAEXPLORERLib::IPageVisibility](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility) Interface + * [hide](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1aed414820e7a805ab6ba5d08c437d7347) Function + * [show](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1a0e233fef605747c79f16a6032e4ebd01) Function + * [isVisible](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1aa52adfedbec735ae4d1e34c4daf66455) Function + * [getDataViewHWND](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1a00bc608cb2e87ea6a12c4da4497c4768) Function + * [getViewHWND](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1a19d4d225ecc6463333715ddde8c5f65f) Function +* [PHXDATAEXPLORERLib::IPHXDataExplorerPointer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer) Interface + * [getDataExplorer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer_1aa6b13b15afbe694654cbba4b3fa1157e) Function +* [PHXDATAEXPLORERLib::IPHXDEKeepalive](interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive.md#interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive) Interface +* [ModelCenter::IPHXFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat) Interface + * [setFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1aa34d6054f4542a34efb60a961ad78519) Function + * [stringToLong](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a9e0774cef531d24731ac6c320cfd837c) Function + * [stringToDouble](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a2576f20eaa4ec6133a734ea09d86130a) Function + * [longToString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a175332e4916d1d86855b1b707831e308) Function + * [doubleToString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1afdb6c65e615c3d5176129b51a1d44318) Function + * [getFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a6c3566f301404af75e38676198a8bf1e) Function + * [stringToString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1ac1b65cffaf6712d53e58935e3c1592c9) Function + * [longToEditableString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a2d5f201c8a8166ffeca606bac90d4b3d) Function + * [doubleToEditableString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a596665cb30835ccad7c6df17afffd8bd) Function +* [PHXDATAHISTORYLib::IPHXMenuItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems) Interface + * [numItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1a74bd895a7bdaa2b6786bb4dc2c4d12a1) Property + * [setMenuItem](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1aa76ac2aefb1a69021d5f536db66c0c4b) Function + * [getMenuItemName](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1aa8491483ad472e4f1f9e51ea028561eb) Function + * [getMenuItemDescription](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1a3213c537df82b4c00dd7f4df96b90712) Function +* [PlugInMetaData::IPlugInMetaData](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData) Interface + * [getDescription](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1aea971d69e4505696518f69057dde4863) Function + * [getAuthor](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a302223e3912f3e34a512a5ef323e0939) Function + * [getVersion](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a7cb8178dec412b370f22e7a9905eb3d9) Function + * [getHelpURL](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a81605db892f6e5dc71aa7a4f2d00686e) Function + * [getKeywords](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a38d839895f9ee3493710062d2bf67c34) Function + * [getIconLocation](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1af49ffd75001ae0bfd3dade7f5b9562db) Function +* [ModelCenter::IRefArrayProp](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp) Interface + * [enumValues](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a2b488ae83e3f61e8f0924b781b0fac1a) Property + * [isInput](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a6a71677c0367f53bb39861474c8ce11e) Property + * [title](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1aaa7d8507dbf83d2cad6eea2266fa98fb) Property + * [description](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a0b98819f11c5c2e7c916a4e629199d48) Property + * [getName](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a625e640f8adae51bd6f65a88c7f67299) Function + * [getType](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a60190ee41cfbc6624a138dba5c790d00) Function +* [ModelCenter::IReferenceArray](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray) Interface + * [hasChanged](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a32bab88b29119d84a6429364fd651411) Property + * [hide](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a35c7c4ee97058e1636c56d4863c58e00) Property + * [OwningComponent](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a4b37dc07f0e626f6b833b772d57b06a3) Property + * [size](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a0ec169188c7e660a32e9a3bc6792d26f) Property + * [numDimensions](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a05a8f727001f8d1794bc33960736fd18) Property + * [autoGrow](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a74f194b29d46aacb12b7d4c445df729b) Property + * [value](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad9e0cf09c5c40b6272808d3ba83489ba) Property + * [value](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a902f599bd7fe0bed1c5f1f51a49e291e) Property + * [reference](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a60216339479fb364f7e97cb5d9ea0b66) Property + * [reference](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1acd5c00c533970d30757f90445ec376cd) Property + * [referencedVariables](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad2c0541925f15b29800a9e924916615a) Property + * [referencedVariable](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1abb922c879568308b8c074165d596777e) Property + * [isValid](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a366cf132edcae4c78ff3c3c29d81ad03) Function + * [validate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1af1dd28c351fcda3e3fea31facbd4fca3) Function + * [getName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a282d98574e8d65d85c9908b6799321b7) Function + * [getFullName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a44ebe17869a3b1b95568ea46299a9f3f) Function + * [getType](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac3c3f33a239fe1182da434d7570346df) Function + * [isInput](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ae7e5c76cfd592a71fc7e5785c7cf6394) Function + * [toString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aaa37debc6216a5419715e0c542555850) Function + * [fromString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9cb9dab871b4e86ed66fb53cc5473ebd) Function + * [toStringAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a1a0ecbbccb3fe3404c79976e9f07b8db) Function + * [invalidate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a56ea1d83eb42dda4a7c06b6fbbf6ffd5) Function + * [directPrecedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aa8041fca418266f2bee129804654abab) Function + * [directDependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a862a4306dbf867e3db316d9547cea277) Function + * [precedentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a084d49d02b9ff5812166721fcdc86018) Function + * [dependentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1add9bd8c41cd4a5c77f7e762768b441a5) Function + * [precedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aea1973c58e45bafe3aeea797b91a4f6b) Function + * [dependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a7a3b136537fb09914b87b5997b937df0) Function + * [isInputToComponent](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a317b7b47fa55798e212c426b4ac8f014) Function + * [isInputToModel](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2d16dbc50ee0f77d5ca99b8a600e5023) Function + * [setMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a31e14e94dd9316f40bf963a9da9939f7) Function + * [getMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac6becc1bb1c5206e972c266164f838ca) Function + * [toStringEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1af2ff697565c81552d49c0237cfc89ef7) Function + * [fromStringEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2a286a07b606f7e90ac4e1d281a49d38) Function + * [toStringAbsoluteEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aac2b33985ad310362db7c8c878096ae8) Function + * [getLength](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad88eff947daa184ab953839666729ae5) Function + * [setLength](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2cfaecd2a821841d414f0d9ac505659f) Function + * [setDimensions](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a3526172d364bb842ab3bc25f1cedf31b) Function + * [getValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a32db352eed1650697f8b164546ea3eeb) Function + * [setValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a8ef388f09dd24fd704b46a7446016951) Function + * [createRefProp](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9e2914c70c8c77002c0dbc502cdfa056) Function + * [getRefPropValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aecab78945a16a827081638609b48318d) Function + * [setRefPropValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a93e2bd4cf0f592ca8ec2a626fbd57432) Function + * [getRefPropValueAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a76d1cee0ac71a9682e7ff9af6df9cf77) Function + * [getValueAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9233b22b8ad38b1abf30bc68d543d789) Function +* [ModelCenter::IReferenceVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable) Interface + * [hasChanged](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0f4d80365facbc0cfea5745f131e9d10) Property + * [hide](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a598cb6023fcbcb265cc44618529c3040) Property + * [OwningComponent](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a853702bf341480c261b01988dfd15513) Property + * [value](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a2e307144f16d81645b5ce2cc30b01ae3) Property + * [reference](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1abfacc6a5417c7fab810ac6e34a885657) Property + * [referencedVariables](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a21758071b908ac4fe720dffdafe75592) Property + * [referencedVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3ae2ecb1742ecac66cec298a6d2cd011) Property + * [isValid](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1adbc66e2276350867c0b977bf5cf192cf) Function + * [validate](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a16aec4b64f98c5dfb3f66c497691e447) Function + * [getName](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa01b77111d4a975cc12ca3e0a16d845b) Function + * [getFullName](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3e427b90dbf2f763c2486cdd774c2d49) Function + * [getType](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ab946d679180e3e65433c8b4b2d61d39e) Function + * [isInput](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa61fe715fadff86e98c35d4bf6aa16e0) Function + * [toString](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a6675d6a6451c20b11b43ad594af28bcc) Function + * [fromString](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa52a8fe2a76861302ee8ab0f8f3a614c) Function + * [toStringAbsolute](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a510fd4577f2a29cf0fef6d1c8fe43c94) Function + * [invalidate](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3a460ef81527173ce0c272d2bdf69da6) Function + * [directPrecedents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0e11aede2642dd050f0c5254a36b4a71) Function + * [directDependents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a24fa52bf29a92c4f1d6a79e2991e9ae5) Function + * [precedentLinks](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ac4f846dce2494b7c4a9b8482af321c96) Function + * [dependentLinks](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a4c704741da375408b052eeddc6ed90dc) Function + * [precedents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ae2d07bb6bf73c064a1a492bb6ff2806a) Function + * [dependents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aceffce4238d22a19c211658f675491ee) Function + * [isInputToComponent](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ac551ae6997c725cbb3ef71bd6217f89a) Function + * [isInputToModel](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ad8a6169868d4d186b658946403eae2ab) Function + * [setMetadata](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1afee8a9cb2ea3d6728cacba4aeaa9ff7a) Function + * [getMetadata](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a122afef9ff20a0de02d08ab41eb4e5bb) Function + * [createRefProp](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0063ff442e879a9ca2986bc63eb9adc7) Function + * [getRefPropValue](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ad90bbc18df836afc454157bd06523d75) Function + * [setRefPropValue](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1af41e2e8abdbc5959543416e21bc73793) Function + * [getRefPropValueAbsolute](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ae45fa34070d38d9de3593d815e86b1fc) Function +* [ModelCenter::IRefProp](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp) Interface + * [enumValues](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1a11d289581d9118de3f3a86d7d643fb85) Property + * [isInput](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1a0a8ec20895618292855526596a534f06) Property + * [title](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1ad9f9fdbe48e40c42f7d80eb57b072ae7) Property + * [description](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1ade4ceb94fec2ee5eab541cce187b1eb3) Property + * [getName](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1a2b2ac899757c8dbd31a9c38b6d08f2c2) Function + * [getType](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1aa05642b60b5a5e44e9954c130d4686e1) Function +* [PHXDATAHISTORYLib::ISaveContext](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext) Interface + * [saveFile](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ae85020cbcdca30d63c0dc803f19b7599) Function + * [restoreFile](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a90cd640253dfeb285c7c66803e61f6ac) Function + * [close](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a314e254f112778f1bb9839e157fcc532) Function + * [getSaveLocation](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a02bf3019e5a957a4db2daff6dda6ca28) Function + * [saveFileStream](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a840d41a9c874a046867c9d25c8a0d628) Function + * [restoreFileStream](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ad11ce33d8317c86c335597d0e8389578) Function + * [getFileFormat](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ab69f2a1eba739bfa1e95a1b5ba2cc8c8) Function + * [setFileFormat](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ad30b0ac3ddc36ac47b0f03662d3d4d0a) Function +* [ModelCenter::IScriptComponent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent) Interface + * [Variables](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a54219eed78fa8eed485e8da974458ea1) Property + * [Groups](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a6d041596bb6e0be6dd0710c6c9e0e8c9) Property + * [userData](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ade9f3ed3c58d1f3eb9914c3a395eb7a6) Property + * [AssociatedFiles](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a42162de74b1b046b277b927ace2dd403) Property + * [IndexInParent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a20f2c6a05beb38eb4d95a010cb48f94e) Property + * [ParentAssembly](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a48996a90eb72b62a9dff1119708c9d42) Property + * [language](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1af3d2bdfd6cd0c29ada055bee3686b2ff) Property + * [timeout](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a3a0d87f35ccd9845a8dc70e1ccf531eb) Property + * [forwardSchedule](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aedc1fa62c68c5512ccfe6913e018610c) Property + * [prevalidate](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a0f82cdd3e9fa556568265ef51c8bc0de) Property + * [getName](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a88c3162ff460faee36d43d3903c7a498) Function + * [getFullName](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a7e4a9eb5127e60bfbbd90640e35b32a7) Function + * [run](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1afcc83d74aabc7ddd66da4fccb708f0e9) Function + * [getSource](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a3dc2690409dd67fc5b3023e50d7abed0) Function + * [invokeMethod](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a03484bf5c7636d2015b3b11c3849ac30) Function + * [invalidate](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a70b40fcdb20ca2991b3db649f77eb55f) Function + * [reconnect](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a716d694026d6ef45a78ab51a8d1f6eae) Function + * [downloadValues](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ae380bd13a2c92b3392432f879e87baf2) Function + * [getVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ad88148c419a4c75c4c79b9d5e3c41eb6) Function + * [getPositionX](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aa032eb6b3c27a69052a8eb81053dfc34) Function + * [getPositionY](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a7b5ce3f6ce5bfd44702ff1fb874fb9fd) Function + * [rename](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a775db6663f994e82bb2529efe6585c8d) Function + * [getType](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a551d15c4f328f341d8cba0fe28bfd2b0) Function + * [show](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ad7d6f94d38270f36b80ed3c0109312dd) Function + * [setSourceFromString](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ab41aea5c06252f82fc831ea6af40e1b1) Function + * [setSourceFromFile](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aa34064721143d9012bfe5c0c899415a8) Function + * [addVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a04bbcea36b9bb694385e8620fa0a6b11) Function + * [removeVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a6b191d44fea8ec432315202d094acdb0) Function + * [setVariables](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a03a16eed6dbd98df2286d42f3a47db56) Function + * [getSourceScript](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1af377a582a930edbc7b4a56b57cd54375) Function +* [ModelCenter::IShowHelpEvents](interfaceModelCenter_1_1IShowHelpEvents.md#interfaceModelCenter_1_1IShowHelpEvents) Interface + * [ShowHelp](interfaceModelCenter_1_1IShowHelpEvents.md#interfaceModelCenter_1_1IShowHelpEvents_1a9e94376ebaa4b126ce37c5c541e8f5cb) Function +* [ModelCenter::IStringArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray) Interface + * [hasChanged](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a7d7a0e45d355883535175f060d150a25) Property + * [hide](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a39446dbc4a63268669450640360a10ca) Property + * [OwningComponent](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8c1ac6e84d73e34b12cc5e9397bb83a4) Property + * [size](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4164bff5f32408083a55fc9a327ebc66) Property + * [numDimensions](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1abaa61cb129a23c20be499a61ec4c8443) Property + * [description](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a9a336c7daf4b7f248103e2a3654139e6) Property + * [enumAliases](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a75eca0b30d1c439ddae44c33b03f9797) Property + * [enumValues](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ad3575ae96f975b212aaea0739a0c363d) Property + * [value](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ae449bcebd78b7ec3fe365cd8fbd3dac7) Property + * [value](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1afd9e0eaba3274e5802f25fe40f039c16) Property + * [isValid](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8b738f7eef3f9a3f8a723cede3809f47) Function + * [validate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a86b82bcfb1ccfa2428968307eaa07108) Function + * [getName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a0a90870618bd396edc53c27ff0b8c9af) Function + * [getFullName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4ca185e60b69ce2ff41d19a2270bc28b) Function + * [getType](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a582f9e8e47e60eca8041b98c996a4f4f) Function + * [isInput](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a3b7b397239f04cf9ea9358f9477ee2c4) Function + * [toString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1aa735025db3ac6e13cb486f8629b86a69) Function + * [fromString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a65a839b63dfb0495f577bf70ca87a320) Function + * [toStringAbsolute](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1adfb1dee0a1fd5b541eacba1e4cbba7ad) Function + * [invalidate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac6dd084c61d7ce2631d207242eca89bf) Function + * [directPrecedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a40c76b900187ef244f14c5c8e9bb65bf) Function + * [directDependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4820176e7ca9e1c3173d602308144c62) Function + * [precedentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a19c1ae9d08b968bae4b6fdd1ec74fc3e) Function + * [dependentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4227d6aca4e2d7791cea69efeb5b81fd) Function + * [precedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a913272799193e5d02033c63c746ead9e) Function + * [dependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a392d8e4080854c954c165833bb89a7db) Function + * [isInputToComponent](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ad59d273bea1a7e02540520e9b4428264) Function + * [isInputToModel](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1af1da4c99c6359d527ad57c9433333a36) Function + * [setMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a495551c5a05027a8537ffce75f333f8e) Function + * [getMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac730dc0fbfc8ae56788048e6c0fb80fa) Function + * [toStringEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a9013b29e3ca18c5a0ecaff8dc6d19b5f) Function + * [fromStringEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8fa6aff7c64224c1c488d5866dfc4865) Function + * [toStringAbsoluteEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a3684e3b0b2d36a599f75236a6f5e90e7) Function + * [getLength](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a39098992a1f29458010e4d18385d3681) Function + * [setLength](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ab20a6b27ddb532d0186532a52a148d91) Function + * [setDimensions](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1aa3a9cdee8b632a3adda4e2d1814c66f8) Function + * [getValue](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a7ba8cf139385e0630061f9ccfc8dc55e) Function + * [setValue](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a34205a2be0ffe6695721d957cd90f963) Function + * [getArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a499c8a85632b8c29f36a4832ae0a2ba6) Function + * [setArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1addf446b647e3f8946e8e72825241e0d3) Function + * [getValueAbsolute](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4e082d20ea2f1b47c95d26152595d05d) Function +* [ModelCenter::IStringVariable](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable) Interface + * [hasChanged](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a846973fd74773de77e95f5a686059b8a) Property + * [hide](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1acd58e2a3356b8297a5cc491f5a3ce9ac) Property + * [OwningComponent](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1aedaac8e1d883db0e5d9fa4f9ccd6403f) Property + * [value](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ab56992c6033247f7a5c262e63e728467) Property + * [valueAbsolute](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1abe143a72a2b1f663e41bf0af0118d5db) Property + * [description](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1af60bf6fec0621b386c755c9adc5cf4b5) Property + * [enumValues](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a26a049d4c093a364a5e03c577b6937b1) Property + * [enumAliases](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a55c58e3ba1d7b7b9985a32c8f9b88954) Property + * [isValid](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a16c6e45e1967f427b3a7123d7da384b1) Function + * [validate](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a7bddbd595f981680f8eb062d950f20d7) Function + * [getName](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a50cf9efbe23ed25a027f6df1d7132577) Function + * [getFullName](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ac8c712e2b8f8136f59cffd1665d6cb5e) Function + * [getType](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a9468a019a8bfaaa771c5bf97e206ea5a) Function + * [isInput](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a2268414421505ee4c0fb49de92953007) Function + * [toString](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a46f43be460cbd0d90493a6f9f26eb65d) Function + * [fromString](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a587cc7ce24785d0110b86ff815a68d89) Function + * [toStringAbsolute](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ae9ed673188c2c46e2c3883cdd65b3af5) Function + * [invalidate](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a7b29d24168420440191f35e6ad382d03) Function + * [directPrecedents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a98031c7081831a57f35dcfd18bef2279) Function + * [directDependents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6cd07e865097669f307d3d8ee9ace1c1) Function + * [precedentLinks](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6fcaecc0f0d1bdbd827e507ae1307fa4) Function + * [dependentLinks](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a019771c2e685c90ef2b4f53a0a3acf7c) Function + * [precedents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a4affcdc7391a9327db4c828e54c71703) Function + * [dependents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6ce38d07c0dc470d96eec4077c2c38b8) Function + * [isInputToComponent](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a940488ff3ad42baa064349a43fe9eac6) Function + * [isInputToModel](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a52f14ae0f304152748e0373e91701708) Function + * [setMetadata](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ac5062f1a9bcf780f891c6abeb0bcb391) Function + * [getMetadata](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1aa094d1b1e7b20a631c92c9ec9d936d71) Function + * [setInitialValue](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1af05313d1d5dce644dc1e0fb7217e18a0) Function +* [TradeStudyPlugIn::ITradeStudy3JobInfo](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo) Interface + * [numRuns](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1a27982338f106af2e2b89a29c66c2d8f1) Property + * [numVariables](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1ae684750b56d166406294cfc78bda83b3) Property + * [getVariableEquation](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1aed1386a6f6cef8c6c4ec1d94b3d07009) Function + * [getVariableDisplayName](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1a6e0f4277d79e93bd5d08fa7e548394a0) Function + * [isDesignVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1abbcbe48e293004c4cd609b574ecf94fa) Function + * [isInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1a02ddc66a224fd3c8fe04ec8ec60959e5) Function +* [TradeStudyPlugIn::ITradeStudy3JobManager](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager) Interface + * [dataHistory](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aec4a15702e1f9565f7564914cfef534a) Property + * [validateAll](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a913715f9bb137763d7b099cfe8bd9b57) Property + * [runInParallel](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a1e97168b7c275486400eaaf14e9a88d2) Property + * [numThreads](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a2b92bb066c911d4102902525a3feae5f) Property + * [numRuns](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1ac665a3e053e07b9bf007c5b798af743e) Property + * [numVariables](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aafb31c9ee4a9e013e3f7f77900217492) Property + * [supportsParallelExecution](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1afc7560080c238a34ac8d339d80175327) Property + * [canNewJob](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a0736cdac1a4c8573ec1332477849458b) Property + * [getVariableEquation](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1ae152b41da461434289f61a5f4c327fb6) Function + * [getVariableDisplayName](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a6fbac6e4218e6b82ed61d2f38f9b7af6) Function + * [isDesignVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aa53ea93d24fd4476de06e3226a5b2e69) Function + * [isInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a4f1199571453c7b851c484e88fb43a1a) Function + * [newJob](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a49263a87ff0aacb9e2231bbe0e726d1a) Function + * [clear](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aeb34f0cf410ef02f4eee10d611b4a740) Function + * [addVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a44f6cc3111c89abd357dfcfeed23cf4a) Function + * [setInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a44b3d2bd5e6037197449aaa92c6fd725) Function + * [setRunInputs](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a2d73e6a448ba816d2f4025d5f95b285e) Function + * [setVariableInputs](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a5f77ca1741019e90b1d348a7b4c20b04) Function + * [runJobAsync](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a7cdc64aa2ca295ed608347a61e79b8ac) Function + * [getMetaDataProvider](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a2f8bcf1cea9355a81d408919e479013f) Function +* [TradeStudyPlugIn::ITradeStudy3JobResult](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult) Interface + * [numRuns](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ae5299ad977b8ef2294350733bdff6912) Property + * [numVariables](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a3d8795dd3559fce3f610e63872b8808b) Property + * [dataHistory](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a5889d5d7712934aa30c0983452c875bb) Property + * [isRunning](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a56114078a1e476ce5e5ec70314f6fb73) Property + * [isCanceled](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a2248d0fcfa9dbf3b0de48e5b75ff4df5) Property + * [getVariableEquation](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ad63d367bc060e84ccd0edc96747bd082) Function + * [getVariableDisplayName](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a84850e887d89eb20d7793933316ad752) Function + * [isDesignVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ac933f79559b7a0cf45fe49a6cb1e77d0) Function + * [isInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a01b2afba0cae246a236a56555ffd3e05) Function + * [cancelAsync](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1aa5d136ea9f5d9dce819e2c6414f1febe) Function + * [waitForCompletion](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ad76c0b31771a31a827235d0306529ebc) Function +* [TradeStudyPlugIn::ITradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback) Interface + * [dataCollectorCreated](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1a21e1253a708b1e6177c5998ad7583c59) Function + * [runStarting](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1a05d371f3256cbd0515c1786d4ca42b46) Function + * [runEnded](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1af1ec5576a28a72b94eca35294a49dff1) Function + * [tradeStudyClosed](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1a9434138abbfd489946e6657ce904dcac) Function +* [ModelCenter::ITradeStudyEvents](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents) Interface + * [StartToolRun](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1a4bd376f4406023fdb8c562c3e530e32c) Function + * [EndToolRun](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1a2fd4f50429de83a6469ff4146c2202eb) Function + * [ToolClosed](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1aceebb769e27511c9b87462b8fa9ef16f) Function + * [ModelXMLExtensionsChanged](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1a09c0d68be95fb162874e4da3d0965749) Function +* [TradeStudyPlugIn::ITradeStudyPlugIn](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn) Interface + * [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a2b883bd3725cefb35daf8b629124a57f) Function + * [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a7238385b054e9afddbe65c65644826e4) Function + * [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a58cdb46e4e8dca27761d7bd976c8fcf2) Function + * [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a8c4352f776b3919a9a56aa61ff78c5d0) Function +* [TradeStudyPlugIn::ITradeStudyPlugIn2](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2) Interface + * [TradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ad9db0e1ec3dee4b67da4fd2bd197f497) Property + * [saveAllAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1afeb8dd96abface7ec4a37de262c88c85) Property + * [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ad233e5489d31c81b6b1fe09d9a3a886e) Function + * [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a81aebef74679c6364f184219c22da93a) Function + * [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1aaff0d58b0b3d2d90566fae1277ea4a45) Function + * [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a3dd50d2ce70b8e0534dd9be60e9bec5c) Function + * [onEnd](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a955659c71fd798c3d2be2d98a277e28d) Function + * [addAnalyzerVariable](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a614a39c2d8dd38f47d840aa6d5bb34f2) Function + * [clearAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ae184db6af8802c77918103c4bf0f0564) Function +* [TradeStudyPlugIn::ITradeStudyPlugIn3](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3) Interface + * [TradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a781692e887426951e2913672d9f94a78) Property + * [saveAllAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a98649448b98aa71aef4adc1e33c47570) Property + * [id](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a2c98e62414b0d01303d7a009449f0871) Property + * [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1ac84a2866cfcedd306eeabd757d8c0877) Property + * [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a3f6d767abcf9b50ee14ac7be20ef964a) Property + * [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a541ccb54affa550f0ea2694b39e16c7c) Property + * [onEnd](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1afa9a6faf24f730938ea94ba9e846a381) Property + * [addAnalyzerVariable](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a9e044579568a49b3f42c8771ccf8bbc3) Property + * [clearAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a1a94e6d8431bf19dee3fcf446e781070) Property +* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) Interface + * [hasChanged](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a70aa745d819120f3f13d8f5cac099e44) Property + * [hide](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a2b79ae605f5b5864f5470d730a845f7c) Property + * [OwningComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a2b61c0eea38b2b20a08b75041dc20f63) Property + * [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) Function + * [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) Function + * [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) Function + * [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) Function + * [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) Function + * [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) Function + * [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) Function + * [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) Function + * [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) Function + * [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) Function + * [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) Function + * [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) Function + * [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) Function + * [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) Function + * [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) Function + * [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) Function + * [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) Function + * [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) Function + * [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) Function + * [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) Function +* [ModelCenter::IVariableDescription](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription) Interface + * [name](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1a5430f2b928f3f8fc672dc2dcf8c6db03) Property + * [fullName](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1aa3c8267507d2f0d6cbbd35a33de0fca3) Property + * [state](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1ace7a19354a1c40a3f64464fb87b992ba) Property + * [units](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1abea210199b644bc3da685775950b9368) Property + * [isCustom](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1ae6ba3b64b599b6df11a39f0c3fa1b078) Property + * [equation](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1aa42abd87b11af98fcb67926472408801) Property + * [type](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1a8fc783420e2ab3163a2552436d694d0a) Property + * [isNumeric](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1ac7d823563278b1abbc458b61aa5eb686) Property +* [ModelCenter::IVariableLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink) Interface + * [LHS](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1ae3805787afceef57db6297e72632650a) Property + * [RHS](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a05eff77b1fab3100869de855008d8b02) Property + * [suspendLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a8a637411378f91597e5612e2e03c959d) Function + * [resumeLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a38ec9f0f44714dd151f7683721bd7ce8) Function + * [breakLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a0e2397280fb0a53c07ecee27bdff89bd) Function +* [ModelCenter::IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) Interface + * [Count](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks_1a65d1ab625bcdab41639028c42f712b26) Property + * [Item](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks_1af1e6de7d83b5af2ae699785b1d61fb1c) Function +* [TradeStudyPlugIn::IVariableMetaDataProvider](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider) Interface + * [getVariableMetaData](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider_1ab17303c17efd43f87d95991b2245bc72) Function + * [SAFEARRAY](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider_1aa2d00c56cf6df0f49ed49a864e281f45) Function +* [ModelCenter::IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) Interface + * [Count](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables_1a5805886fd173e6fc77a3387d5f1c6b95) Property + * [Item](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables_1a68b42951fd19cf993eef52d372dbdb84) Function +* [ModelCenter::IVizContainer](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer) Interface + * [Visible](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a4e7368bd0265ae9a637cfd675b5bd264) Property + * [HWnd](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a4971d80a859be3f620c329dbc5019d7d) Property + * [id](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a1022454788e8b96f6e84ad60e652bbe3) Property + * [hide](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a12129753b07898622d2e8a55801ef19d) Function + * [show](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1ae8ccfc592c21eb6adffad9502e4b28fb) Function + * [fileSaved](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a380f514b047b16f7cfb2fa4bacba4e6c) Function + * [showAt](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a69bf3249d5ef44ef0eee2152724f9457) Function +* [TradeStudyPlugIn::IWindowed](interfaceTradeStudyPlugIn_1_1IWindowed.md#interfaceTradeStudyPlugIn_1_1IWindowed) Interface + * [closeWindow](interfaceTradeStudyPlugIn_1_1IWindowed.md#interfaceTradeStudyPlugIn_1_1IWindowed_1af9dab02ffb5223028fae48563bbab27b) Function +* [PHXDATAEXPLORERLib::PHXDataExplorer](classPHXDATAEXPLORERLib_1_1PHXDataExplorer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorer) Class +* [PHXDATAHISTORYLib::PHXDataExplorerExportPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn) Interface + * [exportImage](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn_1a6e04dc894ad504d6c349d36ae7384e09) Function +* [PHXDATAHISTORYLib::PHXDataExplorerPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) Interface + * [getDataHistory](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a2add0041717f37ff0c72761de93af815) Function + * [setDataHistory](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a530e372d5d75f87574b4f5a7f8f25347) Function + * [getModelCenter](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ab914e1d1c1dd883a0a1b6201cde0577f) Function + * [setModelCenter](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a38e366a60626a29afa74869e40f156c6) Function + * [getPageTitle](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a38ed1207dbcb350057bc22b0450eb009) Function + * [toString](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a075c34c41b0461b36077d19c314fdc2a) Function + * [fromString](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a889e85b07599a03c7a262297629d0763) Function + * [getMenuItems](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ad899f49a6bef9cd0f56292b7c92d8503) Function + * [invokeMenuItem](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1afe6db966ff1b5790a8ae887d70294dc3) Function + * [isMenuItemEnabled](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a7259c195e2711d0fb54579e22752adb2) Function + * [updateHint](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a6394212eddc67589ac43fbd85826bbc2) Function + * [setStartContext](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ab7f82a38962d77ab437299dd6cbe50a1) Function + * [getThumbnail](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1af5f2203aace2cd54bac6c8789b1782c5) Function +* [PHXDATAEXPLORERLib::PHXDataExplorerPointer](classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer) Class +* [PHXDATAHISTORYLib::PHXDataHistory](classPHXDATAHISTORYLib_1_1PHXDataHistory.md#classPHXDATAHISTORYLib_1_1PHXDataHistory) Class +* [TradeStudyPlugIn::TradeStudyPlugIn](classTradeStudyPlugIn_1_1TradeStudyPlugIn.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn) Class +* [TradeStudyPlugIn::TradeStudyPlugIn2](classTradeStudyPlugIn_1_1TradeStudyPlugIn2.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn2) Class +* [ComponentPlugIn](namespaceComponentPlugIn.md#namespaceComponentPlugIn) Namespace + * [importlib](namespaceComponentPlugIn.md#ComponentPlugIn_8odl_1a1176e44e4d62af0ed162d7221dc5f53f) Function + * [importlib](namespaceComponentPlugIn.md#ComponentPlugIn_8odl_1a2cf599b993bafcd3fef5f5b7c34495e3) Function +* [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) Namespace + * [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) Enumeration type + * [METADATA\_TYPE\_STRING](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153ab0ea415d391c664f7c4c20e41e6a5b5b) Enumerator + * [METADATA\_TYPE\_DOUBLE](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153a1ef8fb522f41ea233866f7058fde8a23) Enumerator + * [METADATA\_TYPE\_LONG](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153a7f0cc46935e8f50a3ff7125e9ccac82a) Enumerator + * [METADATA\_TYPE\_BOOLEAN](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153a0cb9ab8e21174262b86c899965d618c5) Enumerator + * [METADATA\_TYPE\_XML](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153a934405f69eb259b948fdda69fda36cdd) Enumerator + * [METADATA\_TYPE\_FORCE\_TO\_32\_BITS](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153afd2104e48eb6bb48323751a8b15395c2) Enumerator + * [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) Enumeration type + * [METADATA\_ACCESS\_PRIVATE](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dca193d415dae56a753d64d37bcb67a2285) Enumerator + * [METADATA\_ACCESS\_READONLY](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dcae1023b575b4ff76a772e10c9162dd467) Enumerator + * [METADATA\_ACCESS\_PUBLIC](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dcaed115b108b3a38e88e5f5a3a1e17cf13) Enumerator + * [METADATA\_ACCESS\_FORCE\_TO\_32\_BITS](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dca637668ae8a3b4e7805346e7f1db302d5) Enumerator + * [TradeStudyFormat](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dca) Enumeration type + * [TS\_FORMAT\_PXTZ](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaac6d6ad08981541727efbbf8c181674cf) Enumerator + * [TS\_FORMAT\_PXT\_COMPRESSED](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaac387037adbfc62827fa1523fc69a1278) Enumerator + * [TS\_FORMAT\_PXT\_UNCOMPRESSED](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaaeead4e562c092545f613d220eb2df08e) Enumerator + * [TS\_FORMAT\_TSTUDY](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaa3332e2d8a655365e5c1fee1d8f1fa436) Enumerator + * [VersionStatus](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0) Enumeration type + * [DO\_VERSIONING](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0a1db01871f227cbb9c0ff450f45faeb85) Enumerator + * [DO\_NOT\_VERSION](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0ab728b53581051a989c0a4a20d5a0b7ac) Enumerator + * [DO\_VERSIONING\_IF\_POSSIBLE](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0a0f9c1842a82241069e6d7de3b1164023) Enumerator + * [AssemblyStyle](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625) Enumeration type + * [ASSEMBLY\_STYLE\_COLLAPSED](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625a6b01dbb284343f3c49f9ac2318be4aa3) Enumerator + * [ASSEMBLY\_STYLE\_EXPANDED](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625ae5a9a245bacc433385a01acb31722bf8) Enumerator + * [ASSEMBLY\_STYLE\_CLASSIC](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625a853070b6a8d1299e8d9e7f846a1f2e69) Enumerator + * [ASSEMBLY\_STYLE\_N\_SQUARED](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625af225405c171ad35d8e7caad44414d736) Enumerator + * [ASSEMBLY\_STYLE\_AUTO\_N\_SQUARED](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625a53d3ac52946f367fea3960b418f30626) Enumerator + * [ASSEMBLY\_STYLE\_FORCE\_32\_BITS](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625ae20fa83961bd74d6133ceec0849d4c1c) Enumerator + * [OnConnectionErrorMode](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2) Enumeration type + * [CONN\_ERR\_ERROR](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2a32466c6ffbbfd1d8cae3f96e7565e049) Enumerator + * [CONN\_ERR\_IGNORE](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2aa1a76a2bf1e5b53785d9e1c8389b9369) Enumerator + * [CONN\_ERR\_USEDIALOG](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2a4e520a601326fcb3e1324c9a950a541d) Enumerator + * [importlib](namespaceModelCenter.md#namespaceModelCenter_1ac27ed4a9b1a4fd02d9a3191c3ffbfbed) Function +* [PHXDATAEXPLORERLib](namespacePHXDATAEXPLORERLib.md#namespacePHXDATAEXPLORERLib) Namespace + * [importlib](namespacePHXDATAEXPLORERLib.md#namespacePHXDATAEXPLORERLib_1ad9ad6f6589cc63d798e289289f567b68) Function + * [importlib](namespacePHXDATAEXPLORERLib.md#namespacePHXDATAEXPLORERLib_1adfc3e518adcb9b631d6b3cd9f7dd728b) Function +* [PHXDATAHISTORYLib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib) Namespace + * [PHXMENU\_PREDEFS](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daa) Enumeration type + * [PHXMENU\_CUT](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaabf2c6817e4dffe7bc31ef64ab9ddcdb2) Enumerator + * [PHXMENU\_COPY](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaa4dd9a98729c118faa83f0c0ed3f29dbf) Enumerator + * [PHXMENU\_PASTE](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaafa9df5b66d50b8e6ec10faff0eadfa9c) Enumerator + * [PHXMENU\_DELETE](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaa5e8804d589a5617739cf74eb4bc3920b) Enumerator + * [PHXMENU\_PAGESETTINGS](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaabf2d504b4c5e2360d5902eb2eadfb45c) Enumerator + * [PHXMENU\_PRINT](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaa7e25b0e3c45465e3b3cdbad98b6d0f72) Enumerator + * [PHXMENU\_EXPORT](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaaed6d6e7b1fedd6b023274169374bc7d6) Enumerator + * [PHXMENU\_TOOLTIP](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaae48476ba1f1babc81be7b7db890b69c2) Enumerator + * [importlib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1aebeea567338ef111ceead76bc59bf072) Function + * [importlib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1a0e2d7a999f42bdf583341c632c923d8e) Function +* [PlugInMetaData](namespacePlugInMetaData.md#namespacePlugInMetaData) Namespace + * [importlib](namespacePlugInMetaData.md#PlugInMetaData_8odl_1a64427c7c968384bb40b716dd4f058fc7) Function + * [importlib](namespacePlugInMetaData.md#PlugInMetaData_8odl_1ac015988798e4dff85180232ea6f9f0c5) Function +* [TradeStudyPlugIn](namespaceTradeStudyPlugIn.md#namespaceTradeStudyPlugIn) Namespace + * [importlib](namespaceTradeStudyPlugIn.md#TradeStudyPlugIn_8odl_1ab9cd75f3f81835d0383377354faea30a) Function + * [importlib](namespaceTradeStudyPlugIn.md#TradeStudyPlugIn_8odl_1a6f9be822941ca29fb4380a23d65b3994) Function +* [PHXDataExplorer.odl](PHXDataExplorer_8odl.md#PHXDataExplorer_8odl) File +* [PHXDataHistory.odl](PHXDataHistory_8odl.md#PHXDataHistory_8odl) File +* [ComponentPlugIn.odl](ComponentPlugIn_8odl.md#ComponentPlugIn_8odl) File +* [PlugInMetaData.odl](PlugInMetaData_8odl.md#PlugInMetaData_8odl) File +* [TradeStudyPlugIn.odl](TradeStudyPlugIn_8odl.md#TradeStudyPlugIn_8odl) File +* [ModelCenter.odl](ModelCenter_8odl.md#ModelCenter_8odl) File +* [Deprecated List](deprecated.md#deprecated) Page +* [LIBS/DataExplorer](dir_4c5da7dd69977c70a414920e45f0e4dd.md#dir_4c5da7dd69977c70a414920e45f0e4dd) Directory +* [ModelCenter/src/InterfaceDLL\_ComponentPlugIn](dir_f4b71a0ee7c6b8122721a969fd158e55.md#dir_f4b71a0ee7c6b8122721a969fd158e55) Directory +* [ModelCenter/src/InterfaceDLL\_PlugInMetaData](dir_254da5db084e40f61f0f3ecf2de92ae0.md#dir_254da5db084e40f61f0f3ecf2de92ae0) Directory +* [ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn](dir_6384486296a61296aa9794364431ed6d.md#dir_6384486296a61296aa9794364431ed6d) Directory +* [LIBS](dir_3deb6222fdd4eb7b0f76591cf78ec6d0.md#dir_3deb6222fdd4eb7b0f76591cf78ec6d0) Directory +* [ModelCenter](dir_e61251abb0949c61ea8ea7dc5fba4af2.md#dir_e61251abb0949c61ea8ea7dc5fba4af2) Directory +* [LIBS/DataExplorer/PHXDataExplorer](dir_f8085194870fe60668985a445c75a643.md#dir_f8085194870fe60668985a445c75a643) Directory +* [LIBS/DataExplorer/PHXDataHistory](dir_b61c1eebc2b964146e7860adc8b8cd2e.md#dir_b61c1eebc2b964146e7860adc8b8cd2e) Directory * [ModelCenter/src](dir_cb6cf9700ae02fb10e39761559b5fdeb.md#dir_cb6cf9700ae02fb10e39761559b5fdeb) Directory \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/global_index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/global_index.md index 4c43284dc3..9986799861 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/global_index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/global_index.md @@ -1,1593 +1,1593 @@ -# Index - -## A - -* [add](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations_1a86769591b49fd0bf2ce90bfd45c24bdf) Function -* [addAnalyzerVariable](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a614a39c2d8dd38f47d840aa6d5bb34f2) Function -* [addAnalyzerVariable](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a9e044579568a49b3f42c8771ccf8bbc3) Property -* [addAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a1a55454ec16eadd67d23a8e134fccce7) Function -* [addAssembly2](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a1c73a3675ee4a70e9b31d2f63c86e630) Function -* [addCheckpoint](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9e6d72c9c2f589323e745f69426aaefb) Function -* [addCustom](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1acd3adc12cd4f94a2dbf436e8617cbf8a) Function -* [addIcon](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ada4b443f077f7c53744ada601a3c12be) Function -* [addInput](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a62816c713535ea573159c78f709aa04e) Function -* [addInput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ab95c6155dd1c2dbd24441bf3641a5542) Function -* [addInput2](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a915f8989fd54300d4ce830d37c2682bf) Function -* [addItem](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a4b0569ecb495f20688d98060df763895) Function -* [addMethod](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a1ef6ce942ff5def3c8faa1c4d6d52106) Function -* [addNewMacro](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a9d209b30adb83ac9fe48f8efd1959f3a) Function -* [addOutput](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a073c5f4a93c492f05fe361ca1799974e) Function -* [addOutput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a4591b4c0b98d14307aa691f42547c97e) Function -* [addOutput2](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a34633d249d8fd7b02a28c3158c6dbae6) Function -* [addPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af65679f9d81fa741896f22fb959f81d1) Function -* [addRerun](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a3e06470a8599a950a01c275f75c0d6cb) Function -* [addRunsToComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a7e608fa73c8645388956a6c1538438af) Function -* [addToComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2b46272c7cead32a5f75319eecddbc87) Function -* [addToModel](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a58f5f3bc676a7c683ea4fc9b531d608f) Function -* [addToModel2](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ab0bc1abd000532d2d89d6179868431fc) Function -* [addToModel3](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac2d1861e463ef89757948bb091502dbb) Function -* [addUnlinkedItem](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a8b2b470a890a2177bc1028408c7275e6) Function -* [addVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9a819127adb7f83be0acfa4e79f4643d) Function -* [addVariable](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1af05ab7c452794c56cc54d77113cefdea) Function -* [addVariable](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint_1a3c20c3bc3fa7ae5fb36154448d3ae13d) Function -* [addVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a04bbcea36b9bb694385e8620fa0a6b11) Function -* [addVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a44f6cc3111c89abd357dfcfeed23cf4a) Function -* [addVariableAt](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a156c9828bc7c8251e68886297349ccab) Function -* [addVariableStructs](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9bf37e7831e0c32cfe17225f019c9cc4) Function -* [appFullPath](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a999bedcb3195dc2a12b034e0fa0222ec) Property -* [appName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a1a5d90dca23414ddb8ef45e99c091ea4) Property -* [Assemblies](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a00afe3dedbc3bb8b8a1cbdf5bd6333a1) Property -* [ASSEMBLY\_STYLE\_AUTO\_N\_SQUARED](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625a53d3ac52946f367fea3960b418f30626) Enumerator -* [ASSEMBLY\_STYLE\_CLASSIC](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625a853070b6a8d1299e8d9e7f846a1f2e69) Enumerator -* [ASSEMBLY\_STYLE\_COLLAPSED](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625a6b01dbb284343f3c49f9ac2318be4aa3) Enumerator -* [ASSEMBLY\_STYLE\_EXPANDED](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625ae5a9a245bacc433385a01acb31722bf8) Enumerator -* [ASSEMBLY\_STYLE\_FORCE\_32\_BITS](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625ae20fa83961bd74d6133ceec0849d4c1c) Enumerator -* [ASSEMBLY\_STYLE\_N\_SQUARED](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625af225405c171ad35d8e7caad44414d736) Enumerator -* [AssemblyStyle](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625) Enumeration type -* [AssemblyType](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a12692b24f7c9fceec97847b204afecc4) Property -* [AssociatedFiles](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aecece7b57424f027ba567415051d3bb5) Property -* [AssociatedFiles](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1afeeaebcaeafab038e2cc613078182c6e) Property -* [AssociatedFiles](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a42162de74b1b046b277b927ace2dd403) Property -* [associatedModelFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a145b2ba8b5de9c0bac5b0ac89ad7f960) Property -* [associatedModelFileUUID](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad91c318a844622c7673df74c0f92128b) Property -* [author](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a8acab1f7a5d2caa0ab47d0d74247497e) Property -* [autoGrow](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a74f194b29d46aacb12b7d4c445df729b) Property -* [autoLink](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1adea9c027f61fb0c23ce34a0e47924679) Function -* [autoRun](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1aa714911e950223667ee525a435b00b7a) Property -* [autoSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aca63a47369d69cbbf53532286b64a611) Property - -## B - -* [baseName](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a0f840f7244ed0a52fa4d7c2a19a08264) Property -* [breakLink](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a231cd11fa3198cc4a22db3ee0483b59c) Function -* [breakLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a0e2397280fb0a53c07ecee27bdff89bd) Function - -## C - -* [callMethod](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ab1c0d770f00a0c466eacecda838b3850) Function -* [cancelAsync](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1aa5d136ea9f5d9dce819e2c6414f1febe) Function -* [canNewJob](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a0736cdac1a4c8573ec1332477849458b) Property -* [canRerunRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a080673db51fe153fd870e46b9dd4f221) Function -* [canSaveToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a3123522cb86b3daa95c56f60b99a4f9e) Function -* [centerLinkJobConnector](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1af8f87624e919e067935bb5403261b63f) Property -* [centerLinkQueue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aac2a1a4d2bc65319ac7e94f0f20368b1) Property -* [centerLinkRunMatrixID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a61514463a5c0f82163d4789cd9e60f8a) Property -* [centerLinkServer](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a226709acf22397c41215acd7f0ab0605) Property -* [checkin](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature_1a8cb220ceb67de96c199d761396bff884) Function -* [checkinOnFlush](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1af839cced75ed11439b0027a55c6ab604) Function -* [checkout](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5ea6a58aa4def0e7d48f5c48dfc46d35) Function -* [checkout2](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3b8e21abd2354b4fd537084f36c9a180) Function -* [clear](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aeb34f0cf410ef02f4eee10d611b4a740) Function -* [clearAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ae184db6af8802c77918103c4bf0f0564) Function -* [clearAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a1a94e6d8431bf19dee3fcf446e781070) Property -* [clearBusyFlag](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1aa73cb2b559ec21ef817b241e7f943e8a) Function -* [clearCache](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a06a3f847d50eb2f10e3b061ea91b453b) Function -* [clearLowerBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab93c1d5caa0fb18eb4d41499f5c708b7) Function -* [clearLowerBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a72ee20ae45907f6f6738dbba0ea63655) Function -* [clearLowerBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ab51bcc939e91ef1da288c78be99a7fcc) Function -* [clearLowerBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a16f466aa207ea88961361ee69a683850) Function -* [clearUpperBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa1657e3679484a86e997a20256eef5b1) Function -* [clearUpperBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1aa8846eb2c93d138bf7b6c31d78f0dc56) Function -* [clearUpperBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1aa3f1505493e089a8717c092e37927600) Function -* [clearUpperBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aba1030008767dd31ae13f40f90ba58d8) Function -* [close](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a314e254f112778f1bb9839e157fcc532) Function -* [closeDataHistory](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a9ead478fc2486a3ac01b73ee8b3962be) Function -* [closeHTMLViewer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a46b4e01256fa252da2f589af87833ac1) Function -* [closeModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a00bcefae609c5a453dd1f4e0586820fc) Function -* [closeWindow](interfaceTradeStudyPlugIn_1_1IWindowed.md#interfaceTradeStudyPlugIn_1_1IWindowed_1af9dab02ffb5223028fae48563bbab27b) Function -* [ComponentPlugIn](namespaceComponentPlugIn.md#namespaceComponentPlugIn) Namespace -* [ComponentPlugIn::IComponentPlugIn](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn) Interface -* [ComponentPlugIn.odl](ComponentPlugIn_8odl.md#ComponentPlugIn_8odl) File -* [Components](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ad4c0ef9792a2f760b3639357126e56f6) Property -* [configureLogging](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acb8cad870e072bee4a80b1902476929a) Function -* [CONN\_ERR\_ERROR](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2a32466c6ffbbfd1d8cae3f96e7565e049) Enumerator -* [CONN\_ERR\_IGNORE](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2aa1a76a2bf1e5b53785d9e1c8389b9369) Enumerator -* [CONN\_ERR\_USEDIALOG](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2a4e520a601326fcb3e1324c9a950a541d) Enumerator -* [construct](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1ace85f5a1c843051fe7513c591c373164) Function -* [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a2b883bd3725cefb35daf8b629124a57f) Function -* [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ad233e5489d31c81b6b1fe09d9a3a886e) Function -* [convertToSubmodel](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1afc8d8acd50c53726272ce0c983aa640f) Function -* [copyFrom](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ae9e54933d6dd82e4d4aa5991b58b6ee3) Function -* [count](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1a53be79855251a6bd40bd71f35c4f6d8d) Property -* [Count](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies_1aee7be5ec0b95eaea973eb669981b4804) Property -* [Count](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents_1a657951d45a2e5d44a882ecc04e4abbae) Property -* [Count](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups_1a3bbbf56f26f76f5f051ea065aaf00234) Property -* [Count](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks_1a65d1ab625bcdab41639028c42f712b26) Property -* [Count](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables_1a5805886fd173e6fc77a3387d5f1c6b95) Property -* [createAndInitComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a049e13b6d3ba54dd40a162a16d03bb66) Function -* [createAssembly](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a402db0953a58ac7573cf3585c938eafa) Function -* [createAssemblyVariable](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a72e28e9146e37b0854aaa3274b60362c) Function -* [createComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa1c2ba41e8aeff2bc97408fd6d5e8832) Function -* [createDataCollector](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad91dff33c09345053346ce2d831fd968) Function -* [createDataExplorer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3edba311337bb171b956e0d331cfa05f) Function -* [createDataHistoryVariable](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5f2d90be1a4bed0126993b3021d24981) Function -* [createDataMonitor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad86e8cd5714f0d22dc84b1b71979fdc5) Function -* [createDesignVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1adb61a037918e5f45dfc6a43541023970) Function -* [createEmptyRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1ab152e50d67d452b3f301ea18f732183d) Function -* [createJobManager](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5878e18adeeafe78c1920e5544253442) Function -* [createLink](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac46503f8f560edbcddd87fb9c9045326) Function -* [createPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1afb0f2d3715e4a48c1ee1c865864c5314) Function -* [createPlugInFrame2](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acd338a67839da36df138a0521ee3aead) Function -* [createRefProp](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9e2914c70c8c77002c0dbc502cdfa056) Function -* [createRefProp](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0063ff442e879a9ca2986bc63eb9adc7) Function -* [createTradeStudy](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab18e9a5fa259695357cd26f155ee95dd) Function -* [createVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a68acd508b225f5c74c27daf848f3ae27) Function -* [creationDate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a4e0ab1e84c6e9f6ddd62ec774c75f42c) Property -* [customMetadata](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a5e4dfb223db7287d798efb5b8078a3e2) Variable - -## D - -* [dataChanged](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1aa6f5dbeba5082e060cb68696cd07d44f) Function -* [dataCollectorCreated](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1a21e1253a708b1e6177c5998ad7583c59) Function -* [dataHistory](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aec4a15702e1f9565f7564914cfef534a) Property -* [dataHistory](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a5889d5d7712934aa30c0983452c875bb) Property -* [dataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a4c0b3167dd18062593fb1a221bce40af) Property -* [debug](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a1ff316d9091c838bcbdeaf5706e8216e) Function -* [deleteAllMembers](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a763852aed64e16a58160d166c8addd23) Function -* [deleteMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a30200ac90fd4115c2eb6c5641a77eddb) Function -* [deleteRun](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a0be98d87ed201827314037c9100e8fce) Function -* [deleteVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1af26d20927c5ef5ccd3304b1c3ba220c4) Function -* [deleteVariable](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a92a8b6a732ebcd29f6fb33a448f9f4c9) Function -* [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) Function -* [dependentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1abadb81820fd0b415fa9e78ce6c867c55) Function -* [dependentLinks](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a69e716f024970454d8c555c73df17360) Function -* [dependentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a0201276e7d000c4869e4798cfdb68d8b) Function -* [dependentLinks](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a385019a97e3ddbae4351fd6dd591a49c) Function -* [dependentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a90373b06919789f06f52dd22a0339847) Function -* [dependentLinks](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a46a1da5e2a3f39c2e413b520ec33407f) Function -* [dependentLinks](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a50e3d7ea1d97cd799c29901c2b563208) Function -* [dependentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a399b9b49ca3133d2a49923637f19609a) Function -* [dependentLinks](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a1328684b4767a3ee6b006feca4f0296d) Function -* [dependentLinks](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af52780ea6b4984f40b16c8c072e1b005) Function -* [dependentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1add9bd8c41cd4a5c77f7e762768b441a5) Function -* [dependentLinks](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a4c704741da375408b052eeddc6ed90dc) Function -* [dependentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4227d6aca4e2d7791cea69efeb5b81fd) Function -* [dependentLinks](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a019771c2e685c90ef2b4f53a0a3acf7c) Function -* [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) Function -* [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) Function -* [dependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a386477ffe54e2d0f351f9dc7fbb49712) Function -* [dependents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1afa6ea6f99c9eeb606ebe08b1e7d9c54d) Function -* [dependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a6e0601946499c985be03e00354c8acb3) Function -* [dependents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a04becbe1d34e232e21208333c0700e3c) Function -* [dependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1af16a20eacc6734b343762565ec8b20d6) Function -* [dependents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac63897b5927f1ad28965384718c0de6b) Function -* [dependents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ab110babf06372919f705e71b64cc733f) Function -* [dependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af6712999aa6e50091a95dd66db088661) Function -* [dependents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aa8739ff163a52ceed99e867e5126330f) Function -* [dependents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ae106e94dca5f19c46ed9f82c67772660) Function -* [dependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a7a3b136537fb09914b87b5997b937df0) Function -* [dependents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aceffce4238d22a19c211658f675491ee) Function -* [dependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a392d8e4080854c954c165833bb89a7db) Function -* [dependents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6ce38d07c0dc470d96eec4077c2c38b8) Function -* [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) Function -* [Deprecated List](deprecated.md#deprecated) Page -* [description](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a29b8b160371c7db191f6e3dd0e1fc414) Property -* [description](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ae3788aac4468e5c4d62e002663e8e729) Property -* [description](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a8035fb2b8276762f7b0b2b3e8b7d8cf5) Property -* [description](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a59b6ea0f39cadd0ec7b20b16c8d630ea) Property -* [description](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a491df2e849d05621978fe706bb48de85) Property -* [description](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a8be2e0c977d8808648829d523c841d36) Property -* [description](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac0f28c2d059dc02d18d3dd8eaba19f31) Property -* [description](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ad6ac49ae6d10a8aef6927eaad49e55f1) Property -* [description](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a9933e6b9d3328cf70f35075b8556e8ab) Property -* [description](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a746f793efe758a7e3f36ba188d07ccee) Property -* [description](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a73b60bd367cc0e6783f9e5ad0bf96811) Property -* [description](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a0b98819f11c5c2e7c916a4e629199d48) Property -* [description](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1ade4ceb94fec2ee5eab541cce187b1eb3) Property -* [description](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a9a336c7daf4b7f248103e2a3654139e6) Property -* [description](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1af60bf6fec0621b386c755c9adc5cf4b5) Property -* [destroyPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a24cc8bd489975150c9d5c5c3e9502b87) Function -* [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) Function -* [directDependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a6ed20fe44044c682471c7066ae2bd303) Function -* [directDependents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a40dedf6b7b841a6699d545ea058ad2cd) Function -* [directDependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe14e74990edda2c656035bbcd8e2af2) Function -* [directDependents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a6178082dc3de5e1f6665f4faebcb8c36) Function -* [directDependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab61572acbd0617f5c51b04b2ae4bbdba) Function -* [directDependents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a9347c073e1dc6ca62f1b3c7cd6fbec71) Function -* [directDependents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a06be08cd5896250dc5b31ec3d90b79e6) Function -* [directDependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a44b3a3cc73cd46ea7661e776b20b4ded) Function -* [directDependents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ad783a3a7e231dd0aa00b869699a5bca4) Function -* [directDependents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af1b4238d92307aa3586b4f7070e497be) Function -* [directDependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a862a4306dbf867e3db316d9547cea277) Function -* [directDependents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a24fa52bf29a92c4f1d6a79e2991e9ae5) Function -* [directDependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4820176e7ca9e1c3173d602308144c62) Function -* [directDependents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6cd07e865097669f307d3d8ee9ace1c1) Function -* [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) Function -* [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) Function -* [directPrecedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a605c25813e75d1709e364eef080f68e9) Function -* [directPrecedents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ae54cdcd132e22278b8ddb00aaff236c7) Function -* [directPrecedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3ab4fe76950c76fbdd2e76ea3f4fb08b) Function -* [directPrecedents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a7a14b5ef10935109b178062205b91b7a) Function -* [directPrecedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9f84f73f3b65f16fa507678c53c67527) Function -* [directPrecedents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aea8561351c3ff1e003d463616682a838) Function -* [directPrecedents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a8294d8120195193f3a5fba86abcded57) Function -* [directPrecedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae3879cd50b0512f2b5660765393bd24e) Function -* [directPrecedents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a5c99fbda3111d689db126a61e0727106) Function -* [directPrecedents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aac5eb818fb62f131d6ecb13fd3f6aa34) Function -* [directPrecedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aa8041fca418266f2bee129804654abab) Function -* [directPrecedents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0e11aede2642dd050f0c5254a36b4a71) Function -* [directPrecedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a40c76b900187ef244f14c5c8e9bb65bf) Function -* [directPrecedents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a98031c7081831a57f35dcfd18bef2279) Function -* [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) Function -* [directTransfer](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a248392894f6cd7f2662f29c3f110d7af) Property -* [displayAboutBox](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa9057344d6d2ffc28569709efdbdb5ad) Function -* [displayName](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a5f8b196a046e313bc7d50d6ac80ec29d) Property -* [displayPreferencesDialog](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae8f7829bf075209faf0fcecf742e76be) Function -* [DO\_NOT\_VERSION](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0ab728b53581051a989c0a4a20d5a0b7ac) Enumerator -* [DO\_VERSIONING](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0a1db01871f227cbb9c0ff450f45faeb85) Enumerator -* [DO\_VERSIONING\_IF\_POSSIBLE](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0a0f9c1842a82241069e6d7de3b1164023) Enumerator -* [doubleToEditableString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a596665cb30835ccad7c6df17afffd8bd) Function -* [doubleToString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1afdb6c65e615c3d5176129b51a1d44318) Function -* [downloadValues](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a761c665246557b5b4201873a722d6fed) Function -* [downloadValues](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a610d24ca2e023e09194b29c3115c6d84) Function -* [downloadValues](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ae380bd13a2c92b3392432f879e87baf2) Function -* [dumpComDebug](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a27b453e8058a238c25049c8fcb5121e4) Function - -## E - -* [enableCache](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1af28b9a4ab0944f31f2d157ab6826999c) Function -* [enableCarpetPlotTab](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a1e13b83ec71a3274399832bfe3471364) Function -* [enableGraphTab](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa2efe037d15784acff1d3291c482f276) Function -* [enableMainEffectsTab](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a11a172f0d359597318448e52fd991843) Function -* [endRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a0576632449bf05bc8b0274fb341a3332) Function -* [endRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1af2b0ccb145e2775fc9958d3500cfb4bc) Function -* [EndToolRun](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1a2fd4f50429de83a6469ff4146c2202eb) Function -* [ensureRunDataAction](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab5a2bb675d76aca81691538b7ef55ef9) Function -* [enumAliases](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1ab0241db307b35f1e5d19adbd2d1f17df) Variable -* [enumAliases](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1af3b9b49e293ed90e0e36ac8cd64a1d5d) Property -* [enumAliases](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a9e195b698057e2d38fbb9c101ebeb827) Property -* [enumAliases](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a531c146537c198a1c71e5c5826757b01) Property -* [enumAliases](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ade7b31cc762cc412e399fff92260fb99) Property -* [enumAliases](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac706776dfc20b9410c859471f981f43e) Property -* [enumAliases](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a75eca0b30d1c439ddae44c33b03f9797) Property -* [enumAliases](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a55c58e3ba1d7b7b9985a32c8f9b88954) Property -* [enumValues](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a3388bf5cf3b1f7de69b343b81669e6ff) Variable -* [enumValues](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ac0461a8fca66f784a7f1a66b77c952e7) Property -* [enumValues](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1af625775f6fdd957bb0b37ed1c86a3051) Property -* [enumValues](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a0c6cd245f4c6bacc15398f88522a2992) Property -* [enumValues](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5d823185c095e0c48f696a8ec27a78cb) Property -* [enumValues](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1af9ee5a112578385dcae1893f96f0143b) Property -* [enumValues](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a2b488ae83e3f61e8f0924b781b0fac1a) Property -* [enumValues](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1a11d289581d9118de3f3a86d7d643fb85) Property -* [enumValues](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ad3575ae96f975b212aaea0739a0c363d) Property -* [enumValues](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a26a049d4c093a364a5e03c577b6937b1) Property -* [equation](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a32fdc64aa5113896a4a962a5c3cbaf93) Variable -* [equation](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a3901f5a0e0dba161b1746d3869d83807) Property -* [equation](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1aa42abd87b11af98fcb67926472408801) Property -* [error](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a576c679c95d7e5c38917bcc0bab46296) Function -* [exclusive](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae32fcb5e2bd27ce4317da67ea515d40f) Property -* [exists](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a5f79e2722103398d5f02e9fbb3c08c8b) Property -* [exists](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations_1a6e6cf7b365025116e67b9ddd575b10b1) Function -* [exit](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aba655ef2cf9a8f639acde2697d8319a2) Function -* [exportImage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2dc01f47f79342cc3893c66a8be1fb12) Function -* [exportImage](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn_1a6e04dc894ad504d6c349d36ae7384e09) Function -* [exportToCSV](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a75c4f95d0b30e6edb92f98e378f7c4be) Function - -## F - -* [fileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ac8e13d4f87d1c0b784c5ebafd030fa57) Property -* [fileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a12eb5e82033d54430ee309a0ca2ad254) Property -* [fileExtension](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ad161b90c198e19be1132a9e5592e9416) Property -* [fileName](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1aa624273f5c3fb5af9baa0272caa971e0) Variable -* [fileName](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a441ac734f55bcc3351b2e475524bd890) Property -* [fileSaved](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a380f514b047b16f7cfb2fa4bacba4e6c) Function -* [format](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a5d2b591cdaa6ce26e344f11ab6e1b76f) Variable -* [format](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1aee5d1b31138b410b58410abbc82cf441) Property -* [format](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad0078a54f0aa1ede8e3d6d78a00a4f7c) Property -* [format](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a6181c6c0985068e31fdb725d719ddb35) Property -* [format](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ad328109c650cbcc2ca8cf08b688de6af) Property -* [format](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac28287849865c6233468b6e1a9034248) Property -* [forwardSchedule](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aedc1fa62c68c5512ccfe6913e018610c) Property -* [fromCenterLink](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab68593eb479ef9f2684e7e8e683ed0bd) Function -* [fromCenterLink](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3ff1b9e535edf561dfa7f575814f1792) Function -* [fromFile](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a83b3e976d1267ab9bb6e59be7bd741d1) Function -* [fromFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a9ca208f1854ac22bb31e38119e2e2af5) Function -* [fromFile](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a5e4a925c2918b6ac9da355b2287e3d04) Function -* [fromFormattedString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac054c3628e2d617a1972dc195cacec60) Function -* [fromFormattedString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a647cc6b6832eefd008c51457a34c9ff5) Function -* [fromFormattedStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a21c8a18bd7cb6544d526fbe1c27e72ea) Function -* [fromFormattedStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a9a6ac88dcfe81e7651c7cc5d15e4bf59) Function -* [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) Function -* [fromString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1af5d6c192774673f4f4bf7514b35f8ccf) Function -* [fromString](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a8b9fd88143b7b23e5f3ae9e229774a2b) Function -* [fromString](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1a3e35deaee9587905584aa8926b2076de) Function -* [fromString](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a42e57bafd047e98fff2902f213c48f61) Function -* [fromString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3faefed33c99ee3ffb10b5e0e21d239a) Function -* [fromString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1128d6c344adde4e9f9d95b0c19f87b9) Function -* [fromString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab107312b8a5b1e8e96ae2a3678ef9897) Function -* [fromString](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac7654e743af45785904858d2c581058d) Function -* [fromString](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a710bd007c2d1df9c861a33a397c7a9d7) Function -* [fromString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af3d5cd8601c1227d439b7b3f74cc2d16) Function -* [fromString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a180292624fd43a95348bd496b0fee8a6) Function -* [fromString](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aca195574fffbfac6577eb4b0d54f3dd8) Function -* [fromString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9cb9dab871b4e86ed66fb53cc5473ebd) Function -* [fromString](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa52a8fe2a76861302ee8ab0f8f3a614c) Function -* [fromString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a65a839b63dfb0495f577bf70ca87a320) Function -* [fromString](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a587cc7ce24785d0110b86ff815a68d89) Function -* [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a8c4352f776b3919a9a56aa61ff78c5d0) Function -* [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a3dd50d2ce70b8e0534dd9be60e9bec5c) Function -* [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a541ccb54affa550f0ea2694b39e16c7c) Property -* [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) Function -* [fromString](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a889e85b07599a03c7a262297629d0763) Function -* [fromStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad23f4082662c464be07251d6d1695a2d) Function -* [fromStringEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a8d7b18dca2bbe96aa0ee3718e433e272) Function -* [fromStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad068bdf2a8fb66fea7cfb3a3111fb176) Function -* [fromStringEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aa104ba67a0164c27a33017aabd29d83d) Function -* [fromStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a26f9cfd27774a2233ae2cb232cc8fec9) Function -* [fromStringEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2a286a07b606f7e90ac4e1d281a49d38) Function -* [fromStringEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8fa6aff7c64224c1c488d5866dfc4865) Function -* [fromXML](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aef1e4bfd5cd8b8e28d6e26b06483629f) Function -* [fromXML](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a1649ee497672683a575cc6cd6b78c9a6) Function -* [fromXML](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a4697fd5d09c8ade51e7a905a4202e5e9) Function -* [fromXMLFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a4ea300c891cc45556fdd4b1e7988274d) Function -* [fromXMLFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3b65f441a218c193aae8863e6354cc2d) Function -* [fromXMLSaveContext](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a237c798449d1bd63e69905b53fe17d06) Function -* [fromXMLSaveContext](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ad00d42b514b490170b0d28930b4bd32b) Function -* [fullName](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1aa3c8267507d2f0d6cbbd35a33de0fca3) Property - -## G - -* [geomScript](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a8f89e59faab48afc96e4a0dde2f457c3) Variable -* [geomScript](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a1fa79813f4fadc3f9f668aa5d433c431) Property -* [getActiveJobManager](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a931fee19976a7a03e263284ec0ee9d53) Function -* [getArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ac522da7a239f7d74e52a445351e5996a) Function -* [getArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afbdd49bff040a71b2be64a93e6705b21) Function -* [getArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5e233233ced66879ff8aa58832981a7d) Function -* [getArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a499c8a85632b8c29f36a4832ae0a2ba6) Function -* [getArrayMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a5dc9de363afe0659af36716807543b05) Function -* [getArrayMemberAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a24b1cc73d5868b9e8a3014209689d088) Function -* [getArrayMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a13f1700a491d9f13070a854092887b20) Function -* [getArrayMemberValueAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7b6b51c7f0eb9a262d1ba0a2bf831368) Function -* [getAssembly](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a461a8c0e8efdd3353da6feb22b232029) Function -* [getAssemblyStyle](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab1d7ce6494121cd997115f91e91d795a) Function -* [getAuthor](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a302223e3912f3e34a512a5ef323e0939) Function -* [getAutoDelete](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a163f13ac67226dfe0d816950061cc386) Function -* [getBranchCondition](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a0a01eb7fd3513f7754534c229ef4da08) Function -* [getBranchName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1acd033bea89f3ba1ec760d9ad2c47d0ed) Function -* [getCheckpointRunNumber](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a71781fe2343b7ef49d1fb80ed91d295a) Function -* [getCheckpointValue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae28168a3a789a8d8c2413e6c58c635d0) Function -* [getClassURL](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7cd400b4cd38cacd370b5c2b6246375c) Function -* [getColWidth](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1aa7c5595c9eabf857b3adc02d30dcbb8e) Function -* [getCompletedRunData](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a76a5d19e76fdfe69e61d6910917acb32) Function -* [getCompletedRunIndices](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a434f332ecfce0734f8f940da4b722cc6) Function -* [getComponent](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ae5ee8b89f3b20182eb2ab707460fe751) Function -* [getComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a779902b1a3f3c4c0db2b58484ec75fe0) Function -* [getDatabaseFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aaecbc010eb87c6a2fbe894a646d83a4e) Function -* [getDataCollector](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a29b8af2a820e24e728425e6467881067) Function -* [getDataCollectorForDataExplorer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a59b46ca7b15c869fb190ecfeb70bf90a) Function -* [getDataExplorer](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa0b0a16e2c3c1f600a8435d6dca0c096) Function -* [getDataExplorer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae1bdc8f0abc612490b737852f189027a) Function -* [getDataExplorer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer_1aa6b13b15afbe694654cbba4b3fa1157e) Function -* [getDataHistory](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a2add0041717f37ff0c72761de93af815) Function -* [getDataMonitor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a6212fa2f41e2132f8f40d78164059eb7) Function -* [getDataViewHWND](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1a00bc608cb2e87ea6a12c4da4497c4768) Function -* [getDaXFormat](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2559ee7d7f32bbcebd0d18bb145bd012) Function -* [getDaXType](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af8150d8d7d5f6fc37eb3bdf0a27fc817) Function -* [getDescription](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1aea971d69e4505696518f69057dde4863) Function -* [getDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a83abe70ccf5e8a0a582748d84e3d7956) Function -* [getDisplayFullNames](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a0cd9a14f007afaa719e20b54439ea98d) Function -* [getDisplayUnits](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ac11b644fdbd9f5e184a120a3bb6c7eb0) Function -* [getEnumAlias](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5c03822c2d28cde3b9d0fdf4f335a594) Function -* [getEnumValue](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ad6bfcac769bd40c96db19848232fad3f) Function -* [getErrorID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a90e9fc9cfb0d469c4169504e6f2c9cd4) Function -* [getErrorID](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a5fac36a5e20d349ab8941387af60a576) Function -* [getErrorMessage](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a876302a3d26eda812e93bdd8b15bb26d) Function -* [getErrorMessage](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1ac93c96f43f475bc237f396b717bc5408) Function -* [getFailedRunIndexes](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a2acdef5238b168dae7f3294ba1629c77) Function -* [getFileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1abea033ef41f0f2ad087b24387772e09b) Function -* [getFileExtension](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a610338503721a3cd0992fa5af793b718) Function -* [getFileFormat](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ab69f2a1eba739bfa1e95a1b5ba2cc8c8) Function -* [getFileName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a8f71ab194f3468c084aea4beca2c43b9) Function -* [getFileSystemInfo](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a6d6d38245d99b3f53fda689a1adee17f) Function -* [getFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a6c3566f301404af75e38676198a8bf1e) Function -* [getFormattedValue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a45bea3dd1938199a0846f46c3d024503) Function -* [getFormatter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a1533da4a5c2e70aa5b196215af7637bc) Function -* [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) Function -* [getFullName](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1aa62ac6d1100f85d3f212185812a9e517) Function -* [getFullName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a498741fde4d9eeec6eb3f8171e3161d8) Function -* [getFullName](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a19c8cfbcba0c9fc8eaae14bfaaa07d39) Function -* [getFullName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9309a89032b2d7d28baf279a3b76b5e8) Function -* [getFullName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a225331135b6efad1b05c399869975962) Function -* [getFullName](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a00a7eca52d31c8f86e049dc1896d2434) Function -* [getFullName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7aada275954e2fff6bdea69b8a96bd0c) Function -* [getFullName](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a5b0b8db5aec4ebfbd8e7918568c71b70) Function -* [getFullName](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a0b0e9f581b1b038395dacb2700d82ce4) Function -* [getFullName](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1ab1dc7ab3547d2631e64f683968bd0989) Function -* [getFullName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a5766e80ec09baf80e3ad7c28e4dd3bd4) Function -* [getFullName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a8c74276fefc00a8b85a576e1d1b58053) Function -* [getFullName](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a6bbb377e1c98a99b660cfdfa3c61f191) Function -* [getFullName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7d1acdd7a964ceb7d189c87a19e9bcb3) Function -* [getFullName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a44ebe17869a3b1b95568ea46299a9f3f) Function -* [getFullName](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3e427b90dbf2f763c2486cdd774c2d49) Function -* [getFullName](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a7e4a9eb5127e60bfbbd90640e35b32a7) Function -* [getFullName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4ca185e60b69ce2ff41d19a2270bc28b) Function -* [getFullName](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ac8c712e2b8f8136f59cffd1665d6cb5e) Function -* [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) Function -* [getGlobalParameters](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2fac8021991150ab97e3673e4b0c0dc1) Function -* [getHaltStatus](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa75908bb0ec202342833c666b10fcb66) Function -* [getHeight](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a906ba9f57a9a472e1a70c151a50b1155) Function -* [getHelpURL](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a81605db892f6e5dc71aa7a4f2d00686e) Function -* [getHighlightedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab7998245db9550b3e7c21a25b37ce7bf) Function -* [getHWND](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a27e733b7b61329799abe081c40b00394) Function -* [getHWND](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aaaa18b9967d91f5e9afa0f663fb4ddae) Function -* [getIconLocation](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1af49ffd75001ae0bfd3dade7f5b9562db) Function -* [getInput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ac205f68299271d8e97adbc34f7c33655) Function -* [getInputLabel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a4d6a218d3dfff84908b13db7016a947c) Function -* [getIsBinary](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1afaad0639d6eeb9543d9ead12e9164094) Function -* [getKeepalive](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa49db3c3a511089125f6ce44a1ec838f) Function -* [getKeywords](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a38d839895f9ee3493710062d2bf67c34) Function -* [getLastErrorMessage](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5a57f078a8de6d78e6cc4f808c761fe8) Function -* [getLegacyHWND](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity_1a7a2562683a18b86dee7b0cb60564b5e6) Function -* [getLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) Function -* [getLength](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad9da4a66a831de9a501a7aca13a6a84f) Function -* [getLength](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab0632e518febc3b1549fc35d932fd451) Function -* [getLength](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1acb6d739a4e50bcbbda5a5cf053ae21db) Function -* [getLength](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a8167ef387b9cc11bc76e9a0e0694a833) Function -* [getLength](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad88eff947daa184ab953839666729ae5) Function -* [getLength](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a39098992a1f29458010e4d18385d3681) Function -* [getLicensingPath](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af5bdeb0442c6f35c0e5db849b1a166fd) Function -* [getLink](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a9861b3ad530a4efbe4925c89550e8cc5) Function -* [getLinks](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac83decf1799275a0d13ecadeffb008cd) Function -* [getLogger](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af2d28cb0c0290a80ebe0e31f91497f11) Function -* [getMacroScript](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a16bc3b79ea75a2c2e9c6aaf48591f840) Function -* [getMacroScriptLanguage](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8c930544d5f9fc2e49afb076b5ccee76) Function -* [getMacroTimeout](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a18766ae9a0fda73f8febdb709adfceea) Function -* [getMemberDescription](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1abb5cd702a72b774a9b93a50c1a4a4270) Function -* [getMemberDimensions](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac7ead6acd3c9f25b85e9670c396babbe) Function -* [getMemberEnumAliases](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ae8008b1c066e802a5838dfdc9775785d) Function -* [getMemberEnumValues](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a58394bc10f092128be001e36d890c0be) Function -* [getMemberLength](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acc1266cc18716f9973ec60f57c4a657d) Function -* [getMemberList](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a06be37e0fa407f4197aff2e534f61eb7) Function -* [getMemberLowerBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1afd9fba6ca47b0bf5fc48a2d210654d1c) Function -* [getMemberNumDimensions](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a558bd8128469e74dacaae9236e57eed0) Function -* [getMemberProperty](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac9fe0949b94f5f8243a2b783ed2a65b1) Function -* [getMemberType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa0e74d911fa3c06e65ae0061bb0a1740) Function -* [getMemberUnits](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa893e48f7214f7b0c31f5628c16ebb0a) Function -* [getMemberUpperBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acbf0879d4bf1acfaf7cac4f32ef9df0e) Function -* [getMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7143a8eed8b14b1b6b7772e82f472cd8) Function -* [getMemberValueAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a75f4995da0954629b58243f202e1681e) Function -* [getMenuItemDescription](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1a3213c537df82b4c00dd7f4df96b90712) Function -* [getMenuItemName](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1aa8491483ad472e4f1f9e51ea028561eb) Function -* [getMenuItems](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1c15433a3ca058372e666abbaa1e1fa6) Function -* [getMenuItems](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ad899f49a6bef9cd0f56292b7c92d8503) Function -* [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) Function -* [getMetadata](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ad0ea6a9bc76c34b8158454e27bbfd9b8) Function -* [getMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa6b44db219dbaf49be81841dc459f4ae) Function -* [getMetadata](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a74eae8f0c59826ea05228abfc9a9354a) Function -* [getMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a2bd6e585619f4cd76426932b62dcf60a) Function -* [getMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a1a41489453d177315ae18ef464e8907b) Function -* [getMetadata](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a40ecee96822db8b700fe1a814b2ab3b1) Function -* [getMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ae315b5cc3acb88a2edabaa8eea7a6690) Function -* [getMetadata](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a730717369f8ddb8fccfcb3405c56afe3) Function -* [getMetadata](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a9fa5015afd1b3cdd651ce2a0e093a6f6) Function -* [getMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a76933c6f159d52907c0b9f6ba3d13136) Function -* [getMetadata](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aea17e7f7dc6d8979c2c83aec3f8a0c42) Function -* [getMetadata](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6fe6bbfed4b08df8c9f9a4c86cb49ca5) Function -* [getMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac6becc1bb1c5206e972c266164f838ca) Function -* [getMetadata](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a122afef9ff20a0de02d08ab41eb4e5bb) Function -* [getMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac730dc0fbfc8ae56788048e6c0fb80fa) Function -* [getMetadata](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1aa094d1b1e7b20a631c92c9ec9d936d71) Function -* [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) Function -* [getMetaData](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5c33238aa348f88bd3a7c66cde890631) Function -* [getMetaDataProvider](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a2f8bcf1cea9355a81d408919e479013f) Function -* [getMethodList](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1ad90418c9d492ed35dbb1d20943035e) Function -* [getModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5d42323e20b243257f4cef533dd58e7d) Function -* [getModelCenter](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ab914e1d1c1dd883a0a1b6201cde0577f) Function -* [getModelCenterPath](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1adc47ef3cf5fa8d766117ec19c7dfab92) Function -* [getModelUUID](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a499de038ba95ad40b52862e5239bf18c) Function -* [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) Function -* [getName](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a4b41d24972378517a23efafc6a0fc403) Function -* [getName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a471100848db5a6f0c08f2920aa283ac6) Function -* [getName](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ac4595a4a7f2b81c6c5c2f1f5e3742f56) Function -* [getName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a19763f04596904ff5cab2f4f72f6f501) Function -* [getName](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a69e3af3092c78b0c19d9e3fb719f9b4b) Function -* [getName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe2789906f30f6a082e5d3d79e2b5bbc) Function -* [getName](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a10978bbb428eadf01141d2ceb2373c7a) Function -* [getName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a3f04f85ebe4f50a88c7cc3a61ae597f6) Function -* [getName](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1adbaa029c76034043ccdf2bf84bbd0e7f) Function -* [getName](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a2ab57d435f315c7afc7bed802b57d9d0) Function -* [getName](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1ae9bccfbc2ecd401d1f1403594c0ff513) Function -* [getName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a97c817507e162f9422b2f73ab5c8cef1) Function -* [getName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a79fdcc3e290b4b0df816f69d8a8d5f9d) Function -* [getName](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abcd09429d47c396bab6dc63690e1a1c1) Function -* [getName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1ec0c0bce4884b2c8c1decf29f4d5b86) Function -* [getName](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a625e640f8adae51bd6f65a88c7f67299) Function -* [getName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a282d98574e8d65d85c9908b6799321b7) Function -* [getName](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa01b77111d4a975cc12ca3e0a16d845b) Function -* [getName](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1a2b2ac899757c8dbd31a9c38b6d08f2c2) Function -* [getName](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a88c3162ff460faee36d43d3903c7a498) Function -* [getName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a0a90870618bd396edc53c27ff0b8c9af) Function -* [getName](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a50cf9efbe23ed25a027f6df1d7132577) Function -* [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) Function -* [getNetworkLocations](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a375ab85c506633857e960502c208ed79) Function -* [getNumBranches](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a667215e89aa8d7b6ff584ce7c2a9e566) Function -* [getNumCheckpoints](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae1070b5293d700b8e095477fbb54b80c) Function -* [getNumCompletedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a023f64de843e0e97d47e37b9cfbac5ae) Function -* [getNumCustomVars](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a0b2e2ab12279325bc63b9db7330d6bab) Function -* [getNumDesignVariables](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ade57b335d32a772b6de31d129b6374bc) Function -* [getNumEnumAliases](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ac865d961f3e4aa6fdb21c65f4960e7ee) Function -* [getNumEnumValues](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5f133f6ecf8e21010e1a624221f78d5b) Function -* [getNumExpectedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a250340a6fc41c19a43783cd3171db63d) Function -* [getNumFailedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac08c8abcc799991d7b12548ae1172378) Function -* [getNumFailedRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa169d7ec12253068db8fac00e201f6a9) Function -* [getNumInputs](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad8dcd18454e462b191092edd4096ab0c) Function -* [getNumNonEmptyRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac1ad590e863b19678c6e47ae4ff3e521) Function -* [getNumOutputs](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a49fae6444ed2747c716f7829f8113969) Function -* [getNumPages](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a389bca42567d788cb1c1c619a400109f) Function -* [getNumRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a59b24c674a512a94640f4c5a890e9309) Function -* [getNumRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1abe6a941ef83e86184ba40149f775d3f8) Function -* [getNumRuns](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ae63c0e8eda0494dda49ee20141f11ece) Function -* [getNumThreads](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a2a6391025814c8b85861fe9d8eaebf58) Function -* [getNumUnitCategories](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a0f6aab6d238cbe899af59725ab0de842) Function -* [getNumUnits](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad6a35e6ac78e89ddcd4a68023bcdd651) Function -* [getNumVariables](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aca767f94c4b80412c79eba62214eebfd) Function -* [getNumVariables](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1acaa00471b667aa04d3462fa4e26f8d36) Function -* [getOutput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1aede4e8c73a70bff3143317d0fa8dca97) Function -* [getOutputLabel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a7665a71ea25ae6436d201cd2e339e976) Function -* [getPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a3da50454f5e424f4aa3971d84f7387c4) Function -* [getPageSetup](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ac36fc1456cb55f50ccf9046d617b7187) Function -* [getPageTitle](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a91b7a788be45f38d1cea9579731e794c) Function -* [getPageTitle](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a38ed1207dbcb350057bc22b0450eb009) Function -* [getPageType](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2e8a2fc452e5d1bad94bedf2edfe3ca5) Function -* [getPositionX](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a476766c4bdcb9fb07f1fdd0a12a04ac0) Function -* [getPositionX](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a0c3e0c952584ba25801114e01010eab0) Function -* [getPositionX](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a205b99507e64a1ad621ee6aeb6cd6d0c) Function -* [getPositionX](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aa032eb6b3c27a69052a8eb81053dfc34) Function -* [getPositionY](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ab58695afb7a8ecb8202a1b20011d384a) Function -* [getPositionY](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1ad3da2b98a973112ea897cf3b146f0276) Function -* [getPositionY](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6cddb9b21c6b3b60a23f2a28d60ea17a) Function -* [getPositionY](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a7b5ce3f6ce5bfd44702ff1fb874fb9fd) Function -* [getPreference](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aadc031780e0355e1ca2bba83cb13441a) Function -* [getProgID](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a0b7490ab8fe0d89e8ecb6478cfbee8e9) Function -* [getRefPropValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aecab78945a16a827081638609b48318d) Function -* [getRefPropValue](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ad90bbc18df836afc454157bd06523d75) Function -* [getRefPropValueAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a76d1cee0ac71a9682e7ff9af6df9cf77) Function -* [getRefPropValueAbsolute](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ae45fa34070d38d9de3593d815e86b1fc) Function -* [getRegID](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac0dd856b24d06484c6ded0aba0199016) Function -* [getRunIndex](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a03b40110aba59370e9eb6aad1b6b2076) Function -* [getRunInParallel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a8893b7830affcf596e4a6d149ab47753) Function -* [getRunName](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a42f819d3a26184898d9487b42894d4e2) Function -* [getRunOnlyMode](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a38682504615aef9e603a9c2f3d4bd2e8) Function -* [getSaveLocation](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a02bf3019e5a957a4db2daff6dda6ca28) Function -* [getSelectedPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2dfa9fbb916798751f0fbac5ca3d2fa8) Function -* [getSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a3d171136e0b219dd4e2d0d1b4bb9aa1f) Function -* [getSource](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a7ee6752f95f3bdfbe83132a3a7794cb2) Function -* [getSource](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae4cad8560e705e807f793a2dade750e2) Function -* [getSource](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a3dc2690409dd67fc5b3023e50d7abed0) Function -* [getSourceScript](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1af377a582a930edbc7b4a56b57cd54375) Function -* [getThumbnail](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1af5f2203aace2cd54bac6c8789b1782c5) Function -* [getTitle](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ae6aab41ece2d9cf2ac4285aa10cf156e) Function -* [getTradeStudySetup](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a5f068466f0c9b18f8ba1681d97c2ddf9) Function -* [getTradeStudyType](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9f51a8f280c8bc80f4cebcb9de40ab5e) Function -* [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) Function -* [getType](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad8d2b43dd9f4b3656dba1e8570f7f747) Function -* [getType](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a6e68844292a9f0b5e1924728465d02c0) Function -* [getType](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a04395c5a8d6ceff26ae08e6c001bdd45) Function -* [getType](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a59535b93acdadae5c47ebb3f148cc8a7) Function -* [getType](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a974708d2da959d48ee301088918719fd) Function -* [getType](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a6614c3d1ae621d218762e8ed8ec58222) Function -* [getType](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aec7c7bb8f9e43d411c457d7b091e5378) Function -* [getType](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a09f10acb36a75c48c2cce4f1925acb55) Function -* [getType](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a9cbf40ea5229f4240bdb241e8d88329c) Function -* [getType](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a05e311dcfb051f0df6afc99dd01d6773) Function -* [getType](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a38de94bbe44275b88d92522926b1a841) Function -* [getType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a40cc49ff4f6fd51695549d4ad32a4384) Function -* [getType](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a60190ee41cfbc6624a138dba5c790d00) Function -* [getType](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac3c3f33a239fe1182da434d7570346df) Function -* [getType](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ab946d679180e3e65433c8b4b2d61d39e) Function -* [getType](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1aa05642b60b5a5e44e9954c130d4686e1) Function -* [getType](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a551d15c4f328f341d8cba0fe28bfd2b0) Function -* [getType](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a582f9e8e47e60eca8041b98c996a4f4f) Function -* [getType](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a9468a019a8bfaaa771c5bf97e206ea5a) Function -* [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) Function -* [getUniqueID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a01538f2f06fba2512c31fb7a35a04b4d) Function -* [getUnitCategoryName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1abe07ee5b95ed640b926a165f2e02b7f1) Function -* [getUnitName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aab8bb46de63e10f150e9614ea36d0b9a) Function -* [getValidateAll](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a53f5cbf8459b20f9c748535d8013eafd) Function -* [getValue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a43d806edede4bc2efa5e88c7615189ed) Function -* [getValue](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9aa72924449a81d937830715bbe7503e) Function -* [getValue](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa3502b40206d864d5bebd8cec59c71ed) Function -* [getValue](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a2e4c0ae7dbfe8869f56ad932ba0b22db) Function -* [getValue](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1addb4d3f364f0f952a6341b52616bb0cd) Function -* [getValue](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8cacc6c81e217bf7affe180a59d21455) Function -* [getValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a32db352eed1650697f8b164546ea3eeb) Function -* [getValue](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a7ba8cf139385e0630061f9ccfc8dc55e) Function -* [getValueAbsolute](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad975bca587185786df34ddd600d7fe96) Function -* [getValueAbsolute](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a2d9a833f72d05827c32edda52d0584f3) Function -* [getValueAbsolute](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a7c1be797998fc344c26e23ce85d9057d) Function -* [getValueAbsolute](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a04408aef2e249b325db44eb8e0ca6758) Function -* [getValueAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9233b22b8ad38b1abf30bc68d543d789) Function -* [getValueAbsolute](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4e082d20ea2f1b47c95d26152595d05d) Function -* [getVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a074ed759e40eb4931c5b6e23f2c72e02) Function -* [getVariable](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afb270ae53383589c63f87b4e3385f128) Function -* [getVariable](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1af46fd2a7e5dda89d73e347b2fff75d16) Function -* [getVariable](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af87c3dde3f5645f1257ba0edb037889b) Function -* [getVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ad88148c419a4c75c4c79b9d5e3c41eb6) Function -* [getVariable2](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a03430a06338ca51c6f5c45421a47f320) Function -* [getVariableDescription](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a12a4f4daac61b17022aa54dcbb3ec84e) Function -* [getVariableDisplayName](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1a6e0f4277d79e93bd5d08fa7e548394a0) Function -* [getVariableDisplayName](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a6fbac6e4218e6b82ed61d2f38f9b7af6) Function -* [getVariableDisplayName](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a84850e887d89eb20d7793933316ad752) Function -* [getVariableEquation](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1aed1386a6f6cef8c6c4ec1d94b3d07009) Function -* [getVariableEquation](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1ae152b41da461434289f61a5f4c327fb6) Function -* [getVariableEquation](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ad63d367bc060e84ccd0edc96747bd082) Function -* [getVariableMetaData](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aebbf42a396f1eea5b917d13b85e0fb8e) Function -* [getVariableMetaData](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider_1ab17303c17efd43f87d95991b2245bc72) Function -* [getVariableTempDir](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aee367d3da3f483f1d9d476e832c7bb9a) Function -* [getVariableValues](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a03fd55d685a75a6041202d00e676e052) Function -* [getVersion](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a7cb8178dec412b370f22e7a9905eb3d9) Function -* [getViewHWND](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1a19d4d225ecc6463333715ddde8c5f65f) Function -* [getWidth](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1adb51a1067e48f2e1ab9b79874a2d8a66) Function -* [getX](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a610ec59f3295fe819e3a1aadd043927b) Function -* [getXMLExtension](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af94e33f84d46652cfad0af931db0d59b) Function -* [getY](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a15d2803f54702b2198a2f0dc3f36d80d) Function -* [Groups](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a1e5ca5f83e7c3debe3d63366948ad894) Property -* [Groups](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a4393774e2d80bd06dfe8070ef87b146f) Property -* [Groups](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1afab9254fdafc011806a8834430af982f) Property -* [Groups](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a491cb2ba622f73c3338ebbbe92e9da3d) Property -* [Groups](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a6d041596bb6e0be6dd0710c6c9e0e8c9) Property -* [guiCloseAllMultiplexers](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8708a9033fcd77731539b085a1c6c047) Function -* [guiLoadFile](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a255ea30feb95451802aa280bdffcd7b8) Function -* [guiSaveModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8ad33e25dfad91e8ba248d399a1b6449) Function - -## H - -* [halt](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1aa550897654f63d845e410ac9bda26b8a) Function -* [halt](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a4cde569f8ca3555ede7fd8d3d2cd4387) Function -* [hasChanged](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad7310b48379f9d4f8d4688d11ccf0185) Property -* [hasChanged](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a5231acb6d280e70ecf75f906a357e3b4) Property -* [hasChanged](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a5b428150a22e87af248e5fc3277c70ae) Property -* [hasChanged](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a91e412d2c7f4955e11e24099601fab8f) Property -* [hasChanged](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a547bbc74c5db046b8d125cfbc3a6ab57) Property -* [hasChanged](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ae8928b3be9d425c01df1a6bc1052eeaa) Property -* [hasChanged](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa81da335ee85ebf5f806be0b1bc1f39c) Property -* [hasChanged](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a14bb947193a4e5e629d104cadd3159be) Property -* [hasChanged](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a117efbea02cce1afa842341cf3e70bae) Property -* [hasChanged](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a752e2918df57582c7e0639840f2653f7) Property -* [hasChanged](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a221928e7f8f5b8f5ff309f6e768a8d96) Property -* [hasChanged](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a32bab88b29119d84a6429364fd651411) Property -* [hasChanged](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0f4d80365facbc0cfea5745f131e9d10) Property -* [hasChanged](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a7d7a0e45d355883535175f060d150a25) Property -* [hasChanged](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a846973fd74773de77e95f5a686059b8a) Property -* [hasChanged](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a70aa745d819120f3f13d8f5cac099e44) Property -* [hasLowerBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a4a319eba200eb23b04f76abf8780c1cd) Function -* [hasLowerBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a18723d07a18cb720d07bebee26f35d2f) Function -* [hasLowerBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a37a15ea329f97b885f57b2660f8cf519) Function -* [hasLowerBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a3f0459ca0bc1b7108721b4ee36304bc9) Function -* [hasMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1b153917fd978107a15c2b2283d9f1a0) Function -* [hasMemberLowerBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a2870271930867129b9102eec3c778b28) Function -* [hasMemberUpperBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac291b12d8f349c09c18162cda4299a4a) Function -* [hasUpperBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a1460ab1d3ab8aeef7679c93c07fc8138) Function -* [hasUpperBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1aa78deb300d4f268523777fcabe898ce5) Function -* [hasUpperBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a4b31b367d82c30fef71bd2412482c25f) Function -* [hasUpperBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a6434f421569bb898aabc32204d615f1a) Function -* [hide](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1adcc3bc6f74b07b516bbc98361b36d4d6) Function -* [hide](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac7ae926ce6dea385cb26901c86c7fccd) Property -* [hide](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa6cabd1afd2f36f8e431da7342e9bdb7) Property -* [hide](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1aa3a5fa8309ca19d0bf787bbf7cbcbf54) Property -* [hide](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a75d77af56d17b13040ea831d957a4cab) Function -* [hide](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a009c7abd22ec22abd5367db1a29305ff) Property -* [hide](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac8bae6ed29215d02364f98a876f2ccfa) Property -* [hide](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ace9ef38b4495497cd17fc358d675cf58) Property -* [hide](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a6c602247c4c00069af837d7dcbfb3862) Property -* [hide](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a1ed81bb22242904529b71361e954445a) Property -* [hide](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5f571b35a242ad8260a3380f75ec5acf) Property -* [hide](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a0baef047e82cd94c3fe393690a129bb0) Property -* [hide](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a70d41ee491cb94eaa45dd1e3e6c805c9) Property -* [hide](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1aed414820e7a805ab6ba5d08c437d7347) Function -* [hide](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a35c7c4ee97058e1636c56d4863c58e00) Property -* [hide](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a598cb6023fcbcb265cc44618529c3040) Property -* [hide](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a39446dbc4a63268669450640360a10ca) Property -* [hide](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1acd58e2a3356b8297a5cc491f5a3ce9ac) Property -* [hide](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a2b79ae605f5b5864f5470d730a845f7c) Property -* [hide](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a12129753b07898622d2e8a55801ef19d) Function -* [hidePlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a806cc1860aaadaa5496d4caa0a51fe91) Function -* [highlight](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a77749479f2bbdf8caa1f90119e6112fd) Function -* [highlightChanged](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a84baf9536c489fbb318a5e13cbf6fef5) Function -* [HTMLViewerGetMyHWND](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad6f56123c0b435ffca19628deaa4169f) Function -* [HTMLViewerWaitForClose](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad62471b3a17a7b182d7f8fa0df7048b7) Function -* [HWnd](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a4971d80a859be3f620c329dbc5019d7d) Property - -## I - -* [iconID](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1af8ddf59c545db7695b90a2a64bdcc822) Property -* [iconID](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1ab263da951c24595b88adc5b86fe93540) Property -* [id](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa3402e5d6822ebe510cc7fec192d5094) Property -* [id](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a75bed8e4832c534f7d7842ec7921e652) Property -* [id](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a1a709440522385b3161831eea313c15d) Property -* [id](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a2c98e62414b0d01303d7a009449f0871) Property -* [id](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a1022454788e8b96f6e84ad60e652bbe3) Property -* [ignoreDefaultPlotSetup](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a0c7a09c2192beadb073ce041aa0e8893) Function -* [importlib](namespaceComponentPlugIn.md#ComponentPlugIn_8odl_1a1176e44e4d62af0ed162d7221dc5f53f) Function -* [importlib](namespaceComponentPlugIn.md#ComponentPlugIn_8odl_1a2cf599b993bafcd3fef5f5b7c34495e3) Function -* [importlib](namespaceModelCenter.md#namespaceModelCenter_1ac27ed4a9b1a4fd02d9a3191c3ffbfbed) Function -* [importlib](namespacePHXDATAEXPLORERLib.md#namespacePHXDATAEXPLORERLib_1ad9ad6f6589cc63d798e289289f567b68) Function -* [importlib](namespacePHXDATAEXPLORERLib.md#namespacePHXDATAEXPLORERLib_1adfc3e518adcb9b631d6b3cd9f7dd728b) Function -* [importlib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1aebeea567338ef111ceead76bc59bf072) Function -* [importlib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1a0e2d7a999f42bdf583341c632c923d8e) Function -* [importlib](namespacePlugInMetaData.md#PlugInMetaData_8odl_1a64427c7c968384bb40b716dd4f058fc7) Function -* [importlib](namespacePlugInMetaData.md#PlugInMetaData_8odl_1ac015988798e4dff85180232ea6f9f0c5) Function -* [importlib](namespaceTradeStudyPlugIn.md#TradeStudyPlugIn_8odl_1ab9cd75f3f81835d0383377354faea30a) Function -* [importlib](namespaceTradeStudyPlugIn.md#TradeStudyPlugIn_8odl_1a6f9be822941ca29fb4380a23d65b3994) Function -* [index](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a331317f8f767933429cce81e8ada5385) Variable -* [IndexInParent](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a6e888824a16134a6797ec96745c9dd4f) Property -* [IndexInParent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aafafc5168a78769e88de4505174b0daf) Property -* [IndexInParent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a5c8b1a2d576bbdc2ea74f70b499889e0) Property -* [IndexInParent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a20f2c6a05beb38eb4d95a010cb48f94e) Property -* [info](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a0a400bf773ffc4fd5d9c4440fd2d79da) Function -* [insertRun](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab64f03fca9f43b3a491393d44c9144d5) Function -* [internalLicensing](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae91fcfa7f9dfe5fa3df62fb9d3c703c8) Function -* [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) Function -* [invalidate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a04e162fdfae6e99e6dcfd926adfca7b1) Function -* [invalidate](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a1eecc6708b4fb8e29bfe73ead410adaa) Function -* [invalidate](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a73c230184c72f5abcb7d3af5f91c9d1e) Function -* [invalidate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a032e132c6c6a61f81370942921ab2edf) Function -* [invalidate](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a9abf6ea522bbff16d7c2266202b5bdae) Function -* [invalidate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7599948212f77bb66f8ef42fc98e53ce) Function -* [invalidate](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2beb5e20db0843a92acf8d0cc961e3af) Function -* [invalidate](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ac80cc84f95b559145c98a82367649d89) Function -* [invalidate](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a78101d039853db9e2d989edef97f226b) Function -* [invalidate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a521514c594a1ab4e30669305585530b7) Function -* [invalidate](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a07f62e68cae660a8bea1d1e31d754fcf) Function -* [invalidate](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aff411bdfa6a95ccc904878f1ffecba6b) Function -* [invalidate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a56ea1d83eb42dda4a7c06b6fbbf6ffd5) Function -* [invalidate](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3a460ef81527173ce0c272d2bdf69da6) Function -* [invalidate](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a70b40fcdb20ca2991b3db649f77eb55f) Function -* [invalidate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac6dd084c61d7ce2631d207242eca89bf) Function -* [invalidate](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a7b29d24168420440191f35e6ad382d03) Function -* [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) Function -* [invokeHelp](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2a8f95eb131aad5e03597ada8251ef30) Function -* [invokeInsertPageGUI](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a0f0eb77a79bbc31706335b91e6a2923a) Function -* [invokeMenuItem](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2a636f7492de925506cd78a80e37deca) Function -* [invokeMenuItem](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1afe6db966ff1b5790a8ae887d70294dc3) Function -* [invokeMethod](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afaddb2c21be03b26716594af883a51ee) Function -* [invokeMethod](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a583b809498c69beadd39c1e21e2cebab) Function -* [invokeMethod](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a03484bf5c7636d2015b3b11c3849ac30) Function -* [isBinary](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a121de67cd4278a5b008d416a2579bcf0) Variable -* [isBinary](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a18d61da08976eabab25b4049726415a5) Property -* [isBinary](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a66fab48ff61be8f9c8e21bf0c9f96f45) Property -* [isBinary](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2d900fe8d944b0dceaea355cf64ba5a8) Property -* [isCanceled](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a2248d0fcfa9dbf3b0de48e5b75ff4df5) Property -* [isCustom](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1ae6ba3b64b599b6df11a39f0c3fa1b078) Property -* [isDebugEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1adc9ab6356bfc5c95aad04ee887c21588) Function -* [isDesignVar](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a09f46ea4820a3341554e2bad9a052f7e) Variable -* [isDesignVar](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a6429c927c6b4f5937ed8f046ebb618dc) Property -* [isDesignVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1abbcbe48e293004c4cd609b574ecf94fa) Function -* [isDesignVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aa53ea93d24fd4476de06e3226a5b2e69) Function -* [isDesignVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ac933f79559b7a0cf45fe49a6cb1e77d0) Function -* [isErrorEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1aea7f6bb4163869086c07a72b5ec14666) Function -* [isHighlighted](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a81c862c59a3b280376afc1b9bd221116) Function -* [isInfoEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a4472be2e0c0f6302d2e73ad582fe6b9c) Function -* [isInput](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a1f4709d547b2d872fd404f7fc5b6566a) Variable -* [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) Function -* [isInput](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa87e846de03852ee40e909935c2ec470) Function -* [isInput](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ab8445c95fe06a4eb82ed55034c26d34e) Function -* [isInput](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a36394ba4430c4f15bd18a02a96ff9c00) Property -* [isInput](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa0a3e17384092dbeb0cef004db873191) Function -* [isInput](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a162bb6a2a0c8cf5a2f3ee15daaaf85c2) Function -* [isInput](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9e45ea90908321e84979e5b8d2f50357) Function -* [isInput](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a92363045c1f3285c5c1127ad149c0250) Function -* [isInput](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a8c9a1d489060c768242c74b57e85aec2) Function -* [isInput](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a3752394336c9689384efac1005422431) Function -* [isInput](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ab441aa413516cf14c082aa39801250c4) Function -* [isInput](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1adb2ffa6d382f3874d63cab8c53f956c6) Function -* [isInput](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a6a71677c0367f53bb39861474c8ce11e) Property -* [isInput](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ae7e5c76cfd592a71fc7e5785c7cf6394) Function -* [isInput](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa61fe715fadff86e98c35d4bf6aa16e0) Function -* [isInput](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1a0a8ec20895618292855526596a534f06) Property -* [isInput](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a3b7b397239f04cf9ea9358f9477ee2c4) Function -* [isInput](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a2268414421505ee4c0fb49de92953007) Function -* [isInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1a02ddc66a224fd3c8fe04ec8ec60959e5) Function -* [isInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a4f1199571453c7b851c484e88fb43a1a) Function -* [isInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a01b2afba0cae246a236a56555ffd3e05) Function -* [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) Function -* [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) Function -* [isInputToComponent](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a871c46c1f732b2885e2ef1fa2080a3e8) Function -* [isInputToComponent](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1af27600cef7dfba2a97acbeb31e2bbe43) Function -* [isInputToComponent](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a86e51010b5f7765c036af36bd9452622) Function -* [isInputToComponent](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a18112e5a20ca1711e97f8a5514995a49) Function -* [isInputToComponent](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a29e9bceef09e96ad83ce6c0618eb17dd) Function -* [isInputToComponent](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a8ca654408734e709fddeb945e81a5d29) Function -* [isInputToComponent](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a3223f3e2305da64ecb24530ed3e1652f) Function -* [isInputToComponent](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a2a19aa7ca1e4c4fb862016aede378c05) Function -* [isInputToComponent](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a67665668e8c1abee8bc9db708b05e970) Function -* [isInputToComponent](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aff062edf68ee2b0ff7db9b81cba0899a) Function -* [isInputToComponent](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a317b7b47fa55798e212c426b4ac8f014) Function -* [isInputToComponent](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ac551ae6997c725cbb3ef71bd6217f89a) Function -* [isInputToComponent](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ad59d273bea1a7e02540520e9b4428264) Function -* [isInputToComponent](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a940488ff3ad42baa064349a43fe9eac6) Function -* [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) Function -* [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) Function -* [isInputToModel](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a364726a017aca71bdb22d43530cc9426) Function -* [isInputToModel](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a38875f7d7b47980f4d78d76a449bbb01) Function -* [isInputToModel](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a78d5b37b715d259e29e0de79fa58508d) Function -* [isInputToModel](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a34bbd8b682a39cbe120f972f0be7b1cd) Function -* [isInputToModel](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1accf93e4a9fe2c9eb205ccdf1704f3f9e) Function -* [isInputToModel](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a7bd0dbfb0063987f2484dce0cd61c8d1) Function -* [isInputToModel](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a324e6df2e0d789abb14a6ab9bbabb119) Function -* [isInputToModel](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a41c321c0260174a4c118e309fbd13085) Function -* [isInputToModel](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a87d3f8de3185380e368fdb008466dfe3) Function -* [isInputToModel](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa0e5a61596a334437a407396c4a38e44) Function -* [isInputToModel](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2d16dbc50ee0f77d5ca99b8a600e5023) Function -* [isInputToModel](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ad8a6169868d4d186b658946403eae2ab) Function -* [isInputToModel](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1af1da4c99c6359d527ad57c9433333a36) Function -* [isInputToModel](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a52f14ae0f304152748e0373e91701708) Function -* [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) Function -* [IsInteractive](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7fc1e5b5a0eee411b82f7508243f453f) Property -* [isMenuItemChecked](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa6aabcb973d32ab328fa815d38d2da7f) Function -* [isMenuItemEnabled](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a23f32ddd6ea2d2d268351327a03e46b5) Function -* [isMenuItemEnabled](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a7259c195e2711d0fb54579e22752adb2) Function -* [isModified](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1af7b8598fa12d5b516344517c0593a983) Function -* [isModified](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a0e1c5e9cd74d1f2516fc1d35eea45b17) Variable -* [isNonStrictType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac232ce8558a68f9f27661644fbcee3b8) Function -* [isNumeric](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1ae0822979f6b70670a347c98c67d367b2) Variable -* [isNumeric](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a72127ffab32587ffbec60628e70df2fc) Property -* [isNumeric](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1ac7d823563278b1abbc458b61aa5eb686) Property -* [isNumericMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a068348508497bc740975b56559316baf) Function -* [isOkToClose](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af91d7535a069da55220c52b759ca5238) Function -* [isRenamed](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1add033400b2b1694d63f67126639c198f) Function -* [isRunComplete](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ad0d48129784f8ce140ff3dfb76ee8ba3) Function -* [isRunning](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab045302c25ef3b584eb3736b9071569b) Function -* [isRunning](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a56114078a1e476ce5e5ec70314f6fb73) Property -* [isTraceEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1acef00afc02324874e8ff47c61dfb4455) Function -* [isValid](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a55e6f50a94f58d4c39bb6fe06c5398da) Function -* [isValid](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a55153c5a8cc53d611839b0b55bb3e8a2) Variable -* [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) Function -* [isValid](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d13fb275a266aa85280b6beed8be176) Function -* [isValid](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a877899b0c2bcc8400bcd8cfa31c4eb7a) Function -* [isValid](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a2d858bdac93de126a13ced552898b3f9) Function -* [isValid](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1abc151c7ba70d7f1e6249942a627e2171) Function -* [isValid](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a4d7719052c0b341f91436d3a0da270cc) Function -* [isValid](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1b873587774671d25664c294323beae8) Function -* [isValid](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a1d3371b70abb06b2eff5d1ada8aa114f) Function -* [isValid](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a7df18a18470a00422781d711e56a20be) Property -* [isValid](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2d8ceabbeb9640dffb9f6a9e654bbd79) Function -* [isValid](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a01fe29466d2371dd25e6d9a473de32c7) Function -* [isValid](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ab3d891c3978182e073923a56b4dbe89b) Function -* [isValid](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ae03686387c15bc80d2caec8c3a5a913f) Function -* [isValid](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a88a80a771329337246e883b3ce034400) Function -* [isValid](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a366cf132edcae4c78ff3c3c29d81ad03) Function -* [isValid](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1adbc66e2276350867c0b977bf5cf192cf) Function -* [isValid](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8b738f7eef3f9a3f8a723cede3809f47) Function -* [isValid](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a16c6e45e1967f427b3a7123d7da384b1) Function -* [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) Function -* [IsValid](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1a6dd8e8226f7d5b089ef7e4ae49ca8b87) Property -* [isVisible](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a876e3d3fad4e109897eb41df8252cee4) Property -* [isVisible](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a986646a10f5885304323ceb7a737c76b) Property -* [isVisible](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1aa52adfedbec735ae4d1e34c4daf66455) Function -* [isWarnEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1aeeb727ee61ec84c356257e23c8ac72da) Function -* [isWritable](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a349473cf74146c2b8c824e0c47c899e5) Property -* [item](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1a1fdee032bf053c5f99b0291bf04dcaec) Property -* [Item](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies_1ae6f3debe976f58187639b34a900ea2b1) Function -* [Item](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents_1a497784a98d679aa2ed109130ae004e0a) Function -* [Item](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups_1a4a71e44eeb916bcdc8bee4ab891b237d) Function -* [Item](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks_1af1e6de7d83b5af2ae699785b1d61fb1c) Function -* [Item](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables_1a68b42951fd19cf993eef52d372dbdb84) Function - -## L - -* [language](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1af3d2bdfd6cd0c29ada055bee3686b2ff) Property -* [launchDataCollectorPlugIn](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a434995395fc673c8197bfde7e1256240) Function -* [launchHTMLViewer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aae5eb45abe323ca501a777f31b9ae5b8) Function -* [launchMacroEditor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab180eb62170146926e7a6c2384d5ad66) Function -* [launchTradeStudy](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a24726ff2cf91ef85884d6b2bea513ed4) Function -* [length](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af118bdf4b120050d6700a7ceae7f5bec) Property -* [LHS](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1ae3805787afceef57db6297e72632650a) Property -* [LIBS](dir_3deb6222fdd4eb7b0f76591cf78ec6d0.md#dir_3deb6222fdd4eb7b0f76591cf78ec6d0) Directory -* [LIBS/DataExplorer](dir_4c5da7dd69977c70a414920e45f0e4dd.md#dir_4c5da7dd69977c70a414920e45f0e4dd) Directory -* [LIBS/DataExplorer/PHXDataExplorer](dir_f8085194870fe60668985a445c75a643.md#dir_f8085194870fe60668985a445c75a643) Directory -* [LIBS/DataExplorer/PHXDataHistory](dir_b61c1eebc2b964146e7860adc8b8cd2e.md#dir_b61c1eebc2b964146e7860adc8b8cd2e) Directory -* [loadFile](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a21295b971e1a8854d7524b85332fcb3b) Function -* [loadModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab57546e9e718895bbdfa25bc1b7d1e9d) Function -* [loadTemplate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1945a9df23ff32406e48f560a14ea592) Function -* [LocalPath](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1abfc95b5a36c4544b8f58aaffc0d74751) Property -* [loginSucceeded](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback_1a4b7dc5df7be75023f025f8d83fff7579) Function -* [longToEditableString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a2d5f201c8a8166ffeca606bac90d4b3d) Function -* [longToString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a175332e4916d1d86855b1b707831e308) Function -* [lowerBound](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1aa8335d587fd45435098d82f59751071d) Variable -* [lowerBound](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a559e14d8841091219ceb4c121ab8d1fb) Property -* [lowerBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a396e13c98a7680bc75354b6bf6b0487a) Property -* [lowerBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a8d74ea79cd0203c477fa96e2410ba176) Property -* [lowerBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ad38b7c1cfa620446572595dba1b607f6) Property -* [lowerBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a15d6fe654e10ea55a5df2e7bea934e75) Property - -## M - -* [MessageBox](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa31343d27c063cc384336028b12abac2) Function -* [metadata](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1adad4bb3cc571df3df8a8df37d634fe72) Variable -* [METADATA\_ACCESS\_FORCE\_TO\_32\_BITS](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dca637668ae8a3b4e7805346e7f1db302d5) Enumerator -* [METADATA\_ACCESS\_PRIVATE](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dca193d415dae56a753d64d37bcb67a2285) Enumerator -* [METADATA\_ACCESS\_PUBLIC](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dcaed115b108b3a38e88e5f5a3a1e17cf13) Enumerator -* [METADATA\_ACCESS\_READONLY](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dcae1023b575b4ff76a772e10c9162dd467) Enumerator -* [METADATA\_TYPE\_BOOLEAN](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153a0cb9ab8e21174262b86c899965d618c5) Enumerator -* [METADATA\_TYPE\_DOUBLE](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153a1ef8fb522f41ea233866f7058fde8a23) Enumerator -* [METADATA\_TYPE\_FORCE\_TO\_32\_BITS](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153afd2104e48eb6bb48323751a8b15395c2) Enumerator -* [METADATA\_TYPE\_LONG](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153a7f0cc46935e8f50a3ff7125e9ccac82a) Enumerator -* [METADATA\_TYPE\_STRING](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153ab0ea415d391c664f7c4c20e41e6a5b5b) Enumerator -* [METADATA\_TYPE\_XML](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153a934405f69eb259b948fdda69fda36cdd) Enumerator -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) Enumeration type -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) Enumeration type -* [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) Namespace -* [ModelCenter](dir_e61251abb0949c61ea8ea7dc5fba4af2.md#dir_e61251abb0949c61ea8ea7dc5fba4af2) Directory -* [ModelCenter::Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) Class -* [ModelCenter::IAddToModel](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel) Interface -* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) Interface -* [ModelCenter::IAssemblies](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies) Interface -* [ModelCenter::IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) Interface -* [ModelCenter::IBooleanArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray) Interface -* [ModelCenter::IBooleanVariable](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable) Interface -* [ModelCenter::ICachePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin) Interface -* [ModelCenter::IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) Interface -* [ModelCenter::IComponents](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents) Interface -* [ModelCenter::ICustomDesignPoint](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint) Interface -* [ModelCenter::IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) Interface -* [ModelCenter::IDataMonitor](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor) Interface -* [ModelCenter::IDoubleArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray) Interface -* [ModelCenter::IDoubleVariable](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable) Interface -* [ModelCenter::IFeature](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature) Interface -* [ModelCenter::IFileArray](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray) Interface -* [ModelCenter::IFileSystemInfo](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo) Interface -* [ModelCenter::IFileVariable](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable) Interface -* [ModelCenter::IGeometryVariable](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable) Interface -* [ModelCenter::IGlobalParameters](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters) Interface -* [ModelCenter::IGroup](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup) Interface -* [ModelCenter::IGroups](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups) Interface -* [ModelCenter::IIfComponent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent) Interface -* [ModelCenter::IIntegerArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray) Interface -* [ModelCenter::IIntegerVariable](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable) Interface -* [ModelCenter::IJobManager](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager) Interface -* [ModelCenter::ILogger](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger) Interface -* [ModelCenter::ILoginCallback](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback) Interface -* [ModelCenter::IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) Interface -* [ModelCenter::INetworkLocations](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations) Interface -* [ModelCenter::IObjectVariable](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable) Interface -* [ModelCenter::IPHXFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat) Interface -* [ModelCenter::IRefArrayProp](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp) Interface -* [ModelCenter::IReferenceArray](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray) Interface -* [ModelCenter::IReferenceVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable) Interface -* [ModelCenter::IRefProp](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp) Interface -* [ModelCenter::IScriptComponent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent) Interface -* [ModelCenter::IShowHelpEvents](interfaceModelCenter_1_1IShowHelpEvents.md#interfaceModelCenter_1_1IShowHelpEvents) Interface -* [ModelCenter::IStringArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray) Interface -* [ModelCenter::IStringVariable](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable) Interface -* [ModelCenter::ITradeStudyEvents](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents) Interface -* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) Interface -* [ModelCenter::IVariableDescription](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription) Interface -* [ModelCenter::IVariableLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink) Interface -* [ModelCenter::IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) Interface -* [ModelCenter::IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) Interface -* [ModelCenter::IVizContainer](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer) Interface -* [ModelCenter.odl](ModelCenter_8odl.md#ModelCenter_8odl) File -* [ModelCenter/src](dir_cb6cf9700ae02fb10e39761559b5fdeb.md#dir_cb6cf9700ae02fb10e39761559b5fdeb) Directory -* [ModelCenter/src/InterfaceDLL\_ComponentPlugIn](dir_f4b71a0ee7c6b8122721a969fd158e55.md#dir_f4b71a0ee7c6b8122721a969fd158e55) Directory -* [ModelCenter/src/InterfaceDLL\_PlugInMetaData](dir_254da5db084e40f61f0f3ecf2de92ae0.md#dir_254da5db084e40f61f0f3ecf2de92ae0) Directory -* [ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn](dir_6384486296a61296aa9794364431ed6d.md#dir_6384486296a61296aa9794364431ed6d) Directory -* [modelDirectory](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1adf58dfafa5401318de434c22d9e12ef3) Property -* [modelFileName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1abb83f0e9475f2ccf8de46b09946d79e3) Property -* [ModelXMLExtensionsChanged](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1a09c0d68be95fb162874e4da3d0965749) Function -* [moveComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a70986fc1018ab96fdbd507b4ebe568fc) Function -* [movePage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa890fee8f830a7ca7e04840962c2cece) Function -* [multiDelete](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad9dc21008ad2ddd47dfc339328d454da) Function -* [multiPageCopy](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1eca7b9ded4f6956ccfa95b11629021d) Function -* [multiPageCut](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ae2457af6aec2f86ffb328421ad2051e7) Function - -## N - -* [name](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a539d4b4f21c4c53505a6c39534fb2c3f) Variable -* [name](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1aecd9b3210d5ef87459cb8a9830bb0f94) Property -* [name](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1a5430f2b928f3f8fc672dc2dcf8c6db03) Property -* [newCustomDesignPoint](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a04f9887e54ecdb60a1f30abbdfbf975b) Function -* [newJob](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a49263a87ff0aacb9e2231bbe0e726d1a) Function -* [newModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a90ad7c497e4da5b9474d747ba6bd9715) Function -* [numDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a29af128098031d3d75f20bb0fafe633a) Property -* [numDimensions](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a3edf21f87f8614c2b603aafba6f10cd2) Property -* [numDimensions](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a8bf3f208059aad7bc8a73fd4e6529053) Property -* [numDimensions](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a757e103b1c6f7e5921adf31b7b1049ca) Property -* [numDimensions](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a7b259767761bcb4f84893a2f8baaa139) Property -* [numDimensions](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a05a8f727001f8d1794bc33960736fd18) Property -* [numDimensions](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1abaa61cb129a23c20be499a61ec4c8443) Property -* [numItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1a74bd895a7bdaa2b6786bb4dc2c4d12a1) Property -* [numRuns](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1a27982338f106af2e2b89a29c66c2d8f1) Property -* [numRuns](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1ac665a3e053e07b9bf007c5b798af743e) Property -* [numRuns](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ae5299ad977b8ef2294350733bdff6912) Property -* [numThreads](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a2b92bb066c911d4102902525a3feae5f) Property -* [numVariables](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1ae684750b56d166406294cfc78bda83b3) Property -* [numVariables](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aafb31c9ee4a9e013e3f7f77900217492) Property -* [numVariables](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a3d8795dd3559fce3f610e63872b8808b) Property - -## O - -* [OnConnectionErrorMode](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2) Enumeration type -* [onEnd](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1aa280f5643ed0afe304a3ea2556b41159) Function -* [onEnd](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a955659c71fd798c3d2be2d98a277e28d) Function -* [onEnd](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1afa9a6faf24f730938ea94ba9e846a381) Property -* [OwningComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aab060b2f29895c77882494f7194f55e0) Property -* [OwningComponent](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a22fbdf9f77a399b4c536aa78bcd826bf) Property -* [OwningComponent](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a67bcc3bdedde454663601bb945dd5bff) Property -* [OwningComponent](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa2e8150c160c33946dd92d8887b57d1f) Property -* [OwningComponent](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ad15c38a3b89a2fa2be6e2f6b88268fd2) Property -* [OwningComponent](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aa0d97988f42416ca68f47e1fecfe6e73) Property -* [OwningComponent](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a75e79199eccdfb4f00ce0d27f2f1c593) Property -* [OwningComponent](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a9c9a3532f6f0ce9a907824f5e055e89f) Property -* [OwningComponent](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a9d3e429a72048e669d3e37f814294828) Property -* [OwningComponent](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a7156a5b9cb1cd09eced27ffaacd9f521) Property -* [OwningComponent](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a2cd4745b4fe97b79d205b876bd91835d) Property -* [OwningComponent](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a4b37dc07f0e626f6b833b772d57b06a3) Property -* [OwningComponent](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a853702bf341480c261b01988dfd15513) Property -* [OwningComponent](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8c1ac6e84d73e34b12cc5e9397bb83a4) Property -* [OwningComponent](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1aedaac8e1d883db0e5d9fa4f9ccd6403f) Property -* [OwningComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a2b61c0eea38b2b20a08b75041dc20f63) Property - -## P - -* [pageCopy](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1241ff0682653a4b92dd9b6064d0bf42) Function -* [pageCut](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1925e33cfa2ae4e284cef4b8255c92dd) Function -* [pagePaste](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a08c390d4e7e3ff7f93a60283464c7826) Function -* [parallelInstance](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7dc06d52fa432893eaf74db606db3864) Function -* [ParentAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a8cccd51f677c2d7c29c734a2c1009f45) Property -* [ParentAssembly](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a2da9bef2e46c87080698e624d80710f0) Property -* [ParentAssembly](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae19efd7aa8ec8a537e3de7234b41ebde) Property -* [ParentAssembly](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a48996a90eb72b62a9dff1119708c9d42) Property -* [PHXDataExplorer.odl](PHXDataExplorer_8odl.md#PHXDataExplorer_8odl) File -* [PHXDATAEXPLORERLib](namespacePHXDATAEXPLORERLib.md#namespacePHXDATAEXPLORERLib) Namespace -* [PHXDATAEXPLORERLib::\_DPHXDataExplorer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer) Interface -* [PHXDATAEXPLORERLib::\_DPHXDataExplorerEvents](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents) Interface -* [PHXDATAEXPLORERLib::IDataExplorerFacadeOwner](interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner.md#interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner) Interface -* [PHXDATAEXPLORERLib::ILegacyVisiblity](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity) Interface -* [PHXDATAEXPLORERLib::IPageVisibility](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility) Interface -* [PHXDATAEXPLORERLib::IPHXDataExplorerPointer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer) Interface -* [PHXDATAEXPLORERLib::IPHXDEKeepalive](interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive.md#interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive) Interface -* [PHXDATAEXPLORERLib::PHXDataExplorer](classPHXDATAEXPLORERLib_1_1PHXDataExplorer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorer) Class -* [PHXDATAEXPLORERLib::PHXDataExplorerPointer](classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer) Class -* [PHXDataHistory.odl](PHXDataHistory_8odl.md#PHXDataHistory_8odl) File -* [PHXDATAHISTORYLib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib) Namespace -* [PHXDATAHISTORYLib::\_DPHXDataHistory](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory) Interface -* [PHXDATAHISTORYLib::\_DPHXDataHistoryEvents](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents) Interface -* [PHXDATAHISTORYLib::\_DPHXDataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel) Interface -* [PHXDATAHISTORYLib::DataHistoryVariableMetadata](classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata.md#classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata) Class -* [PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct) Structure -* [PHXDATAHISTORYLib::DataHistoryVariableStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct) Structure -* [PHXDATAHISTORYLib::IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) Interface -* [PHXDATAHISTORYLib::IPHXMenuItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems) Interface -* [PHXDATAHISTORYLib::ISaveContext](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext) Interface -* [PHXDATAHISTORYLib::PHXDataExplorerExportPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn) Interface -* [PHXDATAHISTORYLib::PHXDataExplorerPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) Interface -* [PHXDATAHISTORYLib::PHXDataHistory](classPHXDATAHISTORYLib_1_1PHXDataHistory.md#classPHXDATAHISTORYLib_1_1PHXDataHistory) Class -* [PHXMENU\_COPY](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaa4dd9a98729c118faa83f0c0ed3f29dbf) Enumerator -* [PHXMENU\_CUT](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaabf2c6817e4dffe7bc31ef64ab9ddcdb2) Enumerator -* [PHXMENU\_DELETE](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaa5e8804d589a5617739cf74eb4bc3920b) Enumerator -* [PHXMENU\_EXPORT](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaaed6d6e7b1fedd6b023274169374bc7d6) Enumerator -* [PHXMENU\_PAGESETTINGS](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaabf2d504b4c5e2360d5902eb2eadfb45c) Enumerator -* [PHXMENU\_PASTE](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaafa9df5b66d50b8e6ec10faff0eadfa9c) Enumerator -* [PHXMENU\_PREDEFS](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daa) Enumeration type -* [PHXMENU\_PRINT](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaa7e25b0e3c45465e3b3cdbad98b6d0f72) Enumerator -* [PHXMENU\_TOOLTIP](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaae48476ba1f1babc81be7b7db890b69c2) Enumerator -* [pin](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1afc052eba4f15b6f7a62b0b0cee7b8e4e) Function -* [PlugInMetaData](namespacePlugInMetaData.md#namespacePlugInMetaData) Namespace -* [PlugInMetaData::IPlugInMetaData](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData) Interface -* [PlugInMetaData.odl](PlugInMetaData_8odl.md#PlugInMetaData_8odl) File -* [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) Function -* [precedentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a428a6e6a2a2be52d77bfe96323fea64f) Function -* [precedentLinks](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ab5b740c028c3b878f1341efea2df0116) Function -* [precedentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a640715d1e272c8f15d8cc4c2b466d990) Function -* [precedentLinks](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a8bf056e8b989223191b2e8c7595c0753) Function -* [precedentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a998c2f1327219560aacd3d65d2c178b6) Function -* [precedentLinks](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a4bc52bbf01e5d0a0f95e67e03cce4547) Function -* [precedentLinks](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a42168bcdab0805055df8432194d5654c) Function -* [precedentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ac71c9a184e57f627b336438de0b7a238) Function -* [precedentLinks](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a02a977781b36247895725b38a725dca9) Function -* [precedentLinks](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a25a478d55d4855cdbf4f8753b6cd6062) Function -* [precedentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a084d49d02b9ff5812166721fcdc86018) Function -* [precedentLinks](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ac4f846dce2494b7c4a9b8482af321c96) Function -* [precedentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a19c1ae9d08b968bae4b6fdd1ec74fc3e) Function -* [precedentLinks](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6fcaecc0f0d1bdbd827e507ae1307fa4) Function -* [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) Function -* [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) Function -* [precedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d7349a2273e5b9eaaab5271918eed6f) Function -* [precedents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1aa43bd8ee475029fc466b20cd3b1b686d) Function -* [precedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a5973cfc6b1e41db214568a7e95979eef) Function -* [precedents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac65d0d53de6aee17106700d60161e9cf) Function -* [precedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1abf61619be1e057cf2c42189456169041) Function -* [precedents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a8db95046419c83467475175b216efe84) Function -* [precedents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a6d516295359de158c45bf2a5c0378af0) Function -* [precedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a01bd8fce84abbb243a9f7e3c771c185c) Function -* [precedents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a902fe35d10c8e25b86a64e13953a62f1) Function -* [precedents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a8c987c7df5766ca31115f25ce36f1f91) Function -* [precedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aea1973c58e45bafe3aeea797b91a4f6b) Function -* [precedents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ae2d07bb6bf73c064a1a492bb6ff2806a) Function -* [precedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a913272799193e5d02033c63c746ead9e) Function -* [precedents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a4affcdc7391a9327db4c828e54c71703) Function -* [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) Function -* [prevalidate](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a0f82cdd3e9fa556568265ef51c8bc0de) Property -* [prevalidateInputs](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac59a55cf1a42f612e494d429c3879595) Property -* [ProcessID](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acb08040260ee9e91a9a455c15d9fc0ad) Property -* [progressMeterChange](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a2f121535f7eedf77ce9e6edb9b512a51) Function -* [progressMeterEstimate](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1af43f03e636994de756db750668ac86d6) Function -* [progressMeterStart](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1aca4688267a060ab301972886d0c04d6e) Function -* [progressMeterStop](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a0fb85ceb307de0a1c2a449be77890447) Function - -## R - -* [readFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a93be7b40a50c1d8b612037a105f8fd5f) Function -* [reconnect](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a44d641cc9d4a797f88e56495c466479c) Function -* [reconnect](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a67e294fa372905721460635514adcd35) Function -* [reconnect](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a716d694026d6ef45a78ab51a8d1f6eae) Function -* [reference](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a60216339479fb364f7e97cb5d9ea0b66) Property -* [reference](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1acd5c00c533970d30757f90445ec376cd) Property -* [reference](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1abfacc6a5417c7fab810ac6e34a885657) Property -* [referencedVariable](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1abb922c879568308b8c074165d596777e) Property -* [referencedVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3ae2ecb1742ecac66cec298a6d2cd011) Property -* [referencedVariables](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad2c0541925f15b29800a9e924916615a) Property -* [referencedVariables](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a21758071b908ac4fe720dffdafe75592) Property -* [reinitialize](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a481f787db359b10b814f9ff279bb1471) Function -* [releasePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1a4349fd2038cad3cc22e04eba3d9effe5) Function -* [Remove](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1ae838217b346390c972f8173e9a55361c) Function -* [removeAddress](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations_1aa7869edab5e7d597c67804e2d5dcf561) Function -* [removeAutosave](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a222463b648be93775c026887adf9d75f) Function -* [removeComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7bbd736a48c08e2eb90c4af45872e6f5) Function -* [removeDataMonitor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2dd2279b4d0250af8ae6d3506f55c57a) Function -* [removeFromComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa30551e6356933878904d49df1239bd3) Function -* [removeItem](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a6137208858071bb7fa35bebadcbaea47) Function -* [removeLink](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ad8044ca189f473cbbf095756dd2668f9) Function -* [removeMetadata](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a7bd9389ff771d6b63aa3643c961e7223) Function -* [removePage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a75118395c50e7e2dc424d3f3eeba8fa6) Function -* [removeVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a6b191d44fea8ec432315202d094acdb0) Function -* [rename](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ac180bc4a2120cd22964998c75eed05f5) Function -* [rename](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9cae71e48e01e94d48c0353d3db4d90c) Function -* [rename](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae64ae2e0082f2379391e6a49d5e57192) Function -* [rename](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a775db6663f994e82bb2529efe6585c8d) Function -* [renameBranch](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1afddf16459949f862d3329e2d6eb79bb2) Function -* [requestAuthCredentials](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback_1a9a1b24d936f4ee5dd2979ad38538929b) Function -* [rerunRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a2d1c0808d8fcdfe748d3194c45eda87a) Function -* [restoreFile](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a90cd640253dfeb285c7c66803e61f6ac) Function -* [restoreFileStream](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ad11ce33d8317c86c335597d0e8389578) Function -* [resume](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a1bce7921ac7cedd5712423589b99afb2) Function -* [resumeLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a38ec9f0f44714dd151f7683721bd7ce8) Function -* [RHS](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a05eff77b1fab3100869de855008d8b02) Property -* [run](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1adf60ad0c84852250f14d27cfa689d8d0) Function -* [run](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1a8745a0b6d995a55b708876bcf0b6d7ab) Function -* [run](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a7891e5012feff9e7bbdec3bde6adb8e6) Function -* [run](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a158d8bbb37d23dd35bbf87b1340c95d6) Function -* [run](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1afcc83d74aabc7ddd66da4fccb708f0e9) Function -* [runAntFile](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2d684049210e4062f14cf2e3e2abb031) Function -* [runEnded](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1af1ec5576a28a72b94eca35294a49dff1) Function -* [runFailed](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint_1a7c8bc37e4f17ff29cc066d8e9645d9dd) Function -* [runInParallel](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a1e97168b7c275486400eaaf14e9a88d2) Property -* [runJobAsync](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a7cdc64aa2ca295ed608347a61e79b8ac) Function -* [runLastBranchByDefault](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6b9474faac3cad28e1a5d156438141a0) Property -* [runMacro](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a762c9d09a2d611300bc3e09f9891c86e) Function -* [runStarting](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1a05d371f3256cbd0515c1786d4ca42b46) Function - -## S - -* [SAFEARRAY](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a34d198c9ed66b975c39ed058511a3181) Function -* [SAFEARRAY](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa2ca200dd05dc8257c35af74035459e1) Function -* [SAFEARRAY](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider_1aa2d00c56cf6df0f49ed49a864e281f45) Function -* [save](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a7d30505236a3c1c3b804da8f7f924e26) Function -* [saveAllAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1afeb8dd96abface7ec4a37de262c88c85) Property -* [saveAllAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a98649448b98aa71aef4adc1e33c47570) Property -* [saveFile](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ae85020cbcdca30d63c0dc803f19b7599) Function -* [saveFileStream](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a840d41a9c874a046867c9d25c8a0d628) Function -* [saveModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a16dc53d7c16d4517b6859acc1ee25a50) Function -* [saveModelAs](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab3fcf686594e1e2f81b7814bab8a6752) Function -* [saveTemplate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a3919d10a314c536703149f6377f7f924) Function -* [saveToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a6efbbc76935609344ddfe8b48eaac5c1) Function -* [saveTradeStudy](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af139d41f66681c63c80243adbd48cbc0) Function -* [saveVersionedModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac658a0c1392f2fd8b851794c9ac1896f) Function -* [saveVersionedModelAs](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab65847c07b712a58acfe6a21659518b5) Function -* [saveWithModel](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a2ce9625b3829cc7569fee6949e227dfe) Property -* [saveWithModel](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a4ad8feb4200950e76e3ea66afcee286b) Property -* [screenUpdating](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acc9b3db9f6b75b711cf8106947576e89) Property -* [selectPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2110d97cf0636bd118ea3197ef9ba134) Function -* [selectX](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a54fca30f8b9b840cd4d130fffef89ba8) Function -* [selectY](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a82393da70a02822d7184a81430f45b94) Function -* [setAlternateParentFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a83b97e8dd461f4bc8fbe5cdc63809b74) Function -* [setArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a783239a87a41ba31461d61df639dd5f4) Function -* [setArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad252c204a64ece94a946dcdd22e569df) Function -* [setArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a89811fdbf06146c4bf0b14ea099df689) Function -* [setArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1addf446b647e3f8946e8e72825241e0d3) Function -* [setArrayMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a667cf875a43fda4c97325c3734ef9ed1) Function -* [setArrayMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1adc14eb60074b51d08f58f5f080f830b3) Function -* [setAssemblyStyle](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af1bef892aa57d153cd63b6f4ba9037f4) Function -* [setAuthor](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a0799afa68197fad61909e0a271e28993) Function -* [setAutoDelete](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a19e11dabaf88dae88622b82e9e53954a) Function -* [setBranchCondition](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1af539f83e9e44adfccbff2968cfdb3f39) Function -* [setColWidth](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ade404d7ea696919bbc331c9027315c0e) Function -* [setComponentRequirements](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a0b44c7a2dbdcac528e00911168a8ae05) Function -* [setCustomMetadata](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad106f381c9834b32c12e169264f1272a) Function -* [setCustomRun](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1ae0c7fcaf40dc9a73c3818e08fda4c954) Function -* [setDatabaseFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae38c2eeccd0c6e3c6c2e68063bd7008a) Function -* [setDataHistory](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a530e372d5d75f87574b4f5a7f8f25347) Function -* [setDescription](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a04419d1a39017fa8f13b83720fdca196) Function -* [setDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) Function -* [setDimensions](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a6a526c3b8680b1f5ececc326a340d14b) Function -* [setDimensions](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a397d1abf4ecf0a106e84112b5634efac) Function -* [setDimensions](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a791424f1645b40c0b9b9d509effb1df8) Function -* [setDimensions](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a1010ee85bb6325b98fab48f96b582103) Function -* [setDimensions](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a3526172d364bb842ab3bc25f1cedf31b) Function -* [setDimensions](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1aa3a9cdee8b632a3adda4e2d1814c66f8) Function -* [setDisplayFullNames](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a8be2f10ef4448bc73d4dc7c57f3350ca) Function -* [setDisplayUnits](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1aeac431029c07dddd0397914f6fb4d9d1) Function -* [setError](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a51fddca34fae5fbd0a5f5c858eddac26) Function -* [setExportToRemoteComponents](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1ad479e08f0fcaf6313a005c4fb3c80235) Function -* [setFileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab92bd8b81525ab620509e01219d733fe) Function -* [setFileExtension](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ab1a52e485c1d4c0384d17dca0a2f74be) Function -* [setFileFormat](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ad30b0ac3ddc36ac47b0f03662d3d4d0a) Function -* [setFileName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6824345c22985533b8e284b84e1c83f0) Function -* [setFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1aa34d6054f4542a34efb60a961ad78519) Function -* [setFormattedResult](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9d98950fdb4e2e3f07519c40580c8ae9) Function -* [setGeomViewerRunID](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af1cd6cc367767eafd9ee19b54cac0305) Function -* [setHelpURL](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1af83b75cc2e88ab4935fdbd04e094bc21) Function -* [setHighlightedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aea1fd966af29d2f3d0f7d95ac8f93ce3) Function -* [setIcon](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ad14bf669563d84f430c220a1bc1bd94c) Function -* [setIconPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a65a6502ad779fd4394d06f45adabc398) Function -* [setInitialValue](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a37b148f160421cc772d96d616cc58a67) Function -* [setInitialValue](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a34b3939cccf3f8862301863629b63434) Function -* [setInitialValue](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a61c5bac06b87725ae41b9a17f90b886b) Function -* [setInitialValue](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a4f198a32ba9ba7975e6a81f769a6df0f) Function -* [setInitialValue](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1af05313d1d5dce644dc1e0fb7217e18a0) Function -* [setInput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1abd6b3fa7a63b620f95141c191cd1c29e) Function -* [setInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a44b3d2bd5e6037197449aaa92c6fd725) Function -* [setIsBinary](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ad6f0e0cc2595b7a2726f8d38ec573e2e) Function -* [setKeywords](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a1cafe3fad847bbafcea6adc616c2f97b) Function -* [setLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) Function -* [setLength](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a2bf47781f038fae8dc22e6edb04149a9) Function -* [setLength](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a5e70599413156ef04aa8ddfd03958320) Function -* [setLength](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a66119cc8d733c8a2d6a8101569768662) Function -* [setLength](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a91d122341cefcb887c3871d43ea34524) Function -* [setLength](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2cfaecd2a821841d414f0d9ac505659f) Function -* [setLength](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ab20a6b27ddb532d0186532a52a148d91) Function -* [setLink](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a89561753d60d803cc6427c6af5005484) Function -* [setLocation](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1abb2aeef39615e67a90e950314ea02744) Function -* [setLoginCallback](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a156c716bde56ad5bc070f00e2037a2da) Function -* [setMacroScript](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae2b0614b8c0367ab7893c5fb32e14b96) Function -* [setMacroScriptLanguage](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7b92a22213e11d5f4b3ad8dfe7a894f9) Function -* [setMacroTimeout](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a559cd3b9f0e68e5ecc2c4006c8014667) Function -* [setMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6cef469cbdd030f510d7bb51e686c257) Function -* [setMemberDescription](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7f78fbf9eec449dd61dd06f9d18cbfd6) Function -* [setMemberDimensions](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a4e889147b9f6274163e2ede028fbf1b5) Function -* [setMemberEnumAliases](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a18bf5de57cd2d0343bb90267608621d8) Function -* [setMemberEnumValues](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa2399f22fd7fc4daf9687fab4e4e512a) Function -* [setMemberLength](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aec74047ec9cf7e9b93b0b4509da57f15) Function -* [setMemberLowerBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1af9965da5833253a2234df86f677093) Function -* [setMemberProperty](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a15c71dd9da7797408006e31677e9901f) Function -* [setMemberUnits](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a033310bf93afceacc24f097ce738a135) Function -* [setMemberUpperBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac86c323427541c659a79974e19ad2692) Function -* [setMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a44df8b08cf7cb9cf6d1a5b72136d5f52) Function -* [setMenuItem](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1aa76ac2aefb1a69021d5f536db66c0c4b) Function -* [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) Function -* [setMetadata](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1aa1e66114f498d0a1238237ad6caa1348) Function -* [setMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a772ffc624a737a4808eb8dfc9ff41e0d) Function -* [setMetadata](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a6771c11a9e1388bc4da11b9fae91e2e8) Function -* [setMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a41eb816b08e0e89739822ba87e5416c6) Function -* [setMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a56d1d2b85ec3b4c43589c25887c1dd95) Function -* [setMetadata](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a499a962844cae63886b79779e39db700) Function -* [setMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a46a06089e51539cdb69a6404db042d28) Function -* [setMetadata](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ad532913f25d0b0d02cc2c27105e7ecc8) Function -* [setMetadata](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a3c257357cc786dc18d4187d14b030813) Function -* [setMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae69f586d5f6a7cf93728f99a47b841cf) Function -* [setMetadata](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ad80d2a2e770297e5e57af0cd86601f83) Function -* [setMetadata](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1d611e44da36abed0a41c6f688344841) Function -* [setMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a31e14e94dd9316f40bf963a9da9939f7) Function -* [setMetadata](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1afee8a9cb2ea3d6728cacba4aeaa9ff7a) Function -* [setMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a495551c5a05027a8537ffce75f333f8e) Function -* [setMetadata](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ac5062f1a9bcf780f891c6abeb0bcb391) Function -* [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) Function -* [setMetaData](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a9479fcb9ffceb4360b99be62d77eabad) Function -* [setModelCenter](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a38e366a60626a29afa74869e40f156c6) Function -* [setName](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1afbfd0ce277fb01a5539d791b371ab0de) Function -* [setNumExpectedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a8ee93fde7260e85a34331b2c32a1289c) Function -* [setNumExpectedRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a2760890872ed478c72439fc063f4e9aa) Function -* [setNumRuns](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a89e662a1a1c15ed27f8517b5a526b94d) Function -* [setNumThreads](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a034974bf844d74af316ef687be4b84f7) Function -* [setPassword](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a677e2965bfb8998dc4546673f95355de) Function -* [setPreference](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac7c886a8b0333b565333d6b16d9ab824) Function -* [setRefPropValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a93e2bd4cf0f592ca8ec2a626fbd57432) Function -* [setRefPropValue](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1af41e2e8abdbc5959543416e21bc73793) Function -* [setResult](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9260828e57d6cee2ec51e26dcef48ea7) Function -* [setResultAsFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a8fe368442becfe48a2642b16d9a73e3c) Function -* [setRunInParallel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a660d28f5c25a2efbe370cb162bc58f4e) Function -* [setRunInputs](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a2d73e6a448ba816d2f4025d5f95b285e) Function -* [setRunName](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1adff96af9fbbb349cd4d0d69aab8a1b43) Function -* [setRunOnlyMode](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aba91dde2a4c0674816c3781ed873457e) Function -* [setRunValues](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aa6fcc8d517001f5b1e1c2b4cb9d6a95c) Function -* [setScheduler](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa312b4e6e4585bd0f4d7cc9a69d1d7ec) Function -* [setShortVariableNames](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae53e12cca23a7988b0d8c7dfdbe14308) Function -* [setSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b7b41ca5463a86aecb2368d73464c0e) Function -* [setSize](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ad76100b2b7c20def871a1ffdc745e5da) Function -* [setSourceFromFile](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aa34064721143d9012bfe5c0c899415a8) Function -* [setSourceFromString](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ab41aea5c06252f82fc831ea6af40e1b1) Function -* [setStartContext](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ab7f82a38962d77ab437299dd6cbe50a1) Function -* [setTitle](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a74456073f4bc7e13d954972991583b58) Function -* [setTradeStudySetup](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1acfc1654be0cc6fbe5469b487f9576bb9) Function -* [setTradeStudyType](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a7e9c912ffb74926c67437bf50b8b944f) Function -* [setUniqueID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1adc572aab955548292d15997e1b519434) Function -* [setupPlotsPost](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2f726b811f8e11e39612bfd8b082ef68) Function -* [setupPlotsPre](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a21238a932694565dbf0e2115c80ae59b) Function -* [setUserName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a359b38b4b8bc935b9eb5cf9e68a3a34f) Function -* [setUsernamePassword](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab6b36fde7ab38b09357add72dcbaf225) Function -* [setValidateAll](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1aefca61419c9622f520429f257aa6061c) Function -* [setValue](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa3bdaab478a67db1dd4cb7921de5ed72) Function -* [setValue](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1acbaaac83aab3ce3951ed1be15ad3f6ca) Function -* [setValue](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a18caa8754a18f914632f71675d6821dd) Function -* [setValue](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a535535c056577a2306bfd089423a6e8b) Function -* [setValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a8ef388f09dd24fd704b46a7446016951) Function -* [setValue](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a34205a2be0ffe6695721d957cd90f963) Function -* [setVariableInputs](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a5f77ca1741019e90b1d348a7b4c20b04) Function -* [setVariables](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a03a16eed6dbd98df2286d42f3a47db56) Function -* [setVariableValues](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aff837e76c92ab15ac33eebfe3f348c99) Function -* [setVersion](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a13e4e0a07dfd282fa44afcb16c06aac8) Function -* [setXMLExtension](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a70666088b3363b2c9738cd15ec446d8e) Function -* [show](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad1f82e4921ee4c4db89b43fe92bf171d) Function -* [show](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aa35c0fb45f677b3c2daf475e53107773) Function -* [show](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1adeb4964522dc6e485c3de4bef39a9019) Function -* [show](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a2dcb6077094c93a8484123a0c5633dae) Function -* [show](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a344fe33286c0d548dfb35b472cfcc1d6) Function -* [show](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1a0e233fef605747c79f16a6032e4ebd01) Function -* [show](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ad7d6f94d38270f36b80ed3c0109312dd) Function -* [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a7238385b054e9afddbe65c65644826e4) Function -* [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a81aebef74679c6364f184219c22da93a) Function -* [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1ac84a2866cfcedd306eeabd757d8c0877) Property -* [show](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1ae8ccfc592c21eb6adffad9502e4b28fb) Function -* [showAt](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a69bf3249d5ef44ef0eee2152724f9457) Function -* [showFileBrowseDialog](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a9dabff9569cfbb6c65ccdae26aab3ff7) Function -* [showFileSaveDialog](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a23ea9bc699e8f31401f96d2594f79ae6) Function -* [showGeomTooltip](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a89fb0170b61fdd2e320c52a8b370e99c) Function -* [showGeomViewer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a7d467a6fb859b8cb7f63c04f84f75dfa) Function -* [ShowHelp](interfaceModelCenter_1_1IShowHelpEvents.md#interfaceModelCenter_1_1IShowHelpEvents_1a9e94376ebaa4b126ce37c5c541e8f5cb) Function -* [showLegacy](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity_1af5b6718a60c0ac08286e7ae40df8332a) Function -* [showPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad1fc33915ad5917cd645e795251f01de) Function -* [size](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a9a38726b51caed75a30ae66b82959f64) Property -* [size](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ada4924e975e5e04d2c6f7104f2626212) Property -* [size](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aeb3ca2a904ddc619edad7828c6c4492f) Property -* [size](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aed6f1989cc53493063439e96852be675) Property -* [size](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a49fc48bf1f28f403f2b96b92fb8e5819) Property -* [size](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a0ec169188c7e660a32e9a3bc6792d26f) Property -* [size](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4164bff5f32408083a55fc9a327ebc66) Property -* [startGUIMode](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a06c77786a3965c9ca7c72c6ba7af7ad3) Function -* [startRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a74028f784809522e15bf71133d8fd23c) Function -* [startRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a4c2a3c1d083373801689d9dacc1fd530) Function -* [StartToolRun](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1a4bd376f4406023fdb8c562c3e530e32c) Function -* [state](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1ace7a19354a1c40a3f64464fb87b992ba) Property -* [storeCurrentDesignPoint](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aed3d0ea61e181d39e6bbf38a5ad0a401) Function -* [storeCustomDesignPoint](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a0beef1e5e859c093f079e64792e9ed8e) Function -* [stringToDouble](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a2576f20eaa4ec6133a734ea09d86130a) Function -* [stringToLong](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a9e0774cef531d24731ac6c320cfd837c) Function -* [stringToString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1ac1b65cffaf6712d53e58935e3c1592c9) Function -* [submit](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad1b204f5e684c57b28dc1e3dc733e285) Function -* [suggestedCountFrom](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a07162878a7dcf1c2a6ea41a56c9ddb6b) Property -* [suggestedDependentVars](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae1e8705d32948c759d3ab3e59bf6306b) Property -* [suggestedIndependantVar](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3b5732bdccab13e2a7ed55c852d4c55b) Property -* [suggestedIndependentVar](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a1713976f65a0fdc2d37e9606bbc8672b) Property -* [supportsParallelExecution](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1afc7560080c238a34ac8d339d80175327) Property -* [suspendLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a8a637411378f91597e5612e2e03c959d) Function - -## T - -* [timeout](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a3a0d87f35ccd9845a8dc70e1ccf531eb) Property -* [title](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1aaa7d8507dbf83d2cad6eea2266fa98fb) Property -* [title](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1ad9f9fdbe48e40c42f7d80eb57b072ae7) Property -* [toCSV](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ada3b86a293b267a74999e35c70fea775) Function -* [toCSVFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a582bd6a4ad61e03070dcde9e4df76812) Function -* [toFile](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a21c5941a7054482e4f7fd13e55db2738) Function -* [toFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa3da8eb730cd02ed21080272cc41deb5) Function -* [toFile](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6bd774581876d61cdeaf9637e470b0fe) Function -* [toFileAbsolute](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a118321f9f4f870bd9ec196813546b6f3) Function -* [toFileAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a45afd477c357c9c3002a4046c1eefd32) Function -* [toFileAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a4904889be1812816c742b23763d0229e) Function -* [toFormattedString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1fb28d4b74c3d0121725f15773f7d1bb) Function -* [toFormattedString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abf09981270a02adab12c6bd420e07a22) Function -* [toFormattedStringAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac4e47bfae3990e33c748b44580244be3) Function -* [toFormattedStringAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a7c3ea8978f890824c3e08134c7bf7747) Function -* [toFormattedStringAbsoluteEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ac4c96b591adc0b61b3db5eaa90c3b3cd) Function -* [toFormattedStringAbsoluteEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a7a0ff2e8e1875ee5465deadb6496b81c) Function -* [toFormattedStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aac1d778fd393456a7097eb9f6ac40daa) Function -* [toFormattedStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a895cc520f94cb105b922380b105f448d) Function -* [ToolClosed](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1aceebb769e27511c9b87462b8fa9ef16f) Function -* [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) Function -* [toString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a39294beb6d830e498ee8aca7a25cc4a6) Function -* [toString](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a97263640728fae5de92a272345ce0a01) Function -* [toString](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1a14fe2c260d7d43a7f6d1cf661a34189d) Function -* [toString](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1af9938e6a1943072ae9e89a19e4461a3f) Function -* [toString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1af417ef0e71fabce8379be30e4d176355) Function -* [toString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a59f1d75b8e24323ea9bf523159f04f69) Function -* [toString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7ba909789490822b7ab12891075a9e56) Function -* [toString](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ae28a776965df5807d9ce8b2e0d995867) Function -* [toString](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a0bda0cd0ea97014dc4be4ee2af69e55c) Function -* [toString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a83e5e9905df758b37c901bae5e87430e) Function -* [toString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a2ec6bbef037c4c0a6ab5e510f9063923) Function -* [toString](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acc675e2c9045387d4ceb956d7d7d9f70) Function -* [toString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aaa37debc6216a5419715e0c542555850) Function -* [toString](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a6675d6a6451c20b11b43ad594af28bcc) Function -* [toString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1aa735025db3ac6e13cb486f8629b86a69) Function -* [toString](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a46f43be460cbd0d90493a6f9f26eb65d) Function -* [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a58cdb46e4e8dca27761d7bd976c8fcf2) Function -* [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1aaff0d58b0b3d2d90566fae1277ea4a45) Function -* [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a3f6d767abcf9b50ee14ac7be20ef964a) Property -* [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) Function -* [toString](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a075c34c41b0461b36077d19c314fdc2a) Function -* [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) Function -* [toStringAbsolute](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa07f73fa1f449045d77725b0fef00739) Function -* [toStringAbsolute](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ad3fdc29d883580eaf57b83a7b796c703) Function -* [toStringAbsolute](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1adbd82fbad4622d8c2d91533d536a7ea0) Function -* [toStringAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a89797e61eedee333bd67b55b653ec21f) Function -* [toStringAbsolute](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ac8f43fca8b974b224bd64a78bd3bdda3) Function -* [toStringAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a0dda099769e13bdd8c5c076fc7d9378a) Function -* [toStringAbsolute](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a711f2c70a30362b587b39f5cd3775f71) Function -* [toStringAbsolute](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5bc139ce096dbc917734386869a3be78) Function -* [toStringAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac13b9c8e85a30831a81cedcdca610e01) Function -* [toStringAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af042cdd3c4908daa767f6b0dce043e75) Function -* [toStringAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a1a0ecbbccb3fe3404c79976e9f07b8db) Function -* [toStringAbsolute](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a510fd4577f2a29cf0fef6d1c8fe43c94) Function -* [toStringAbsolute](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1adfb1dee0a1fd5b541eacba1e4cbba7ad) Function -* [toStringAbsolute](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ae9ed673188c2c46e2c3883cdd65b3af5) Function -* [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) Function -* [toStringAbsoluteEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a2e3041440581aab716c684fe88d2ee87) Function -* [toStringAbsoluteEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aaa425c05112e2f9568bb13886800dbba) Function -* [toStringAbsoluteEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab1252981582cec6fd3662321c9c4ce28) Function -* [toStringAbsoluteEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a15dfd2825b183a80b93d849ce3429ca3) Function -* [toStringAbsoluteEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5794b0c172b46da36d761bf31046db07) Function -* [toStringAbsoluteEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aac2b33985ad310362db7c8c878096ae8) Function -* [toStringAbsoluteEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a3684e3b0b2d36a599f75236a6f5e90e7) Function -* [toStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a37c622ae9f50579f714ce98c0379cd98) Function -* [toStringEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1af151b1686dbe379f876131afd8c2c71e) Function -* [toStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ac16f0cbbb0d4c51cb5cc7dfc0c251f88) Function -* [toStringEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1afac8b4ceedd459ad68bed98ae18ea6a8) Function -* [toStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae3d6633e9533a68590025dee14298912) Function -* [toStringEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1af2ff697565c81552d49c0237cfc89ef7) Function -* [toStringEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a9013b29e3ca18c5a0ecaff8dc6d19b5f) Function -* [toXML](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1afc2dbe6d642993070f320d76f0b1f6b6) Function -* [toXML](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac6e672dc87278a4037bbf085b76f6aa4) Function -* [toXML](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a9e16b89241b7593088803ace922f5ced) Function -* [toXMLFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a889efcee9f2e90cf7de94b3d521f4cdd) Function -* [toXMLFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a7d11e224b1eaac4fab085ed9fa3d183b) Function -* [toXMLSaveContext](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a9ce95b6c36069c784ea2389d85dde7ec) Function -* [toXMLSaveContext](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a21df6ed38dc18c8cc9054f40f1f9daaf) Function -* [trace](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a97945d07f653d3cb3e483b512f7c569d) Function -* [TradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ad9db0e1ec3dee4b67da4fd2bd197f497) Property -* [TradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a781692e887426951e2913672d9f94a78) Property -* [tradeStudyClosed](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1a9434138abbfd489946e6657ce904dcac) Function -* [tradeStudyEnd](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a85f4a4b6557102133fc5dad3ef0a1ff8) Function -* [TradeStudyFormat](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dca) Enumeration type -* [tradeStudyModelFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aeecce56460ab6c1c203c9d56433f4371) Property -* [TradeStudyPlugIn](namespaceTradeStudyPlugIn.md#namespaceTradeStudyPlugIn) Namespace -* [TradeStudyPlugIn::ICombinedPlugIn](interfaceTradeStudyPlugIn_1_1ICombinedPlugIn.md#interfaceTradeStudyPlugIn_1_1ICombinedPlugIn) Interface -* [TradeStudyPlugIn::ITradeStudy3JobInfo](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo) Interface -* [TradeStudyPlugIn::ITradeStudy3JobManager](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager) Interface -* [TradeStudyPlugIn::ITradeStudy3JobResult](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult) Interface -* [TradeStudyPlugIn::ITradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback) Interface -* [TradeStudyPlugIn::ITradeStudyPlugIn](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn) Interface -* [TradeStudyPlugIn::ITradeStudyPlugIn2](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2) Interface -* [TradeStudyPlugIn::ITradeStudyPlugIn3](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3) Interface -* [TradeStudyPlugIn::IVariableMetaDataProvider](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider) Interface -* [TradeStudyPlugIn::IWindowed](interfaceTradeStudyPlugIn_1_1IWindowed.md#interfaceTradeStudyPlugIn_1_1IWindowed) Interface -* [TradeStudyPlugIn::TradeStudyPlugIn](classTradeStudyPlugIn_1_1TradeStudyPlugIn.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn) Class -* [TradeStudyPlugIn::TradeStudyPlugIn2](classTradeStudyPlugIn_1_1TradeStudyPlugIn2.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn2) Class -* [TradeStudyPlugIn.odl](TradeStudyPlugIn_8odl.md#TradeStudyPlugIn_8odl) File -* [tradeStudyStart](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a39de949b1cdace01114ee9391fc4a484) Function -* [tradeStudyUri](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aefa05eb2c41402bebce7e388d06d08e8) Property -* [transformAVPoint](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a23a3683a4c5b5f4380e33232e2ca30be) Function -* [TS\_FORMAT\_PXT\_COMPRESSED](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaac387037adbfc62827fa1523fc69a1278) Enumerator -* [TS\_FORMAT\_PXT\_UNCOMPRESSED](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaaeead4e562c092545f613d220eb2df08e) Enumerator -* [TS\_FORMAT\_PXTZ](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaac6d6ad08981541727efbbf8c181674cf) Enumerator -* [TS\_FORMAT\_TSTUDY](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaa3332e2d8a655365e5c1fee1d8f1fa436) Enumerator -* [type](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1ab613172a10fa02c2756813e75944536a) Variable -* [type](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ad46181f350249f42a737877eb3ce6c97) Property -* [type](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1a8fc783420e2ab3163a2552436d694d0a) Property - -## U - -* [unAssociatedInstance](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a21a60528e3b43cbbbbc131adaf5a1151) Function -* [units](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a48e1dedfd188d030f71a196434ebaf3b) Variable -* [units](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1aff5fbd1ebbbe6b3d4bd7ce114a09f40e) Property -* [units](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ae91fd63ce08d3af74fb22132b5626432) Property -* [units](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ad5b4b178eafbe9ebf4e55b3f5e158622) Property -* [units](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1afe8daf819657e592587af96079b0a0a9) Property -* [units](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a3752ce74846eb04caed29711d1da302d) Property -* [units](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1abea210199b644bc3da685775950b9368) Property -* [updateComparisonViewHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad687c055e59a0bb50aac411174fa9a70) Function -* [updateComponent](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a7f5a3a1914714827435dfd59e9be5e32) Function -* [updateGeomViewerHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab9e6e926290d9a829d5e90b17911fb22) Function -* [updateHint](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a6394212eddc67589ac43fbd85826bbc2) Function -* [updateThumbHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1adda950ce0660029538ab7bdb541c6f2c) Function -* [upperBound](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1aeda7394339c56c5493cfad15d26b0b3e) Variable -* [upperBound](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5e7eff43bb2a4ca6eed5cd8e95b0e182) Property -* [upperBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad4a4c720baa19775898e45381b881fcd) Property -* [upperBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a7585c786507e272216ec790ce278fd10) Property -* [upperBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a1a062cc1750c92e8db32de2b53d83e9a) Property -* [upperBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abc988cc945fcc8e2cf905c885a180542) Property -* [url](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1addbccbd60da206c6fb480eb4fe05e967) Property -* [Url](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1a8dcb7034aa38f98bae308f4a9425ee43) Property -* [userData](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1af405572d6c2bafc56164b2ce5b97b1a3) Property -* [userData](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1ae7e1acce8fef11c88ba939aba11604ee) Property -* [userData](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6590d1a787dc12285407656bfc22cbd7) Property -* [userData](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ade9f3ed3c58d1f3eb9914c3a395eb7a6) Property - -## V - -* [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) Function -* [validate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa221cef15629c5acf569329c0e089b3a) Function -* [validate](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ae3cb5f6c787efb879f5d85a5ee5ee344) Function -* [validate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1abc755512c485531a61f10d2bc5d691b0) Function -* [validate](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1abddc8770d26e37ac9319be5b90bc6e3e) Function -* [validate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a506a66d66cb52b49d7385351bf0cfa46) Function -* [validate](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa3fdf5883f1849f93bf87256b9100d0b) Function -* [validate](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a62715d2cd23f7a7daafe7568d1a6e32d) Function -* [validate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a84ab133f5b1147d475fb8e2c4275b32b) Function -* [validate](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a2807c2dd1e70fe7d8eab0af0a64e2d74) Function -* [validate](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a56e476d33f05ee8b4faa077396704fa6) Function -* [validate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1af1dd28c351fcda3e3fea31facbd4fca3) Function -* [validate](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a16aec4b64f98c5dfb3f66c497691e447) Function -* [validate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a86b82bcfb1ccfa2428968307eaa07108) Function -* [validate](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a7bddbd595f981680f8eb062d950f20d7) Function -* [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) Function -* [validateAll](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a913715f9bb137763d7b099cfe8bd9b57) Property -* [value](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aafaaa11ebda98ac168f489abd5385422) Property -* [value](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a71678d5b3009123d0401d7715c5dcdf6) Property -* [value](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a025854ed57fb252dde2b341182cd7e7a) Property -* [value](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab6fd11161c6f26426d3205c88025a962) Property -* [value](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aceacfa8c1f90207042abb68d4175679d) Property -* [value](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1aa7a7d4145814425b6ea93e831854d84c) Property -* [value](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a5b7408868a080c3d2b0b6812dc13a536) Property -* [value](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1af89ea57b9feb5597f3e190af1c8b5bf9) Property -* [value](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a44a74adf54ce33e5e11d52ff561b37ad) Property -* [value](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ae013f10c0800acb5229f245f10d687f3) Property -* [value](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1aa7b9346ccbe5c4088c45e09ffb8b7d02) Property -* [value](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a2b4b654f1094bfd632e383909ea37bad) Property -* [value](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a8626c616deb64d587178b6c1cbdc2974) Property -* [value](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a778d71ffd4daf5160b2594672b0cb7c8) Property -* [value](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad9e0cf09c5c40b6272808d3ba83489ba) Property -* [value](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a902f599bd7fe0bed1c5f1f51a49e291e) Property -* [value](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a2e307144f16d81645b5ce2cc30b01ae3) Property -* [value](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ae449bcebd78b7ec3fe365cd8fbd3dac7) Property -* [value](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1afd9e0eaba3274e5802f25fe40f039c16) Property -* [value](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ab56992c6033247f7a5c262e63e728467) Property -* [valueAbsolute](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a875503e8827a33a2d15497b21c50b840) Property -* [valueAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a364aa148101fa8ea9ddc2d624f96fcf5) Property -* [valueAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a5e2a2a61e1c4978200a2009c1f6ab74c) Property -* [valueAbsolute](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1abe143a72a2b1f663e41bf0af0118d5db) Property -* [Variables](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a88d34960f336b71cc7f4beff3b4bbaba) Property -* [Variables](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aad57025fe620abbaae1543962ed2676c) Property -* [Variables](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1a6e92dee614068ff99c03164e7305119a) Property -* [Variables](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a377c50131d329f7fe0e1508bafff61dc) Property -* [Variables](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a54219eed78fa8eed485e8da974458ea1) Property -* [variablesChanged](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a9a2402c1679d7707f2f274399276107d) Function -* [varValue](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a44619a37f14a5ff181483dcf993d1424) Variable -* [verifySslWarning](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback_1a9c27b392b3c109f6abe689251e1e27c7) Function -* [version](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3072c85db32956a1c302668a49b031f8) Property -* [VersionStatus](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0) Enumeration type -* [Visible](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a4e7368bd0265ae9a637cfd675b5bd264) Property - -## W - -* [waitForCompletion](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ad76c0b31771a31a827235d0306529ebc) Function -* [waitForJobCompletion](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a65bfecf019c1e9c8752fa3c90fd5d3a7) Function -* [warmStartStudyComplete](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac68974459907dcaf6b35ea631bba2801) Property -* [warn](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1acf5456282ad4295bfbb5dc3d6c41b8b2) Function -* [wasHalted](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a103d78a1bad75512c13080d2467fb11e) Property -* [writeFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac5ccf89eeca381ed315bbc4080c5df6b) Function -* [writeFileAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ae4220f9f0731a8078169bab709fb9198) Function - -## _ - +# Index + +## A + +* [add](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations_1a86769591b49fd0bf2ce90bfd45c24bdf) Function +* [addAnalyzerVariable](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a614a39c2d8dd38f47d840aa6d5bb34f2) Function +* [addAnalyzerVariable](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a9e044579568a49b3f42c8771ccf8bbc3) Property +* [addAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a1a55454ec16eadd67d23a8e134fccce7) Function +* [addAssembly2](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a1c73a3675ee4a70e9b31d2f63c86e630) Function +* [addCheckpoint](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9e6d72c9c2f589323e745f69426aaefb) Function +* [addCustom](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1acd3adc12cd4f94a2dbf436e8617cbf8a) Function +* [addIcon](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ada4b443f077f7c53744ada601a3c12be) Function +* [addInput](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a62816c713535ea573159c78f709aa04e) Function +* [addInput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ab95c6155dd1c2dbd24441bf3641a5542) Function +* [addInput2](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a915f8989fd54300d4ce830d37c2682bf) Function +* [addItem](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a4b0569ecb495f20688d98060df763895) Function +* [addMethod](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a1ef6ce942ff5def3c8faa1c4d6d52106) Function +* [addNewMacro](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a9d209b30adb83ac9fe48f8efd1959f3a) Function +* [addOutput](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a073c5f4a93c492f05fe361ca1799974e) Function +* [addOutput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a4591b4c0b98d14307aa691f42547c97e) Function +* [addOutput2](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a34633d249d8fd7b02a28c3158c6dbae6) Function +* [addPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af65679f9d81fa741896f22fb959f81d1) Function +* [addRerun](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a3e06470a8599a950a01c275f75c0d6cb) Function +* [addRunsToComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a7e608fa73c8645388956a6c1538438af) Function +* [addToComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2b46272c7cead32a5f75319eecddbc87) Function +* [addToModel](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a58f5f3bc676a7c683ea4fc9b531d608f) Function +* [addToModel2](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ab0bc1abd000532d2d89d6179868431fc) Function +* [addToModel3](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac2d1861e463ef89757948bb091502dbb) Function +* [addUnlinkedItem](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a8b2b470a890a2177bc1028408c7275e6) Function +* [addVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9a819127adb7f83be0acfa4e79f4643d) Function +* [addVariable](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1af05ab7c452794c56cc54d77113cefdea) Function +* [addVariable](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint_1a3c20c3bc3fa7ae5fb36154448d3ae13d) Function +* [addVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a04bbcea36b9bb694385e8620fa0a6b11) Function +* [addVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a44f6cc3111c89abd357dfcfeed23cf4a) Function +* [addVariableAt](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a156c9828bc7c8251e68886297349ccab) Function +* [addVariableStructs](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9bf37e7831e0c32cfe17225f019c9cc4) Function +* [appFullPath](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a999bedcb3195dc2a12b034e0fa0222ec) Property +* [appName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a1a5d90dca23414ddb8ef45e99c091ea4) Property +* [Assemblies](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a00afe3dedbc3bb8b8a1cbdf5bd6333a1) Property +* [ASSEMBLY\_STYLE\_AUTO\_N\_SQUARED](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625a53d3ac52946f367fea3960b418f30626) Enumerator +* [ASSEMBLY\_STYLE\_CLASSIC](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625a853070b6a8d1299e8d9e7f846a1f2e69) Enumerator +* [ASSEMBLY\_STYLE\_COLLAPSED](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625a6b01dbb284343f3c49f9ac2318be4aa3) Enumerator +* [ASSEMBLY\_STYLE\_EXPANDED](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625ae5a9a245bacc433385a01acb31722bf8) Enumerator +* [ASSEMBLY\_STYLE\_FORCE\_32\_BITS](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625ae20fa83961bd74d6133ceec0849d4c1c) Enumerator +* [ASSEMBLY\_STYLE\_N\_SQUARED](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625af225405c171ad35d8e7caad44414d736) Enumerator +* [AssemblyStyle](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625) Enumeration type +* [AssemblyType](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a12692b24f7c9fceec97847b204afecc4) Property +* [AssociatedFiles](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aecece7b57424f027ba567415051d3bb5) Property +* [AssociatedFiles](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1afeeaebcaeafab038e2cc613078182c6e) Property +* [AssociatedFiles](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a42162de74b1b046b277b927ace2dd403) Property +* [associatedModelFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a145b2ba8b5de9c0bac5b0ac89ad7f960) Property +* [associatedModelFileUUID](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad91c318a844622c7673df74c0f92128b) Property +* [author](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a8acab1f7a5d2caa0ab47d0d74247497e) Property +* [autoGrow](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a74f194b29d46aacb12b7d4c445df729b) Property +* [autoLink](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1adea9c027f61fb0c23ce34a0e47924679) Function +* [autoRun](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1aa714911e950223667ee525a435b00b7a) Property +* [autoSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aca63a47369d69cbbf53532286b64a611) Property + +## B + +* [baseName](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a0f840f7244ed0a52fa4d7c2a19a08264) Property +* [breakLink](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a231cd11fa3198cc4a22db3ee0483b59c) Function +* [breakLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a0e2397280fb0a53c07ecee27bdff89bd) Function + +## C + +* [callMethod](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ab1c0d770f00a0c466eacecda838b3850) Function +* [cancelAsync](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1aa5d136ea9f5d9dce819e2c6414f1febe) Function +* [canNewJob](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a0736cdac1a4c8573ec1332477849458b) Property +* [canRerunRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a080673db51fe153fd870e46b9dd4f221) Function +* [canSaveToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a3123522cb86b3daa95c56f60b99a4f9e) Function +* [centerLinkJobConnector](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1af8f87624e919e067935bb5403261b63f) Property +* [centerLinkQueue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aac2a1a4d2bc65319ac7e94f0f20368b1) Property +* [centerLinkRunMatrixID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a61514463a5c0f82163d4789cd9e60f8a) Property +* [centerLinkServer](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a226709acf22397c41215acd7f0ab0605) Property +* [checkin](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature_1a8cb220ceb67de96c199d761396bff884) Function +* [checkinOnFlush](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1af839cced75ed11439b0027a55c6ab604) Function +* [checkout](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5ea6a58aa4def0e7d48f5c48dfc46d35) Function +* [checkout2](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3b8e21abd2354b4fd537084f36c9a180) Function +* [clear](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aeb34f0cf410ef02f4eee10d611b4a740) Function +* [clearAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ae184db6af8802c77918103c4bf0f0564) Function +* [clearAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a1a94e6d8431bf19dee3fcf446e781070) Property +* [clearBusyFlag](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1aa73cb2b559ec21ef817b241e7f943e8a) Function +* [clearCache](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a06a3f847d50eb2f10e3b061ea91b453b) Function +* [clearLowerBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab93c1d5caa0fb18eb4d41499f5c708b7) Function +* [clearLowerBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a72ee20ae45907f6f6738dbba0ea63655) Function +* [clearLowerBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ab51bcc939e91ef1da288c78be99a7fcc) Function +* [clearLowerBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a16f466aa207ea88961361ee69a683850) Function +* [clearUpperBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa1657e3679484a86e997a20256eef5b1) Function +* [clearUpperBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1aa8846eb2c93d138bf7b6c31d78f0dc56) Function +* [clearUpperBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1aa3f1505493e089a8717c092e37927600) Function +* [clearUpperBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aba1030008767dd31ae13f40f90ba58d8) Function +* [close](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a314e254f112778f1bb9839e157fcc532) Function +* [closeDataHistory](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a9ead478fc2486a3ac01b73ee8b3962be) Function +* [closeHTMLViewer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a46b4e01256fa252da2f589af87833ac1) Function +* [closeModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a00bcefae609c5a453dd1f4e0586820fc) Function +* [closeWindow](interfaceTradeStudyPlugIn_1_1IWindowed.md#interfaceTradeStudyPlugIn_1_1IWindowed_1af9dab02ffb5223028fae48563bbab27b) Function +* [ComponentPlugIn](namespaceComponentPlugIn.md#namespaceComponentPlugIn) Namespace +* [ComponentPlugIn::IComponentPlugIn](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn) Interface +* [ComponentPlugIn.odl](ComponentPlugIn_8odl.md#ComponentPlugIn_8odl) File +* [Components](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ad4c0ef9792a2f760b3639357126e56f6) Property +* [configureLogging](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acb8cad870e072bee4a80b1902476929a) Function +* [CONN\_ERR\_ERROR](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2a32466c6ffbbfd1d8cae3f96e7565e049) Enumerator +* [CONN\_ERR\_IGNORE](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2aa1a76a2bf1e5b53785d9e1c8389b9369) Enumerator +* [CONN\_ERR\_USEDIALOG](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2a4e520a601326fcb3e1324c9a950a541d) Enumerator +* [construct](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1ace85f5a1c843051fe7513c591c373164) Function +* [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a2b883bd3725cefb35daf8b629124a57f) Function +* [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ad233e5489d31c81b6b1fe09d9a3a886e) Function +* [convertToSubmodel](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1afc8d8acd50c53726272ce0c983aa640f) Function +* [copyFrom](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ae9e54933d6dd82e4d4aa5991b58b6ee3) Function +* [count](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1a53be79855251a6bd40bd71f35c4f6d8d) Property +* [Count](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies_1aee7be5ec0b95eaea973eb669981b4804) Property +* [Count](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents_1a657951d45a2e5d44a882ecc04e4abbae) Property +* [Count](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups_1a3bbbf56f26f76f5f051ea065aaf00234) Property +* [Count](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks_1a65d1ab625bcdab41639028c42f712b26) Property +* [Count](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables_1a5805886fd173e6fc77a3387d5f1c6b95) Property +* [createAndInitComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a049e13b6d3ba54dd40a162a16d03bb66) Function +* [createAssembly](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a402db0953a58ac7573cf3585c938eafa) Function +* [createAssemblyVariable](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a72e28e9146e37b0854aaa3274b60362c) Function +* [createComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa1c2ba41e8aeff2bc97408fd6d5e8832) Function +* [createDataCollector](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad91dff33c09345053346ce2d831fd968) Function +* [createDataExplorer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3edba311337bb171b956e0d331cfa05f) Function +* [createDataHistoryVariable](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5f2d90be1a4bed0126993b3021d24981) Function +* [createDataMonitor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad86e8cd5714f0d22dc84b1b71979fdc5) Function +* [createDesignVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1adb61a037918e5f45dfc6a43541023970) Function +* [createEmptyRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1ab152e50d67d452b3f301ea18f732183d) Function +* [createJobManager](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5878e18adeeafe78c1920e5544253442) Function +* [createLink](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac46503f8f560edbcddd87fb9c9045326) Function +* [createPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1afb0f2d3715e4a48c1ee1c865864c5314) Function +* [createPlugInFrame2](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acd338a67839da36df138a0521ee3aead) Function +* [createRefProp](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9e2914c70c8c77002c0dbc502cdfa056) Function +* [createRefProp](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0063ff442e879a9ca2986bc63eb9adc7) Function +* [createTradeStudy](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab18e9a5fa259695357cd26f155ee95dd) Function +* [createVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a68acd508b225f5c74c27daf848f3ae27) Function +* [creationDate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a4e0ab1e84c6e9f6ddd62ec774c75f42c) Property +* [customMetadata](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a5e4dfb223db7287d798efb5b8078a3e2) Variable + +## D + +* [dataChanged](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1aa6f5dbeba5082e060cb68696cd07d44f) Function +* [dataCollectorCreated](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1a21e1253a708b1e6177c5998ad7583c59) Function +* [dataHistory](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aec4a15702e1f9565f7564914cfef534a) Property +* [dataHistory](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a5889d5d7712934aa30c0983452c875bb) Property +* [dataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a4c0b3167dd18062593fb1a221bce40af) Property +* [debug](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a1ff316d9091c838bcbdeaf5706e8216e) Function +* [deleteAllMembers](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a763852aed64e16a58160d166c8addd23) Function +* [deleteMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a30200ac90fd4115c2eb6c5641a77eddb) Function +* [deleteRun](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a0be98d87ed201827314037c9100e8fce) Function +* [deleteVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1af26d20927c5ef5ccd3304b1c3ba220c4) Function +* [deleteVariable](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a92a8b6a732ebcd29f6fb33a448f9f4c9) Function +* [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) Function +* [dependentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1abadb81820fd0b415fa9e78ce6c867c55) Function +* [dependentLinks](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a69e716f024970454d8c555c73df17360) Function +* [dependentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a0201276e7d000c4869e4798cfdb68d8b) Function +* [dependentLinks](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a385019a97e3ddbae4351fd6dd591a49c) Function +* [dependentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a90373b06919789f06f52dd22a0339847) Function +* [dependentLinks](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a46a1da5e2a3f39c2e413b520ec33407f) Function +* [dependentLinks](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a50e3d7ea1d97cd799c29901c2b563208) Function +* [dependentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a399b9b49ca3133d2a49923637f19609a) Function +* [dependentLinks](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a1328684b4767a3ee6b006feca4f0296d) Function +* [dependentLinks](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af52780ea6b4984f40b16c8c072e1b005) Function +* [dependentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1add9bd8c41cd4a5c77f7e762768b441a5) Function +* [dependentLinks](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a4c704741da375408b052eeddc6ed90dc) Function +* [dependentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4227d6aca4e2d7791cea69efeb5b81fd) Function +* [dependentLinks](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a019771c2e685c90ef2b4f53a0a3acf7c) Function +* [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) Function +* [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) Function +* [dependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a386477ffe54e2d0f351f9dc7fbb49712) Function +* [dependents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1afa6ea6f99c9eeb606ebe08b1e7d9c54d) Function +* [dependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a6e0601946499c985be03e00354c8acb3) Function +* [dependents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a04becbe1d34e232e21208333c0700e3c) Function +* [dependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1af16a20eacc6734b343762565ec8b20d6) Function +* [dependents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac63897b5927f1ad28965384718c0de6b) Function +* [dependents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ab110babf06372919f705e71b64cc733f) Function +* [dependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af6712999aa6e50091a95dd66db088661) Function +* [dependents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aa8739ff163a52ceed99e867e5126330f) Function +* [dependents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ae106e94dca5f19c46ed9f82c67772660) Function +* [dependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a7a3b136537fb09914b87b5997b937df0) Function +* [dependents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aceffce4238d22a19c211658f675491ee) Function +* [dependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a392d8e4080854c954c165833bb89a7db) Function +* [dependents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6ce38d07c0dc470d96eec4077c2c38b8) Function +* [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) Function +* [Deprecated List](deprecated.md#deprecated) Page +* [description](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a29b8b160371c7db191f6e3dd0e1fc414) Property +* [description](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ae3788aac4468e5c4d62e002663e8e729) Property +* [description](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a8035fb2b8276762f7b0b2b3e8b7d8cf5) Property +* [description](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a59b6ea0f39cadd0ec7b20b16c8d630ea) Property +* [description](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a491df2e849d05621978fe706bb48de85) Property +* [description](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a8be2e0c977d8808648829d523c841d36) Property +* [description](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac0f28c2d059dc02d18d3dd8eaba19f31) Property +* [description](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ad6ac49ae6d10a8aef6927eaad49e55f1) Property +* [description](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a9933e6b9d3328cf70f35075b8556e8ab) Property +* [description](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a746f793efe758a7e3f36ba188d07ccee) Property +* [description](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a73b60bd367cc0e6783f9e5ad0bf96811) Property +* [description](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a0b98819f11c5c2e7c916a4e629199d48) Property +* [description](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1ade4ceb94fec2ee5eab541cce187b1eb3) Property +* [description](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a9a336c7daf4b7f248103e2a3654139e6) Property +* [description](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1af60bf6fec0621b386c755c9adc5cf4b5) Property +* [destroyPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a24cc8bd489975150c9d5c5c3e9502b87) Function +* [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) Function +* [directDependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a6ed20fe44044c682471c7066ae2bd303) Function +* [directDependents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a40dedf6b7b841a6699d545ea058ad2cd) Function +* [directDependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe14e74990edda2c656035bbcd8e2af2) Function +* [directDependents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a6178082dc3de5e1f6665f4faebcb8c36) Function +* [directDependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab61572acbd0617f5c51b04b2ae4bbdba) Function +* [directDependents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a9347c073e1dc6ca62f1b3c7cd6fbec71) Function +* [directDependents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a06be08cd5896250dc5b31ec3d90b79e6) Function +* [directDependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a44b3a3cc73cd46ea7661e776b20b4ded) Function +* [directDependents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ad783a3a7e231dd0aa00b869699a5bca4) Function +* [directDependents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af1b4238d92307aa3586b4f7070e497be) Function +* [directDependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a862a4306dbf867e3db316d9547cea277) Function +* [directDependents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a24fa52bf29a92c4f1d6a79e2991e9ae5) Function +* [directDependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4820176e7ca9e1c3173d602308144c62) Function +* [directDependents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6cd07e865097669f307d3d8ee9ace1c1) Function +* [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) Function +* [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) Function +* [directPrecedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a605c25813e75d1709e364eef080f68e9) Function +* [directPrecedents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ae54cdcd132e22278b8ddb00aaff236c7) Function +* [directPrecedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3ab4fe76950c76fbdd2e76ea3f4fb08b) Function +* [directPrecedents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a7a14b5ef10935109b178062205b91b7a) Function +* [directPrecedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9f84f73f3b65f16fa507678c53c67527) Function +* [directPrecedents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aea8561351c3ff1e003d463616682a838) Function +* [directPrecedents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a8294d8120195193f3a5fba86abcded57) Function +* [directPrecedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae3879cd50b0512f2b5660765393bd24e) Function +* [directPrecedents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a5c99fbda3111d689db126a61e0727106) Function +* [directPrecedents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aac5eb818fb62f131d6ecb13fd3f6aa34) Function +* [directPrecedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aa8041fca418266f2bee129804654abab) Function +* [directPrecedents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0e11aede2642dd050f0c5254a36b4a71) Function +* [directPrecedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a40c76b900187ef244f14c5c8e9bb65bf) Function +* [directPrecedents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a98031c7081831a57f35dcfd18bef2279) Function +* [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) Function +* [directTransfer](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a248392894f6cd7f2662f29c3f110d7af) Property +* [displayAboutBox](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa9057344d6d2ffc28569709efdbdb5ad) Function +* [displayName](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a5f8b196a046e313bc7d50d6ac80ec29d) Property +* [displayPreferencesDialog](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae8f7829bf075209faf0fcecf742e76be) Function +* [DO\_NOT\_VERSION](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0ab728b53581051a989c0a4a20d5a0b7ac) Enumerator +* [DO\_VERSIONING](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0a1db01871f227cbb9c0ff450f45faeb85) Enumerator +* [DO\_VERSIONING\_IF\_POSSIBLE](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0a0f9c1842a82241069e6d7de3b1164023) Enumerator +* [doubleToEditableString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a596665cb30835ccad7c6df17afffd8bd) Function +* [doubleToString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1afdb6c65e615c3d5176129b51a1d44318) Function +* [downloadValues](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a761c665246557b5b4201873a722d6fed) Function +* [downloadValues](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a610d24ca2e023e09194b29c3115c6d84) Function +* [downloadValues](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ae380bd13a2c92b3392432f879e87baf2) Function +* [dumpComDebug](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a27b453e8058a238c25049c8fcb5121e4) Function + +## E + +* [enableCache](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1af28b9a4ab0944f31f2d157ab6826999c) Function +* [enableCarpetPlotTab](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a1e13b83ec71a3274399832bfe3471364) Function +* [enableGraphTab](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa2efe037d15784acff1d3291c482f276) Function +* [enableMainEffectsTab](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a11a172f0d359597318448e52fd991843) Function +* [endRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a0576632449bf05bc8b0274fb341a3332) Function +* [endRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1af2b0ccb145e2775fc9958d3500cfb4bc) Function +* [EndToolRun](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1a2fd4f50429de83a6469ff4146c2202eb) Function +* [ensureRunDataAction](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab5a2bb675d76aca81691538b7ef55ef9) Function +* [enumAliases](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1ab0241db307b35f1e5d19adbd2d1f17df) Variable +* [enumAliases](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1af3b9b49e293ed90e0e36ac8cd64a1d5d) Property +* [enumAliases](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a9e195b698057e2d38fbb9c101ebeb827) Property +* [enumAliases](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a531c146537c198a1c71e5c5826757b01) Property +* [enumAliases](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ade7b31cc762cc412e399fff92260fb99) Property +* [enumAliases](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac706776dfc20b9410c859471f981f43e) Property +* [enumAliases](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a75eca0b30d1c439ddae44c33b03f9797) Property +* [enumAliases](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a55c58e3ba1d7b7b9985a32c8f9b88954) Property +* [enumValues](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a3388bf5cf3b1f7de69b343b81669e6ff) Variable +* [enumValues](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ac0461a8fca66f784a7f1a66b77c952e7) Property +* [enumValues](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1af625775f6fdd957bb0b37ed1c86a3051) Property +* [enumValues](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a0c6cd245f4c6bacc15398f88522a2992) Property +* [enumValues](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5d823185c095e0c48f696a8ec27a78cb) Property +* [enumValues](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1af9ee5a112578385dcae1893f96f0143b) Property +* [enumValues](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a2b488ae83e3f61e8f0924b781b0fac1a) Property +* [enumValues](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1a11d289581d9118de3f3a86d7d643fb85) Property +* [enumValues](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ad3575ae96f975b212aaea0739a0c363d) Property +* [enumValues](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a26a049d4c093a364a5e03c577b6937b1) Property +* [equation](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a32fdc64aa5113896a4a962a5c3cbaf93) Variable +* [equation](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a3901f5a0e0dba161b1746d3869d83807) Property +* [equation](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1aa42abd87b11af98fcb67926472408801) Property +* [error](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a576c679c95d7e5c38917bcc0bab46296) Function +* [exclusive](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae32fcb5e2bd27ce4317da67ea515d40f) Property +* [exists](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a5f79e2722103398d5f02e9fbb3c08c8b) Property +* [exists](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations_1a6e6cf7b365025116e67b9ddd575b10b1) Function +* [exit](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aba655ef2cf9a8f639acde2697d8319a2) Function +* [exportImage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2dc01f47f79342cc3893c66a8be1fb12) Function +* [exportImage](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn_1a6e04dc894ad504d6c349d36ae7384e09) Function +* [exportToCSV](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a75c4f95d0b30e6edb92f98e378f7c4be) Function + +## F + +* [fileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ac8e13d4f87d1c0b784c5ebafd030fa57) Property +* [fileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a12eb5e82033d54430ee309a0ca2ad254) Property +* [fileExtension](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ad161b90c198e19be1132a9e5592e9416) Property +* [fileName](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1aa624273f5c3fb5af9baa0272caa971e0) Variable +* [fileName](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a441ac734f55bcc3351b2e475524bd890) Property +* [fileSaved](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a380f514b047b16f7cfb2fa4bacba4e6c) Function +* [format](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a5d2b591cdaa6ce26e344f11ab6e1b76f) Variable +* [format](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1aee5d1b31138b410b58410abbc82cf441) Property +* [format](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad0078a54f0aa1ede8e3d6d78a00a4f7c) Property +* [format](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a6181c6c0985068e31fdb725d719ddb35) Property +* [format](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ad328109c650cbcc2ca8cf08b688de6af) Property +* [format](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac28287849865c6233468b6e1a9034248) Property +* [forwardSchedule](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aedc1fa62c68c5512ccfe6913e018610c) Property +* [fromCenterLink](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab68593eb479ef9f2684e7e8e683ed0bd) Function +* [fromCenterLink](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3ff1b9e535edf561dfa7f575814f1792) Function +* [fromFile](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a83b3e976d1267ab9bb6e59be7bd741d1) Function +* [fromFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a9ca208f1854ac22bb31e38119e2e2af5) Function +* [fromFile](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a5e4a925c2918b6ac9da355b2287e3d04) Function +* [fromFormattedString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac054c3628e2d617a1972dc195cacec60) Function +* [fromFormattedString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a647cc6b6832eefd008c51457a34c9ff5) Function +* [fromFormattedStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a21c8a18bd7cb6544d526fbe1c27e72ea) Function +* [fromFormattedStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a9a6ac88dcfe81e7651c7cc5d15e4bf59) Function +* [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) Function +* [fromString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1af5d6c192774673f4f4bf7514b35f8ccf) Function +* [fromString](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a8b9fd88143b7b23e5f3ae9e229774a2b) Function +* [fromString](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1a3e35deaee9587905584aa8926b2076de) Function +* [fromString](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a42e57bafd047e98fff2902f213c48f61) Function +* [fromString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3faefed33c99ee3ffb10b5e0e21d239a) Function +* [fromString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1128d6c344adde4e9f9d95b0c19f87b9) Function +* [fromString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab107312b8a5b1e8e96ae2a3678ef9897) Function +* [fromString](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac7654e743af45785904858d2c581058d) Function +* [fromString](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a710bd007c2d1df9c861a33a397c7a9d7) Function +* [fromString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af3d5cd8601c1227d439b7b3f74cc2d16) Function +* [fromString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a180292624fd43a95348bd496b0fee8a6) Function +* [fromString](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aca195574fffbfac6577eb4b0d54f3dd8) Function +* [fromString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9cb9dab871b4e86ed66fb53cc5473ebd) Function +* [fromString](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa52a8fe2a76861302ee8ab0f8f3a614c) Function +* [fromString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a65a839b63dfb0495f577bf70ca87a320) Function +* [fromString](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a587cc7ce24785d0110b86ff815a68d89) Function +* [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a8c4352f776b3919a9a56aa61ff78c5d0) Function +* [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a3dd50d2ce70b8e0534dd9be60e9bec5c) Function +* [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a541ccb54affa550f0ea2694b39e16c7c) Property +* [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) Function +* [fromString](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a889e85b07599a03c7a262297629d0763) Function +* [fromStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad23f4082662c464be07251d6d1695a2d) Function +* [fromStringEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a8d7b18dca2bbe96aa0ee3718e433e272) Function +* [fromStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad068bdf2a8fb66fea7cfb3a3111fb176) Function +* [fromStringEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aa104ba67a0164c27a33017aabd29d83d) Function +* [fromStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a26f9cfd27774a2233ae2cb232cc8fec9) Function +* [fromStringEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2a286a07b606f7e90ac4e1d281a49d38) Function +* [fromStringEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8fa6aff7c64224c1c488d5866dfc4865) Function +* [fromXML](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aef1e4bfd5cd8b8e28d6e26b06483629f) Function +* [fromXML](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a1649ee497672683a575cc6cd6b78c9a6) Function +* [fromXML](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a4697fd5d09c8ade51e7a905a4202e5e9) Function +* [fromXMLFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a4ea300c891cc45556fdd4b1e7988274d) Function +* [fromXMLFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3b65f441a218c193aae8863e6354cc2d) Function +* [fromXMLSaveContext](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a237c798449d1bd63e69905b53fe17d06) Function +* [fromXMLSaveContext](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ad00d42b514b490170b0d28930b4bd32b) Function +* [fullName](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1aa3c8267507d2f0d6cbbd35a33de0fca3) Property + +## G + +* [geomScript](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a8f89e59faab48afc96e4a0dde2f457c3) Variable +* [geomScript](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a1fa79813f4fadc3f9f668aa5d433c431) Property +* [getActiveJobManager](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a931fee19976a7a03e263284ec0ee9d53) Function +* [getArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ac522da7a239f7d74e52a445351e5996a) Function +* [getArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afbdd49bff040a71b2be64a93e6705b21) Function +* [getArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5e233233ced66879ff8aa58832981a7d) Function +* [getArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a499c8a85632b8c29f36a4832ae0a2ba6) Function +* [getArrayMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a5dc9de363afe0659af36716807543b05) Function +* [getArrayMemberAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a24b1cc73d5868b9e8a3014209689d088) Function +* [getArrayMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a13f1700a491d9f13070a854092887b20) Function +* [getArrayMemberValueAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7b6b51c7f0eb9a262d1ba0a2bf831368) Function +* [getAssembly](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a461a8c0e8efdd3353da6feb22b232029) Function +* [getAssemblyStyle](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab1d7ce6494121cd997115f91e91d795a) Function +* [getAuthor](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a302223e3912f3e34a512a5ef323e0939) Function +* [getAutoDelete](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a163f13ac67226dfe0d816950061cc386) Function +* [getBranchCondition](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a0a01eb7fd3513f7754534c229ef4da08) Function +* [getBranchName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1acd033bea89f3ba1ec760d9ad2c47d0ed) Function +* [getCheckpointRunNumber](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a71781fe2343b7ef49d1fb80ed91d295a) Function +* [getCheckpointValue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae28168a3a789a8d8c2413e6c58c635d0) Function +* [getClassURL](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7cd400b4cd38cacd370b5c2b6246375c) Function +* [getColWidth](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1aa7c5595c9eabf857b3adc02d30dcbb8e) Function +* [getCompletedRunData](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a76a5d19e76fdfe69e61d6910917acb32) Function +* [getCompletedRunIndices](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a434f332ecfce0734f8f940da4b722cc6) Function +* [getComponent](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ae5ee8b89f3b20182eb2ab707460fe751) Function +* [getComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a779902b1a3f3c4c0db2b58484ec75fe0) Function +* [getDatabaseFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aaecbc010eb87c6a2fbe894a646d83a4e) Function +* [getDataCollector](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a29b8af2a820e24e728425e6467881067) Function +* [getDataCollectorForDataExplorer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a59b46ca7b15c869fb190ecfeb70bf90a) Function +* [getDataExplorer](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa0b0a16e2c3c1f600a8435d6dca0c096) Function +* [getDataExplorer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae1bdc8f0abc612490b737852f189027a) Function +* [getDataExplorer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer_1aa6b13b15afbe694654cbba4b3fa1157e) Function +* [getDataHistory](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a2add0041717f37ff0c72761de93af815) Function +* [getDataMonitor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a6212fa2f41e2132f8f40d78164059eb7) Function +* [getDataViewHWND](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1a00bc608cb2e87ea6a12c4da4497c4768) Function +* [getDaXFormat](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2559ee7d7f32bbcebd0d18bb145bd012) Function +* [getDaXType](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af8150d8d7d5f6fc37eb3bdf0a27fc817) Function +* [getDescription](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1aea971d69e4505696518f69057dde4863) Function +* [getDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a83abe70ccf5e8a0a582748d84e3d7956) Function +* [getDisplayFullNames](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a0cd9a14f007afaa719e20b54439ea98d) Function +* [getDisplayUnits](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ac11b644fdbd9f5e184a120a3bb6c7eb0) Function +* [getEnumAlias](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5c03822c2d28cde3b9d0fdf4f335a594) Function +* [getEnumValue](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ad6bfcac769bd40c96db19848232fad3f) Function +* [getErrorID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a90e9fc9cfb0d469c4169504e6f2c9cd4) Function +* [getErrorID](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a5fac36a5e20d349ab8941387af60a576) Function +* [getErrorMessage](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a876302a3d26eda812e93bdd8b15bb26d) Function +* [getErrorMessage](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1ac93c96f43f475bc237f396b717bc5408) Function +* [getFailedRunIndexes](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a2acdef5238b168dae7f3294ba1629c77) Function +* [getFileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1abea033ef41f0f2ad087b24387772e09b) Function +* [getFileExtension](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a610338503721a3cd0992fa5af793b718) Function +* [getFileFormat](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ab69f2a1eba739bfa1e95a1b5ba2cc8c8) Function +* [getFileName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a8f71ab194f3468c084aea4beca2c43b9) Function +* [getFileSystemInfo](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a6d6d38245d99b3f53fda689a1adee17f) Function +* [getFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a6c3566f301404af75e38676198a8bf1e) Function +* [getFormattedValue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a45bea3dd1938199a0846f46c3d024503) Function +* [getFormatter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a1533da4a5c2e70aa5b196215af7637bc) Function +* [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) Function +* [getFullName](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1aa62ac6d1100f85d3f212185812a9e517) Function +* [getFullName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a498741fde4d9eeec6eb3f8171e3161d8) Function +* [getFullName](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a19c8cfbcba0c9fc8eaae14bfaaa07d39) Function +* [getFullName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9309a89032b2d7d28baf279a3b76b5e8) Function +* [getFullName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a225331135b6efad1b05c399869975962) Function +* [getFullName](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a00a7eca52d31c8f86e049dc1896d2434) Function +* [getFullName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7aada275954e2fff6bdea69b8a96bd0c) Function +* [getFullName](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a5b0b8db5aec4ebfbd8e7918568c71b70) Function +* [getFullName](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a0b0e9f581b1b038395dacb2700d82ce4) Function +* [getFullName](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1ab1dc7ab3547d2631e64f683968bd0989) Function +* [getFullName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a5766e80ec09baf80e3ad7c28e4dd3bd4) Function +* [getFullName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a8c74276fefc00a8b85a576e1d1b58053) Function +* [getFullName](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a6bbb377e1c98a99b660cfdfa3c61f191) Function +* [getFullName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7d1acdd7a964ceb7d189c87a19e9bcb3) Function +* [getFullName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a44ebe17869a3b1b95568ea46299a9f3f) Function +* [getFullName](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3e427b90dbf2f763c2486cdd774c2d49) Function +* [getFullName](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a7e4a9eb5127e60bfbbd90640e35b32a7) Function +* [getFullName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4ca185e60b69ce2ff41d19a2270bc28b) Function +* [getFullName](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ac8c712e2b8f8136f59cffd1665d6cb5e) Function +* [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) Function +* [getGlobalParameters](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2fac8021991150ab97e3673e4b0c0dc1) Function +* [getHaltStatus](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa75908bb0ec202342833c666b10fcb66) Function +* [getHeight](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a906ba9f57a9a472e1a70c151a50b1155) Function +* [getHelpURL](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a81605db892f6e5dc71aa7a4f2d00686e) Function +* [getHighlightedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab7998245db9550b3e7c21a25b37ce7bf) Function +* [getHWND](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a27e733b7b61329799abe081c40b00394) Function +* [getHWND](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aaaa18b9967d91f5e9afa0f663fb4ddae) Function +* [getIconLocation](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1af49ffd75001ae0bfd3dade7f5b9562db) Function +* [getInput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ac205f68299271d8e97adbc34f7c33655) Function +* [getInputLabel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a4d6a218d3dfff84908b13db7016a947c) Function +* [getIsBinary](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1afaad0639d6eeb9543d9ead12e9164094) Function +* [getKeepalive](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa49db3c3a511089125f6ce44a1ec838f) Function +* [getKeywords](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a38d839895f9ee3493710062d2bf67c34) Function +* [getLastErrorMessage](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5a57f078a8de6d78e6cc4f808c761fe8) Function +* [getLegacyHWND](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity_1a7a2562683a18b86dee7b0cb60564b5e6) Function +* [getLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) Function +* [getLength](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad9da4a66a831de9a501a7aca13a6a84f) Function +* [getLength](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab0632e518febc3b1549fc35d932fd451) Function +* [getLength](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1acb6d739a4e50bcbbda5a5cf053ae21db) Function +* [getLength](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a8167ef387b9cc11bc76e9a0e0694a833) Function +* [getLength](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad88eff947daa184ab953839666729ae5) Function +* [getLength](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a39098992a1f29458010e4d18385d3681) Function +* [getLicensingPath](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af5bdeb0442c6f35c0e5db849b1a166fd) Function +* [getLink](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a9861b3ad530a4efbe4925c89550e8cc5) Function +* [getLinks](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac83decf1799275a0d13ecadeffb008cd) Function +* [getLogger](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af2d28cb0c0290a80ebe0e31f91497f11) Function +* [getMacroScript](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a16bc3b79ea75a2c2e9c6aaf48591f840) Function +* [getMacroScriptLanguage](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8c930544d5f9fc2e49afb076b5ccee76) Function +* [getMacroTimeout](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a18766ae9a0fda73f8febdb709adfceea) Function +* [getMemberDescription](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1abb5cd702a72b774a9b93a50c1a4a4270) Function +* [getMemberDimensions](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac7ead6acd3c9f25b85e9670c396babbe) Function +* [getMemberEnumAliases](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ae8008b1c066e802a5838dfdc9775785d) Function +* [getMemberEnumValues](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a58394bc10f092128be001e36d890c0be) Function +* [getMemberLength](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acc1266cc18716f9973ec60f57c4a657d) Function +* [getMemberList](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a06be37e0fa407f4197aff2e534f61eb7) Function +* [getMemberLowerBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1afd9fba6ca47b0bf5fc48a2d210654d1c) Function +* [getMemberNumDimensions](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a558bd8128469e74dacaae9236e57eed0) Function +* [getMemberProperty](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac9fe0949b94f5f8243a2b783ed2a65b1) Function +* [getMemberType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa0e74d911fa3c06e65ae0061bb0a1740) Function +* [getMemberUnits](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa893e48f7214f7b0c31f5628c16ebb0a) Function +* [getMemberUpperBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acbf0879d4bf1acfaf7cac4f32ef9df0e) Function +* [getMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7143a8eed8b14b1b6b7772e82f472cd8) Function +* [getMemberValueAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a75f4995da0954629b58243f202e1681e) Function +* [getMenuItemDescription](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1a3213c537df82b4c00dd7f4df96b90712) Function +* [getMenuItemName](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1aa8491483ad472e4f1f9e51ea028561eb) Function +* [getMenuItems](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1c15433a3ca058372e666abbaa1e1fa6) Function +* [getMenuItems](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ad899f49a6bef9cd0f56292b7c92d8503) Function +* [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) Function +* [getMetadata](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ad0ea6a9bc76c34b8158454e27bbfd9b8) Function +* [getMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa6b44db219dbaf49be81841dc459f4ae) Function +* [getMetadata](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a74eae8f0c59826ea05228abfc9a9354a) Function +* [getMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a2bd6e585619f4cd76426932b62dcf60a) Function +* [getMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a1a41489453d177315ae18ef464e8907b) Function +* [getMetadata](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a40ecee96822db8b700fe1a814b2ab3b1) Function +* [getMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ae315b5cc3acb88a2edabaa8eea7a6690) Function +* [getMetadata](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a730717369f8ddb8fccfcb3405c56afe3) Function +* [getMetadata](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a9fa5015afd1b3cdd651ce2a0e093a6f6) Function +* [getMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a76933c6f159d52907c0b9f6ba3d13136) Function +* [getMetadata](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aea17e7f7dc6d8979c2c83aec3f8a0c42) Function +* [getMetadata](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6fe6bbfed4b08df8c9f9a4c86cb49ca5) Function +* [getMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac6becc1bb1c5206e972c266164f838ca) Function +* [getMetadata](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a122afef9ff20a0de02d08ab41eb4e5bb) Function +* [getMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac730dc0fbfc8ae56788048e6c0fb80fa) Function +* [getMetadata](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1aa094d1b1e7b20a631c92c9ec9d936d71) Function +* [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) Function +* [getMetaData](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5c33238aa348f88bd3a7c66cde890631) Function +* [getMetaDataProvider](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a2f8bcf1cea9355a81d408919e479013f) Function +* [getMethodList](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1ad90418c9d492ed35dbb1d20943035e) Function +* [getModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5d42323e20b243257f4cef533dd58e7d) Function +* [getModelCenter](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ab914e1d1c1dd883a0a1b6201cde0577f) Function +* [getModelCenterPath](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1adc47ef3cf5fa8d766117ec19c7dfab92) Function +* [getModelUUID](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a499de038ba95ad40b52862e5239bf18c) Function +* [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) Function +* [getName](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a4b41d24972378517a23efafc6a0fc403) Function +* [getName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a471100848db5a6f0c08f2920aa283ac6) Function +* [getName](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ac4595a4a7f2b81c6c5c2f1f5e3742f56) Function +* [getName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a19763f04596904ff5cab2f4f72f6f501) Function +* [getName](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a69e3af3092c78b0c19d9e3fb719f9b4b) Function +* [getName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe2789906f30f6a082e5d3d79e2b5bbc) Function +* [getName](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a10978bbb428eadf01141d2ceb2373c7a) Function +* [getName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a3f04f85ebe4f50a88c7cc3a61ae597f6) Function +* [getName](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1adbaa029c76034043ccdf2bf84bbd0e7f) Function +* [getName](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a2ab57d435f315c7afc7bed802b57d9d0) Function +* [getName](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1ae9bccfbc2ecd401d1f1403594c0ff513) Function +* [getName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a97c817507e162f9422b2f73ab5c8cef1) Function +* [getName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a79fdcc3e290b4b0df816f69d8a8d5f9d) Function +* [getName](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abcd09429d47c396bab6dc63690e1a1c1) Function +* [getName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1ec0c0bce4884b2c8c1decf29f4d5b86) Function +* [getName](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a625e640f8adae51bd6f65a88c7f67299) Function +* [getName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a282d98574e8d65d85c9908b6799321b7) Function +* [getName](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa01b77111d4a975cc12ca3e0a16d845b) Function +* [getName](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1a2b2ac899757c8dbd31a9c38b6d08f2c2) Function +* [getName](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a88c3162ff460faee36d43d3903c7a498) Function +* [getName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a0a90870618bd396edc53c27ff0b8c9af) Function +* [getName](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a50cf9efbe23ed25a027f6df1d7132577) Function +* [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) Function +* [getNetworkLocations](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a375ab85c506633857e960502c208ed79) Function +* [getNumBranches](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a667215e89aa8d7b6ff584ce7c2a9e566) Function +* [getNumCheckpoints](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae1070b5293d700b8e095477fbb54b80c) Function +* [getNumCompletedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a023f64de843e0e97d47e37b9cfbac5ae) Function +* [getNumCustomVars](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a0b2e2ab12279325bc63b9db7330d6bab) Function +* [getNumDesignVariables](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ade57b335d32a772b6de31d129b6374bc) Function +* [getNumEnumAliases](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ac865d961f3e4aa6fdb21c65f4960e7ee) Function +* [getNumEnumValues](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5f133f6ecf8e21010e1a624221f78d5b) Function +* [getNumExpectedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a250340a6fc41c19a43783cd3171db63d) Function +* [getNumFailedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac08c8abcc799991d7b12548ae1172378) Function +* [getNumFailedRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa169d7ec12253068db8fac00e201f6a9) Function +* [getNumInputs](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad8dcd18454e462b191092edd4096ab0c) Function +* [getNumNonEmptyRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac1ad590e863b19678c6e47ae4ff3e521) Function +* [getNumOutputs](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a49fae6444ed2747c716f7829f8113969) Function +* [getNumPages](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a389bca42567d788cb1c1c619a400109f) Function +* [getNumRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a59b24c674a512a94640f4c5a890e9309) Function +* [getNumRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1abe6a941ef83e86184ba40149f775d3f8) Function +* [getNumRuns](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ae63c0e8eda0494dda49ee20141f11ece) Function +* [getNumThreads](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a2a6391025814c8b85861fe9d8eaebf58) Function +* [getNumUnitCategories](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a0f6aab6d238cbe899af59725ab0de842) Function +* [getNumUnits](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad6a35e6ac78e89ddcd4a68023bcdd651) Function +* [getNumVariables](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aca767f94c4b80412c79eba62214eebfd) Function +* [getNumVariables](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1acaa00471b667aa04d3462fa4e26f8d36) Function +* [getOutput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1aede4e8c73a70bff3143317d0fa8dca97) Function +* [getOutputLabel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a7665a71ea25ae6436d201cd2e339e976) Function +* [getPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a3da50454f5e424f4aa3971d84f7387c4) Function +* [getPageSetup](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ac36fc1456cb55f50ccf9046d617b7187) Function +* [getPageTitle](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a91b7a788be45f38d1cea9579731e794c) Function +* [getPageTitle](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a38ed1207dbcb350057bc22b0450eb009) Function +* [getPageType](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2e8a2fc452e5d1bad94bedf2edfe3ca5) Function +* [getPositionX](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a476766c4bdcb9fb07f1fdd0a12a04ac0) Function +* [getPositionX](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a0c3e0c952584ba25801114e01010eab0) Function +* [getPositionX](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a205b99507e64a1ad621ee6aeb6cd6d0c) Function +* [getPositionX](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aa032eb6b3c27a69052a8eb81053dfc34) Function +* [getPositionY](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ab58695afb7a8ecb8202a1b20011d384a) Function +* [getPositionY](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1ad3da2b98a973112ea897cf3b146f0276) Function +* [getPositionY](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6cddb9b21c6b3b60a23f2a28d60ea17a) Function +* [getPositionY](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a7b5ce3f6ce5bfd44702ff1fb874fb9fd) Function +* [getPreference](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aadc031780e0355e1ca2bba83cb13441a) Function +* [getProgID](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a0b7490ab8fe0d89e8ecb6478cfbee8e9) Function +* [getRefPropValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aecab78945a16a827081638609b48318d) Function +* [getRefPropValue](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ad90bbc18df836afc454157bd06523d75) Function +* [getRefPropValueAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a76d1cee0ac71a9682e7ff9af6df9cf77) Function +* [getRefPropValueAbsolute](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ae45fa34070d38d9de3593d815e86b1fc) Function +* [getRegID](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac0dd856b24d06484c6ded0aba0199016) Function +* [getRunIndex](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a03b40110aba59370e9eb6aad1b6b2076) Function +* [getRunInParallel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a8893b7830affcf596e4a6d149ab47753) Function +* [getRunName](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a42f819d3a26184898d9487b42894d4e2) Function +* [getRunOnlyMode](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a38682504615aef9e603a9c2f3d4bd2e8) Function +* [getSaveLocation](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a02bf3019e5a957a4db2daff6dda6ca28) Function +* [getSelectedPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2dfa9fbb916798751f0fbac5ca3d2fa8) Function +* [getSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a3d171136e0b219dd4e2d0d1b4bb9aa1f) Function +* [getSource](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a7ee6752f95f3bdfbe83132a3a7794cb2) Function +* [getSource](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae4cad8560e705e807f793a2dade750e2) Function +* [getSource](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a3dc2690409dd67fc5b3023e50d7abed0) Function +* [getSourceScript](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1af377a582a930edbc7b4a56b57cd54375) Function +* [getThumbnail](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1af5f2203aace2cd54bac6c8789b1782c5) Function +* [getTitle](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ae6aab41ece2d9cf2ac4285aa10cf156e) Function +* [getTradeStudySetup](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a5f068466f0c9b18f8ba1681d97c2ddf9) Function +* [getTradeStudyType](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9f51a8f280c8bc80f4cebcb9de40ab5e) Function +* [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) Function +* [getType](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad8d2b43dd9f4b3656dba1e8570f7f747) Function +* [getType](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a6e68844292a9f0b5e1924728465d02c0) Function +* [getType](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a04395c5a8d6ceff26ae08e6c001bdd45) Function +* [getType](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a59535b93acdadae5c47ebb3f148cc8a7) Function +* [getType](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a974708d2da959d48ee301088918719fd) Function +* [getType](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a6614c3d1ae621d218762e8ed8ec58222) Function +* [getType](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aec7c7bb8f9e43d411c457d7b091e5378) Function +* [getType](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a09f10acb36a75c48c2cce4f1925acb55) Function +* [getType](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a9cbf40ea5229f4240bdb241e8d88329c) Function +* [getType](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a05e311dcfb051f0df6afc99dd01d6773) Function +* [getType](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a38de94bbe44275b88d92522926b1a841) Function +* [getType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a40cc49ff4f6fd51695549d4ad32a4384) Function +* [getType](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a60190ee41cfbc6624a138dba5c790d00) Function +* [getType](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac3c3f33a239fe1182da434d7570346df) Function +* [getType](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ab946d679180e3e65433c8b4b2d61d39e) Function +* [getType](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1aa05642b60b5a5e44e9954c130d4686e1) Function +* [getType](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a551d15c4f328f341d8cba0fe28bfd2b0) Function +* [getType](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a582f9e8e47e60eca8041b98c996a4f4f) Function +* [getType](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a9468a019a8bfaaa771c5bf97e206ea5a) Function +* [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) Function +* [getUniqueID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a01538f2f06fba2512c31fb7a35a04b4d) Function +* [getUnitCategoryName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1abe07ee5b95ed640b926a165f2e02b7f1) Function +* [getUnitName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aab8bb46de63e10f150e9614ea36d0b9a) Function +* [getValidateAll](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a53f5cbf8459b20f9c748535d8013eafd) Function +* [getValue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a43d806edede4bc2efa5e88c7615189ed) Function +* [getValue](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9aa72924449a81d937830715bbe7503e) Function +* [getValue](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa3502b40206d864d5bebd8cec59c71ed) Function +* [getValue](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a2e4c0ae7dbfe8869f56ad932ba0b22db) Function +* [getValue](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1addb4d3f364f0f952a6341b52616bb0cd) Function +* [getValue](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8cacc6c81e217bf7affe180a59d21455) Function +* [getValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a32db352eed1650697f8b164546ea3eeb) Function +* [getValue](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a7ba8cf139385e0630061f9ccfc8dc55e) Function +* [getValueAbsolute](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad975bca587185786df34ddd600d7fe96) Function +* [getValueAbsolute](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a2d9a833f72d05827c32edda52d0584f3) Function +* [getValueAbsolute](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a7c1be797998fc344c26e23ce85d9057d) Function +* [getValueAbsolute](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a04408aef2e249b325db44eb8e0ca6758) Function +* [getValueAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9233b22b8ad38b1abf30bc68d543d789) Function +* [getValueAbsolute](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4e082d20ea2f1b47c95d26152595d05d) Function +* [getVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a074ed759e40eb4931c5b6e23f2c72e02) Function +* [getVariable](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afb270ae53383589c63f87b4e3385f128) Function +* [getVariable](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1af46fd2a7e5dda89d73e347b2fff75d16) Function +* [getVariable](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af87c3dde3f5645f1257ba0edb037889b) Function +* [getVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ad88148c419a4c75c4c79b9d5e3c41eb6) Function +* [getVariable2](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a03430a06338ca51c6f5c45421a47f320) Function +* [getVariableDescription](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a12a4f4daac61b17022aa54dcbb3ec84e) Function +* [getVariableDisplayName](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1a6e0f4277d79e93bd5d08fa7e548394a0) Function +* [getVariableDisplayName](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a6fbac6e4218e6b82ed61d2f38f9b7af6) Function +* [getVariableDisplayName](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a84850e887d89eb20d7793933316ad752) Function +* [getVariableEquation](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1aed1386a6f6cef8c6c4ec1d94b3d07009) Function +* [getVariableEquation](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1ae152b41da461434289f61a5f4c327fb6) Function +* [getVariableEquation](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ad63d367bc060e84ccd0edc96747bd082) Function +* [getVariableMetaData](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aebbf42a396f1eea5b917d13b85e0fb8e) Function +* [getVariableMetaData](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider_1ab17303c17efd43f87d95991b2245bc72) Function +* [getVariableTempDir](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aee367d3da3f483f1d9d476e832c7bb9a) Function +* [getVariableValues](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a03fd55d685a75a6041202d00e676e052) Function +* [getVersion](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a7cb8178dec412b370f22e7a9905eb3d9) Function +* [getViewHWND](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1a19d4d225ecc6463333715ddde8c5f65f) Function +* [getWidth](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1adb51a1067e48f2e1ab9b79874a2d8a66) Function +* [getX](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a610ec59f3295fe819e3a1aadd043927b) Function +* [getXMLExtension](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af94e33f84d46652cfad0af931db0d59b) Function +* [getY](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a15d2803f54702b2198a2f0dc3f36d80d) Function +* [Groups](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a1e5ca5f83e7c3debe3d63366948ad894) Property +* [Groups](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a4393774e2d80bd06dfe8070ef87b146f) Property +* [Groups](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1afab9254fdafc011806a8834430af982f) Property +* [Groups](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a491cb2ba622f73c3338ebbbe92e9da3d) Property +* [Groups](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a6d041596bb6e0be6dd0710c6c9e0e8c9) Property +* [guiCloseAllMultiplexers](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8708a9033fcd77731539b085a1c6c047) Function +* [guiLoadFile](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a255ea30feb95451802aa280bdffcd7b8) Function +* [guiSaveModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8ad33e25dfad91e8ba248d399a1b6449) Function + +## H + +* [halt](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1aa550897654f63d845e410ac9bda26b8a) Function +* [halt](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a4cde569f8ca3555ede7fd8d3d2cd4387) Function +* [hasChanged](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad7310b48379f9d4f8d4688d11ccf0185) Property +* [hasChanged](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a5231acb6d280e70ecf75f906a357e3b4) Property +* [hasChanged](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a5b428150a22e87af248e5fc3277c70ae) Property +* [hasChanged](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a91e412d2c7f4955e11e24099601fab8f) Property +* [hasChanged](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a547bbc74c5db046b8d125cfbc3a6ab57) Property +* [hasChanged](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ae8928b3be9d425c01df1a6bc1052eeaa) Property +* [hasChanged](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa81da335ee85ebf5f806be0b1bc1f39c) Property +* [hasChanged](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a14bb947193a4e5e629d104cadd3159be) Property +* [hasChanged](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a117efbea02cce1afa842341cf3e70bae) Property +* [hasChanged](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a752e2918df57582c7e0639840f2653f7) Property +* [hasChanged](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a221928e7f8f5b8f5ff309f6e768a8d96) Property +* [hasChanged](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a32bab88b29119d84a6429364fd651411) Property +* [hasChanged](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0f4d80365facbc0cfea5745f131e9d10) Property +* [hasChanged](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a7d7a0e45d355883535175f060d150a25) Property +* [hasChanged](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a846973fd74773de77e95f5a686059b8a) Property +* [hasChanged](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a70aa745d819120f3f13d8f5cac099e44) Property +* [hasLowerBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a4a319eba200eb23b04f76abf8780c1cd) Function +* [hasLowerBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a18723d07a18cb720d07bebee26f35d2f) Function +* [hasLowerBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a37a15ea329f97b885f57b2660f8cf519) Function +* [hasLowerBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a3f0459ca0bc1b7108721b4ee36304bc9) Function +* [hasMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1b153917fd978107a15c2b2283d9f1a0) Function +* [hasMemberLowerBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a2870271930867129b9102eec3c778b28) Function +* [hasMemberUpperBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac291b12d8f349c09c18162cda4299a4a) Function +* [hasUpperBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a1460ab1d3ab8aeef7679c93c07fc8138) Function +* [hasUpperBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1aa78deb300d4f268523777fcabe898ce5) Function +* [hasUpperBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a4b31b367d82c30fef71bd2412482c25f) Function +* [hasUpperBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a6434f421569bb898aabc32204d615f1a) Function +* [hide](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1adcc3bc6f74b07b516bbc98361b36d4d6) Function +* [hide](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac7ae926ce6dea385cb26901c86c7fccd) Property +* [hide](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa6cabd1afd2f36f8e431da7342e9bdb7) Property +* [hide](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1aa3a5fa8309ca19d0bf787bbf7cbcbf54) Property +* [hide](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a75d77af56d17b13040ea831d957a4cab) Function +* [hide](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a009c7abd22ec22abd5367db1a29305ff) Property +* [hide](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac8bae6ed29215d02364f98a876f2ccfa) Property +* [hide](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ace9ef38b4495497cd17fc358d675cf58) Property +* [hide](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a6c602247c4c00069af837d7dcbfb3862) Property +* [hide](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a1ed81bb22242904529b71361e954445a) Property +* [hide](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5f571b35a242ad8260a3380f75ec5acf) Property +* [hide](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a0baef047e82cd94c3fe393690a129bb0) Property +* [hide](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a70d41ee491cb94eaa45dd1e3e6c805c9) Property +* [hide](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1aed414820e7a805ab6ba5d08c437d7347) Function +* [hide](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a35c7c4ee97058e1636c56d4863c58e00) Property +* [hide](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a598cb6023fcbcb265cc44618529c3040) Property +* [hide](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a39446dbc4a63268669450640360a10ca) Property +* [hide](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1acd58e2a3356b8297a5cc491f5a3ce9ac) Property +* [hide](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a2b79ae605f5b5864f5470d730a845f7c) Property +* [hide](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a12129753b07898622d2e8a55801ef19d) Function +* [hidePlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a806cc1860aaadaa5496d4caa0a51fe91) Function +* [highlight](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a77749479f2bbdf8caa1f90119e6112fd) Function +* [highlightChanged](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a84baf9536c489fbb318a5e13cbf6fef5) Function +* [HTMLViewerGetMyHWND](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad6f56123c0b435ffca19628deaa4169f) Function +* [HTMLViewerWaitForClose](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad62471b3a17a7b182d7f8fa0df7048b7) Function +* [HWnd](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a4971d80a859be3f620c329dbc5019d7d) Property + +## I + +* [iconID](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1af8ddf59c545db7695b90a2a64bdcc822) Property +* [iconID](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1ab263da951c24595b88adc5b86fe93540) Property +* [id](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa3402e5d6822ebe510cc7fec192d5094) Property +* [id](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a75bed8e4832c534f7d7842ec7921e652) Property +* [id](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a1a709440522385b3161831eea313c15d) Property +* [id](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a2c98e62414b0d01303d7a009449f0871) Property +* [id](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a1022454788e8b96f6e84ad60e652bbe3) Property +* [ignoreDefaultPlotSetup](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a0c7a09c2192beadb073ce041aa0e8893) Function +* [importlib](namespaceComponentPlugIn.md#ComponentPlugIn_8odl_1a1176e44e4d62af0ed162d7221dc5f53f) Function +* [importlib](namespaceComponentPlugIn.md#ComponentPlugIn_8odl_1a2cf599b993bafcd3fef5f5b7c34495e3) Function +* [importlib](namespaceModelCenter.md#namespaceModelCenter_1ac27ed4a9b1a4fd02d9a3191c3ffbfbed) Function +* [importlib](namespacePHXDATAEXPLORERLib.md#namespacePHXDATAEXPLORERLib_1ad9ad6f6589cc63d798e289289f567b68) Function +* [importlib](namespacePHXDATAEXPLORERLib.md#namespacePHXDATAEXPLORERLib_1adfc3e518adcb9b631d6b3cd9f7dd728b) Function +* [importlib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1aebeea567338ef111ceead76bc59bf072) Function +* [importlib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1a0e2d7a999f42bdf583341c632c923d8e) Function +* [importlib](namespacePlugInMetaData.md#PlugInMetaData_8odl_1a64427c7c968384bb40b716dd4f058fc7) Function +* [importlib](namespacePlugInMetaData.md#PlugInMetaData_8odl_1ac015988798e4dff85180232ea6f9f0c5) Function +* [importlib](namespaceTradeStudyPlugIn.md#TradeStudyPlugIn_8odl_1ab9cd75f3f81835d0383377354faea30a) Function +* [importlib](namespaceTradeStudyPlugIn.md#TradeStudyPlugIn_8odl_1a6f9be822941ca29fb4380a23d65b3994) Function +* [index](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a331317f8f767933429cce81e8ada5385) Variable +* [IndexInParent](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a6e888824a16134a6797ec96745c9dd4f) Property +* [IndexInParent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aafafc5168a78769e88de4505174b0daf) Property +* [IndexInParent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a5c8b1a2d576bbdc2ea74f70b499889e0) Property +* [IndexInParent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a20f2c6a05beb38eb4d95a010cb48f94e) Property +* [info](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a0a400bf773ffc4fd5d9c4440fd2d79da) Function +* [insertRun](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab64f03fca9f43b3a491393d44c9144d5) Function +* [internalLicensing](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae91fcfa7f9dfe5fa3df62fb9d3c703c8) Function +* [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) Function +* [invalidate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a04e162fdfae6e99e6dcfd926adfca7b1) Function +* [invalidate](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a1eecc6708b4fb8e29bfe73ead410adaa) Function +* [invalidate](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a73c230184c72f5abcb7d3af5f91c9d1e) Function +* [invalidate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a032e132c6c6a61f81370942921ab2edf) Function +* [invalidate](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a9abf6ea522bbff16d7c2266202b5bdae) Function +* [invalidate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7599948212f77bb66f8ef42fc98e53ce) Function +* [invalidate](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2beb5e20db0843a92acf8d0cc961e3af) Function +* [invalidate](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ac80cc84f95b559145c98a82367649d89) Function +* [invalidate](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a78101d039853db9e2d989edef97f226b) Function +* [invalidate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a521514c594a1ab4e30669305585530b7) Function +* [invalidate](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a07f62e68cae660a8bea1d1e31d754fcf) Function +* [invalidate](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aff411bdfa6a95ccc904878f1ffecba6b) Function +* [invalidate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a56ea1d83eb42dda4a7c06b6fbbf6ffd5) Function +* [invalidate](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3a460ef81527173ce0c272d2bdf69da6) Function +* [invalidate](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a70b40fcdb20ca2991b3db649f77eb55f) Function +* [invalidate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac6dd084c61d7ce2631d207242eca89bf) Function +* [invalidate](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a7b29d24168420440191f35e6ad382d03) Function +* [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) Function +* [invokeHelp](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2a8f95eb131aad5e03597ada8251ef30) Function +* [invokeInsertPageGUI](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a0f0eb77a79bbc31706335b91e6a2923a) Function +* [invokeMenuItem](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2a636f7492de925506cd78a80e37deca) Function +* [invokeMenuItem](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1afe6db966ff1b5790a8ae887d70294dc3) Function +* [invokeMethod](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afaddb2c21be03b26716594af883a51ee) Function +* [invokeMethod](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a583b809498c69beadd39c1e21e2cebab) Function +* [invokeMethod](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a03484bf5c7636d2015b3b11c3849ac30) Function +* [isBinary](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a121de67cd4278a5b008d416a2579bcf0) Variable +* [isBinary](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a18d61da08976eabab25b4049726415a5) Property +* [isBinary](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a66fab48ff61be8f9c8e21bf0c9f96f45) Property +* [isBinary](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2d900fe8d944b0dceaea355cf64ba5a8) Property +* [isCanceled](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a2248d0fcfa9dbf3b0de48e5b75ff4df5) Property +* [isCustom](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1ae6ba3b64b599b6df11a39f0c3fa1b078) Property +* [isDebugEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1adc9ab6356bfc5c95aad04ee887c21588) Function +* [isDesignVar](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a09f46ea4820a3341554e2bad9a052f7e) Variable +* [isDesignVar](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a6429c927c6b4f5937ed8f046ebb618dc) Property +* [isDesignVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1abbcbe48e293004c4cd609b574ecf94fa) Function +* [isDesignVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aa53ea93d24fd4476de06e3226a5b2e69) Function +* [isDesignVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ac933f79559b7a0cf45fe49a6cb1e77d0) Function +* [isErrorEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1aea7f6bb4163869086c07a72b5ec14666) Function +* [isHighlighted](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a81c862c59a3b280376afc1b9bd221116) Function +* [isInfoEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a4472be2e0c0f6302d2e73ad582fe6b9c) Function +* [isInput](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a1f4709d547b2d872fd404f7fc5b6566a) Variable +* [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) Function +* [isInput](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa87e846de03852ee40e909935c2ec470) Function +* [isInput](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ab8445c95fe06a4eb82ed55034c26d34e) Function +* [isInput](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a36394ba4430c4f15bd18a02a96ff9c00) Property +* [isInput](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa0a3e17384092dbeb0cef004db873191) Function +* [isInput](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a162bb6a2a0c8cf5a2f3ee15daaaf85c2) Function +* [isInput](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9e45ea90908321e84979e5b8d2f50357) Function +* [isInput](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a92363045c1f3285c5c1127ad149c0250) Function +* [isInput](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a8c9a1d489060c768242c74b57e85aec2) Function +* [isInput](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a3752394336c9689384efac1005422431) Function +* [isInput](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ab441aa413516cf14c082aa39801250c4) Function +* [isInput](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1adb2ffa6d382f3874d63cab8c53f956c6) Function +* [isInput](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a6a71677c0367f53bb39861474c8ce11e) Property +* [isInput](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ae7e5c76cfd592a71fc7e5785c7cf6394) Function +* [isInput](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa61fe715fadff86e98c35d4bf6aa16e0) Function +* [isInput](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1a0a8ec20895618292855526596a534f06) Property +* [isInput](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a3b7b397239f04cf9ea9358f9477ee2c4) Function +* [isInput](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a2268414421505ee4c0fb49de92953007) Function +* [isInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1a02ddc66a224fd3c8fe04ec8ec60959e5) Function +* [isInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a4f1199571453c7b851c484e88fb43a1a) Function +* [isInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a01b2afba0cae246a236a56555ffd3e05) Function +* [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) Function +* [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) Function +* [isInputToComponent](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a871c46c1f732b2885e2ef1fa2080a3e8) Function +* [isInputToComponent](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1af27600cef7dfba2a97acbeb31e2bbe43) Function +* [isInputToComponent](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a86e51010b5f7765c036af36bd9452622) Function +* [isInputToComponent](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a18112e5a20ca1711e97f8a5514995a49) Function +* [isInputToComponent](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a29e9bceef09e96ad83ce6c0618eb17dd) Function +* [isInputToComponent](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a8ca654408734e709fddeb945e81a5d29) Function +* [isInputToComponent](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a3223f3e2305da64ecb24530ed3e1652f) Function +* [isInputToComponent](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a2a19aa7ca1e4c4fb862016aede378c05) Function +* [isInputToComponent](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a67665668e8c1abee8bc9db708b05e970) Function +* [isInputToComponent](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aff062edf68ee2b0ff7db9b81cba0899a) Function +* [isInputToComponent](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a317b7b47fa55798e212c426b4ac8f014) Function +* [isInputToComponent](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ac551ae6997c725cbb3ef71bd6217f89a) Function +* [isInputToComponent](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ad59d273bea1a7e02540520e9b4428264) Function +* [isInputToComponent](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a940488ff3ad42baa064349a43fe9eac6) Function +* [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) Function +* [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) Function +* [isInputToModel](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a364726a017aca71bdb22d43530cc9426) Function +* [isInputToModel](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a38875f7d7b47980f4d78d76a449bbb01) Function +* [isInputToModel](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a78d5b37b715d259e29e0de79fa58508d) Function +* [isInputToModel](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a34bbd8b682a39cbe120f972f0be7b1cd) Function +* [isInputToModel](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1accf93e4a9fe2c9eb205ccdf1704f3f9e) Function +* [isInputToModel](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a7bd0dbfb0063987f2484dce0cd61c8d1) Function +* [isInputToModel](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a324e6df2e0d789abb14a6ab9bbabb119) Function +* [isInputToModel](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a41c321c0260174a4c118e309fbd13085) Function +* [isInputToModel](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a87d3f8de3185380e368fdb008466dfe3) Function +* [isInputToModel](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa0e5a61596a334437a407396c4a38e44) Function +* [isInputToModel](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2d16dbc50ee0f77d5ca99b8a600e5023) Function +* [isInputToModel](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ad8a6169868d4d186b658946403eae2ab) Function +* [isInputToModel](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1af1da4c99c6359d527ad57c9433333a36) Function +* [isInputToModel](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a52f14ae0f304152748e0373e91701708) Function +* [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) Function +* [IsInteractive](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7fc1e5b5a0eee411b82f7508243f453f) Property +* [isMenuItemChecked](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa6aabcb973d32ab328fa815d38d2da7f) Function +* [isMenuItemEnabled](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a23f32ddd6ea2d2d268351327a03e46b5) Function +* [isMenuItemEnabled](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a7259c195e2711d0fb54579e22752adb2) Function +* [isModified](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1af7b8598fa12d5b516344517c0593a983) Function +* [isModified](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a0e1c5e9cd74d1f2516fc1d35eea45b17) Variable +* [isNonStrictType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac232ce8558a68f9f27661644fbcee3b8) Function +* [isNumeric](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1ae0822979f6b70670a347c98c67d367b2) Variable +* [isNumeric](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a72127ffab32587ffbec60628e70df2fc) Property +* [isNumeric](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1ac7d823563278b1abbc458b61aa5eb686) Property +* [isNumericMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a068348508497bc740975b56559316baf) Function +* [isOkToClose](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af91d7535a069da55220c52b759ca5238) Function +* [isRenamed](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1add033400b2b1694d63f67126639c198f) Function +* [isRunComplete](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ad0d48129784f8ce140ff3dfb76ee8ba3) Function +* [isRunning](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab045302c25ef3b584eb3736b9071569b) Function +* [isRunning](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a56114078a1e476ce5e5ec70314f6fb73) Property +* [isTraceEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1acef00afc02324874e8ff47c61dfb4455) Function +* [isValid](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a55e6f50a94f58d4c39bb6fe06c5398da) Function +* [isValid](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a55153c5a8cc53d611839b0b55bb3e8a2) Variable +* [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) Function +* [isValid](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d13fb275a266aa85280b6beed8be176) Function +* [isValid](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a877899b0c2bcc8400bcd8cfa31c4eb7a) Function +* [isValid](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a2d858bdac93de126a13ced552898b3f9) Function +* [isValid](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1abc151c7ba70d7f1e6249942a627e2171) Function +* [isValid](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a4d7719052c0b341f91436d3a0da270cc) Function +* [isValid](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1b873587774671d25664c294323beae8) Function +* [isValid](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a1d3371b70abb06b2eff5d1ada8aa114f) Function +* [isValid](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a7df18a18470a00422781d711e56a20be) Property +* [isValid](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2d8ceabbeb9640dffb9f6a9e654bbd79) Function +* [isValid](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a01fe29466d2371dd25e6d9a473de32c7) Function +* [isValid](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ab3d891c3978182e073923a56b4dbe89b) Function +* [isValid](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ae03686387c15bc80d2caec8c3a5a913f) Function +* [isValid](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a88a80a771329337246e883b3ce034400) Function +* [isValid](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a366cf132edcae4c78ff3c3c29d81ad03) Function +* [isValid](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1adbc66e2276350867c0b977bf5cf192cf) Function +* [isValid](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8b738f7eef3f9a3f8a723cede3809f47) Function +* [isValid](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a16c6e45e1967f427b3a7123d7da384b1) Function +* [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) Function +* [IsValid](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1a6dd8e8226f7d5b089ef7e4ae49ca8b87) Property +* [isVisible](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a876e3d3fad4e109897eb41df8252cee4) Property +* [isVisible](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a986646a10f5885304323ceb7a737c76b) Property +* [isVisible](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1aa52adfedbec735ae4d1e34c4daf66455) Function +* [isWarnEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1aeeb727ee61ec84c356257e23c8ac72da) Function +* [isWritable](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a349473cf74146c2b8c824e0c47c899e5) Property +* [item](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1a1fdee032bf053c5f99b0291bf04dcaec) Property +* [Item](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies_1ae6f3debe976f58187639b34a900ea2b1) Function +* [Item](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents_1a497784a98d679aa2ed109130ae004e0a) Function +* [Item](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups_1a4a71e44eeb916bcdc8bee4ab891b237d) Function +* [Item](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks_1af1e6de7d83b5af2ae699785b1d61fb1c) Function +* [Item](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables_1a68b42951fd19cf993eef52d372dbdb84) Function + +## L + +* [language](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1af3d2bdfd6cd0c29ada055bee3686b2ff) Property +* [launchDataCollectorPlugIn](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a434995395fc673c8197bfde7e1256240) Function +* [launchHTMLViewer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aae5eb45abe323ca501a777f31b9ae5b8) Function +* [launchMacroEditor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab180eb62170146926e7a6c2384d5ad66) Function +* [launchTradeStudy](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a24726ff2cf91ef85884d6b2bea513ed4) Function +* [length](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af118bdf4b120050d6700a7ceae7f5bec) Property +* [LHS](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1ae3805787afceef57db6297e72632650a) Property +* [LIBS](dir_3deb6222fdd4eb7b0f76591cf78ec6d0.md#dir_3deb6222fdd4eb7b0f76591cf78ec6d0) Directory +* [LIBS/DataExplorer](dir_4c5da7dd69977c70a414920e45f0e4dd.md#dir_4c5da7dd69977c70a414920e45f0e4dd) Directory +* [LIBS/DataExplorer/PHXDataExplorer](dir_f8085194870fe60668985a445c75a643.md#dir_f8085194870fe60668985a445c75a643) Directory +* [LIBS/DataExplorer/PHXDataHistory](dir_b61c1eebc2b964146e7860adc8b8cd2e.md#dir_b61c1eebc2b964146e7860adc8b8cd2e) Directory +* [loadFile](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a21295b971e1a8854d7524b85332fcb3b) Function +* [loadModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab57546e9e718895bbdfa25bc1b7d1e9d) Function +* [loadTemplate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1945a9df23ff32406e48f560a14ea592) Function +* [LocalPath](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1abfc95b5a36c4544b8f58aaffc0d74751) Property +* [loginSucceeded](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback_1a4b7dc5df7be75023f025f8d83fff7579) Function +* [longToEditableString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a2d5f201c8a8166ffeca606bac90d4b3d) Function +* [longToString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a175332e4916d1d86855b1b707831e308) Function +* [lowerBound](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1aa8335d587fd45435098d82f59751071d) Variable +* [lowerBound](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a559e14d8841091219ceb4c121ab8d1fb) Property +* [lowerBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a396e13c98a7680bc75354b6bf6b0487a) Property +* [lowerBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a8d74ea79cd0203c477fa96e2410ba176) Property +* [lowerBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ad38b7c1cfa620446572595dba1b607f6) Property +* [lowerBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a15d6fe654e10ea55a5df2e7bea934e75) Property + +## M + +* [MessageBox](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa31343d27c063cc384336028b12abac2) Function +* [metadata](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1adad4bb3cc571df3df8a8df37d634fe72) Variable +* [METADATA\_ACCESS\_FORCE\_TO\_32\_BITS](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dca637668ae8a3b4e7805346e7f1db302d5) Enumerator +* [METADATA\_ACCESS\_PRIVATE](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dca193d415dae56a753d64d37bcb67a2285) Enumerator +* [METADATA\_ACCESS\_PUBLIC](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dcaed115b108b3a38e88e5f5a3a1e17cf13) Enumerator +* [METADATA\_ACCESS\_READONLY](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dcae1023b575b4ff76a772e10c9162dd467) Enumerator +* [METADATA\_TYPE\_BOOLEAN](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153a0cb9ab8e21174262b86c899965d618c5) Enumerator +* [METADATA\_TYPE\_DOUBLE](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153a1ef8fb522f41ea233866f7058fde8a23) Enumerator +* [METADATA\_TYPE\_FORCE\_TO\_32\_BITS](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153afd2104e48eb6bb48323751a8b15395c2) Enumerator +* [METADATA\_TYPE\_LONG](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153a7f0cc46935e8f50a3ff7125e9ccac82a) Enumerator +* [METADATA\_TYPE\_STRING](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153ab0ea415d391c664f7c4c20e41e6a5b5b) Enumerator +* [METADATA\_TYPE\_XML](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153a934405f69eb259b948fdda69fda36cdd) Enumerator +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) Enumeration type +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) Enumeration type +* [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) Namespace +* [ModelCenter](dir_e61251abb0949c61ea8ea7dc5fba4af2.md#dir_e61251abb0949c61ea8ea7dc5fba4af2) Directory +* [ModelCenter::Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) Class +* [ModelCenter::IAddToModel](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel) Interface +* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) Interface +* [ModelCenter::IAssemblies](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies) Interface +* [ModelCenter::IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) Interface +* [ModelCenter::IBooleanArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray) Interface +* [ModelCenter::IBooleanVariable](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable) Interface +* [ModelCenter::ICachePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin) Interface +* [ModelCenter::IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) Interface +* [ModelCenter::IComponents](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents) Interface +* [ModelCenter::ICustomDesignPoint](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint) Interface +* [ModelCenter::IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) Interface +* [ModelCenter::IDataMonitor](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor) Interface +* [ModelCenter::IDoubleArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray) Interface +* [ModelCenter::IDoubleVariable](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable) Interface +* [ModelCenter::IFeature](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature) Interface +* [ModelCenter::IFileArray](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray) Interface +* [ModelCenter::IFileSystemInfo](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo) Interface +* [ModelCenter::IFileVariable](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable) Interface +* [ModelCenter::IGeometryVariable](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable) Interface +* [ModelCenter::IGlobalParameters](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters) Interface +* [ModelCenter::IGroup](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup) Interface +* [ModelCenter::IGroups](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups) Interface +* [ModelCenter::IIfComponent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent) Interface +* [ModelCenter::IIntegerArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray) Interface +* [ModelCenter::IIntegerVariable](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable) Interface +* [ModelCenter::IJobManager](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager) Interface +* [ModelCenter::ILogger](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger) Interface +* [ModelCenter::ILoginCallback](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback) Interface +* [ModelCenter::IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) Interface +* [ModelCenter::INetworkLocations](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations) Interface +* [ModelCenter::IObjectVariable](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable) Interface +* [ModelCenter::IPHXFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat) Interface +* [ModelCenter::IRefArrayProp](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp) Interface +* [ModelCenter::IReferenceArray](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray) Interface +* [ModelCenter::IReferenceVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable) Interface +* [ModelCenter::IRefProp](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp) Interface +* [ModelCenter::IScriptComponent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent) Interface +* [ModelCenter::IShowHelpEvents](interfaceModelCenter_1_1IShowHelpEvents.md#interfaceModelCenter_1_1IShowHelpEvents) Interface +* [ModelCenter::IStringArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray) Interface +* [ModelCenter::IStringVariable](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable) Interface +* [ModelCenter::ITradeStudyEvents](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents) Interface +* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) Interface +* [ModelCenter::IVariableDescription](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription) Interface +* [ModelCenter::IVariableLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink) Interface +* [ModelCenter::IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) Interface +* [ModelCenter::IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) Interface +* [ModelCenter::IVizContainer](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer) Interface +* [ModelCenter.odl](ModelCenter_8odl.md#ModelCenter_8odl) File +* [ModelCenter/src](dir_cb6cf9700ae02fb10e39761559b5fdeb.md#dir_cb6cf9700ae02fb10e39761559b5fdeb) Directory +* [ModelCenter/src/InterfaceDLL\_ComponentPlugIn](dir_f4b71a0ee7c6b8122721a969fd158e55.md#dir_f4b71a0ee7c6b8122721a969fd158e55) Directory +* [ModelCenter/src/InterfaceDLL\_PlugInMetaData](dir_254da5db084e40f61f0f3ecf2de92ae0.md#dir_254da5db084e40f61f0f3ecf2de92ae0) Directory +* [ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn](dir_6384486296a61296aa9794364431ed6d.md#dir_6384486296a61296aa9794364431ed6d) Directory +* [modelDirectory](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1adf58dfafa5401318de434c22d9e12ef3) Property +* [modelFileName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1abb83f0e9475f2ccf8de46b09946d79e3) Property +* [ModelXMLExtensionsChanged](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1a09c0d68be95fb162874e4da3d0965749) Function +* [moveComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a70986fc1018ab96fdbd507b4ebe568fc) Function +* [movePage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa890fee8f830a7ca7e04840962c2cece) Function +* [multiDelete](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad9dc21008ad2ddd47dfc339328d454da) Function +* [multiPageCopy](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1eca7b9ded4f6956ccfa95b11629021d) Function +* [multiPageCut](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ae2457af6aec2f86ffb328421ad2051e7) Function + +## N + +* [name](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a539d4b4f21c4c53505a6c39534fb2c3f) Variable +* [name](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1aecd9b3210d5ef87459cb8a9830bb0f94) Property +* [name](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1a5430f2b928f3f8fc672dc2dcf8c6db03) Property +* [newCustomDesignPoint](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a04f9887e54ecdb60a1f30abbdfbf975b) Function +* [newJob](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a49263a87ff0aacb9e2231bbe0e726d1a) Function +* [newModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a90ad7c497e4da5b9474d747ba6bd9715) Function +* [numDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a29af128098031d3d75f20bb0fafe633a) Property +* [numDimensions](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a3edf21f87f8614c2b603aafba6f10cd2) Property +* [numDimensions](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a8bf3f208059aad7bc8a73fd4e6529053) Property +* [numDimensions](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a757e103b1c6f7e5921adf31b7b1049ca) Property +* [numDimensions](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a7b259767761bcb4f84893a2f8baaa139) Property +* [numDimensions](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a05a8f727001f8d1794bc33960736fd18) Property +* [numDimensions](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1abaa61cb129a23c20be499a61ec4c8443) Property +* [numItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1a74bd895a7bdaa2b6786bb4dc2c4d12a1) Property +* [numRuns](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1a27982338f106af2e2b89a29c66c2d8f1) Property +* [numRuns](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1ac665a3e053e07b9bf007c5b798af743e) Property +* [numRuns](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ae5299ad977b8ef2294350733bdff6912) Property +* [numThreads](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a2b92bb066c911d4102902525a3feae5f) Property +* [numVariables](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1ae684750b56d166406294cfc78bda83b3) Property +* [numVariables](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aafb31c9ee4a9e013e3f7f77900217492) Property +* [numVariables](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a3d8795dd3559fce3f610e63872b8808b) Property + +## O + +* [OnConnectionErrorMode](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2) Enumeration type +* [onEnd](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1aa280f5643ed0afe304a3ea2556b41159) Function +* [onEnd](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a955659c71fd798c3d2be2d98a277e28d) Function +* [onEnd](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1afa9a6faf24f730938ea94ba9e846a381) Property +* [OwningComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aab060b2f29895c77882494f7194f55e0) Property +* [OwningComponent](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a22fbdf9f77a399b4c536aa78bcd826bf) Property +* [OwningComponent](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a67bcc3bdedde454663601bb945dd5bff) Property +* [OwningComponent](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa2e8150c160c33946dd92d8887b57d1f) Property +* [OwningComponent](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ad15c38a3b89a2fa2be6e2f6b88268fd2) Property +* [OwningComponent](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aa0d97988f42416ca68f47e1fecfe6e73) Property +* [OwningComponent](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a75e79199eccdfb4f00ce0d27f2f1c593) Property +* [OwningComponent](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a9c9a3532f6f0ce9a907824f5e055e89f) Property +* [OwningComponent](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a9d3e429a72048e669d3e37f814294828) Property +* [OwningComponent](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a7156a5b9cb1cd09eced27ffaacd9f521) Property +* [OwningComponent](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a2cd4745b4fe97b79d205b876bd91835d) Property +* [OwningComponent](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a4b37dc07f0e626f6b833b772d57b06a3) Property +* [OwningComponent](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a853702bf341480c261b01988dfd15513) Property +* [OwningComponent](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8c1ac6e84d73e34b12cc5e9397bb83a4) Property +* [OwningComponent](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1aedaac8e1d883db0e5d9fa4f9ccd6403f) Property +* [OwningComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a2b61c0eea38b2b20a08b75041dc20f63) Property + +## P + +* [pageCopy](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1241ff0682653a4b92dd9b6064d0bf42) Function +* [pageCut](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1925e33cfa2ae4e284cef4b8255c92dd) Function +* [pagePaste](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a08c390d4e7e3ff7f93a60283464c7826) Function +* [parallelInstance](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7dc06d52fa432893eaf74db606db3864) Function +* [ParentAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a8cccd51f677c2d7c29c734a2c1009f45) Property +* [ParentAssembly](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a2da9bef2e46c87080698e624d80710f0) Property +* [ParentAssembly](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae19efd7aa8ec8a537e3de7234b41ebde) Property +* [ParentAssembly](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a48996a90eb72b62a9dff1119708c9d42) Property +* [PHXDataExplorer.odl](PHXDataExplorer_8odl.md#PHXDataExplorer_8odl) File +* [PHXDATAEXPLORERLib](namespacePHXDATAEXPLORERLib.md#namespacePHXDATAEXPLORERLib) Namespace +* [PHXDATAEXPLORERLib::\_DPHXDataExplorer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer) Interface +* [PHXDATAEXPLORERLib::\_DPHXDataExplorerEvents](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents) Interface +* [PHXDATAEXPLORERLib::IDataExplorerFacadeOwner](interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner.md#interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner) Interface +* [PHXDATAEXPLORERLib::ILegacyVisiblity](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity) Interface +* [PHXDATAEXPLORERLib::IPageVisibility](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility) Interface +* [PHXDATAEXPLORERLib::IPHXDataExplorerPointer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer) Interface +* [PHXDATAEXPLORERLib::IPHXDEKeepalive](interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive.md#interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive) Interface +* [PHXDATAEXPLORERLib::PHXDataExplorer](classPHXDATAEXPLORERLib_1_1PHXDataExplorer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorer) Class +* [PHXDATAEXPLORERLib::PHXDataExplorerPointer](classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer) Class +* [PHXDataHistory.odl](PHXDataHistory_8odl.md#PHXDataHistory_8odl) File +* [PHXDATAHISTORYLib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib) Namespace +* [PHXDATAHISTORYLib::\_DPHXDataHistory](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory) Interface +* [PHXDATAHISTORYLib::\_DPHXDataHistoryEvents](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents) Interface +* [PHXDATAHISTORYLib::\_DPHXDataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel) Interface +* [PHXDATAHISTORYLib::DataHistoryVariableMetadata](classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata.md#classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata) Class +* [PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct) Structure +* [PHXDATAHISTORYLib::DataHistoryVariableStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct) Structure +* [PHXDATAHISTORYLib::IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) Interface +* [PHXDATAHISTORYLib::IPHXMenuItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems) Interface +* [PHXDATAHISTORYLib::ISaveContext](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext) Interface +* [PHXDATAHISTORYLib::PHXDataExplorerExportPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn) Interface +* [PHXDATAHISTORYLib::PHXDataExplorerPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) Interface +* [PHXDATAHISTORYLib::PHXDataHistory](classPHXDATAHISTORYLib_1_1PHXDataHistory.md#classPHXDATAHISTORYLib_1_1PHXDataHistory) Class +* [PHXMENU\_COPY](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaa4dd9a98729c118faa83f0c0ed3f29dbf) Enumerator +* [PHXMENU\_CUT](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaabf2c6817e4dffe7bc31ef64ab9ddcdb2) Enumerator +* [PHXMENU\_DELETE](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaa5e8804d589a5617739cf74eb4bc3920b) Enumerator +* [PHXMENU\_EXPORT](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaaed6d6e7b1fedd6b023274169374bc7d6) Enumerator +* [PHXMENU\_PAGESETTINGS](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaabf2d504b4c5e2360d5902eb2eadfb45c) Enumerator +* [PHXMENU\_PASTE](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaafa9df5b66d50b8e6ec10faff0eadfa9c) Enumerator +* [PHXMENU\_PREDEFS](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daa) Enumeration type +* [PHXMENU\_PRINT](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaa7e25b0e3c45465e3b3cdbad98b6d0f72) Enumerator +* [PHXMENU\_TOOLTIP](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib_1af75cc33b471340a6cacd04d652e37daaae48476ba1f1babc81be7b7db890b69c2) Enumerator +* [pin](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1afc052eba4f15b6f7a62b0b0cee7b8e4e) Function +* [PlugInMetaData](namespacePlugInMetaData.md#namespacePlugInMetaData) Namespace +* [PlugInMetaData::IPlugInMetaData](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData) Interface +* [PlugInMetaData.odl](PlugInMetaData_8odl.md#PlugInMetaData_8odl) File +* [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) Function +* [precedentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a428a6e6a2a2be52d77bfe96323fea64f) Function +* [precedentLinks](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ab5b740c028c3b878f1341efea2df0116) Function +* [precedentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a640715d1e272c8f15d8cc4c2b466d990) Function +* [precedentLinks](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a8bf056e8b989223191b2e8c7595c0753) Function +* [precedentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a998c2f1327219560aacd3d65d2c178b6) Function +* [precedentLinks](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a4bc52bbf01e5d0a0f95e67e03cce4547) Function +* [precedentLinks](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a42168bcdab0805055df8432194d5654c) Function +* [precedentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ac71c9a184e57f627b336438de0b7a238) Function +* [precedentLinks](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a02a977781b36247895725b38a725dca9) Function +* [precedentLinks](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a25a478d55d4855cdbf4f8753b6cd6062) Function +* [precedentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a084d49d02b9ff5812166721fcdc86018) Function +* [precedentLinks](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ac4f846dce2494b7c4a9b8482af321c96) Function +* [precedentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a19c1ae9d08b968bae4b6fdd1ec74fc3e) Function +* [precedentLinks](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6fcaecc0f0d1bdbd827e507ae1307fa4) Function +* [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) Function +* [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) Function +* [precedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d7349a2273e5b9eaaab5271918eed6f) Function +* [precedents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1aa43bd8ee475029fc466b20cd3b1b686d) Function +* [precedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a5973cfc6b1e41db214568a7e95979eef) Function +* [precedents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac65d0d53de6aee17106700d60161e9cf) Function +* [precedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1abf61619be1e057cf2c42189456169041) Function +* [precedents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a8db95046419c83467475175b216efe84) Function +* [precedents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a6d516295359de158c45bf2a5c0378af0) Function +* [precedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a01bd8fce84abbb243a9f7e3c771c185c) Function +* [precedents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a902fe35d10c8e25b86a64e13953a62f1) Function +* [precedents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a8c987c7df5766ca31115f25ce36f1f91) Function +* [precedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aea1973c58e45bafe3aeea797b91a4f6b) Function +* [precedents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ae2d07bb6bf73c064a1a492bb6ff2806a) Function +* [precedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a913272799193e5d02033c63c746ead9e) Function +* [precedents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a4affcdc7391a9327db4c828e54c71703) Function +* [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) Function +* [prevalidate](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a0f82cdd3e9fa556568265ef51c8bc0de) Property +* [prevalidateInputs](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac59a55cf1a42f612e494d429c3879595) Property +* [ProcessID](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acb08040260ee9e91a9a455c15d9fc0ad) Property +* [progressMeterChange](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a2f121535f7eedf77ce9e6edb9b512a51) Function +* [progressMeterEstimate](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1af43f03e636994de756db750668ac86d6) Function +* [progressMeterStart](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1aca4688267a060ab301972886d0c04d6e) Function +* [progressMeterStop](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a0fb85ceb307de0a1c2a449be77890447) Function + +## R + +* [readFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a93be7b40a50c1d8b612037a105f8fd5f) Function +* [reconnect](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a44d641cc9d4a797f88e56495c466479c) Function +* [reconnect](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a67e294fa372905721460635514adcd35) Function +* [reconnect](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a716d694026d6ef45a78ab51a8d1f6eae) Function +* [reference](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a60216339479fb364f7e97cb5d9ea0b66) Property +* [reference](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1acd5c00c533970d30757f90445ec376cd) Property +* [reference](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1abfacc6a5417c7fab810ac6e34a885657) Property +* [referencedVariable](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1abb922c879568308b8c074165d596777e) Property +* [referencedVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3ae2ecb1742ecac66cec298a6d2cd011) Property +* [referencedVariables](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad2c0541925f15b29800a9e924916615a) Property +* [referencedVariables](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a21758071b908ac4fe720dffdafe75592) Property +* [reinitialize](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a481f787db359b10b814f9ff279bb1471) Function +* [releasePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1a4349fd2038cad3cc22e04eba3d9effe5) Function +* [Remove](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1ae838217b346390c972f8173e9a55361c) Function +* [removeAddress](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations_1aa7869edab5e7d597c67804e2d5dcf561) Function +* [removeAutosave](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a222463b648be93775c026887adf9d75f) Function +* [removeComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7bbd736a48c08e2eb90c4af45872e6f5) Function +* [removeDataMonitor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2dd2279b4d0250af8ae6d3506f55c57a) Function +* [removeFromComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa30551e6356933878904d49df1239bd3) Function +* [removeItem](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a6137208858071bb7fa35bebadcbaea47) Function +* [removeLink](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ad8044ca189f473cbbf095756dd2668f9) Function +* [removeMetadata](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a7bd9389ff771d6b63aa3643c961e7223) Function +* [removePage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a75118395c50e7e2dc424d3f3eeba8fa6) Function +* [removeVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a6b191d44fea8ec432315202d094acdb0) Function +* [rename](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ac180bc4a2120cd22964998c75eed05f5) Function +* [rename](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9cae71e48e01e94d48c0353d3db4d90c) Function +* [rename](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae64ae2e0082f2379391e6a49d5e57192) Function +* [rename](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a775db6663f994e82bb2529efe6585c8d) Function +* [renameBranch](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1afddf16459949f862d3329e2d6eb79bb2) Function +* [requestAuthCredentials](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback_1a9a1b24d936f4ee5dd2979ad38538929b) Function +* [rerunRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a2d1c0808d8fcdfe748d3194c45eda87a) Function +* [restoreFile](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a90cd640253dfeb285c7c66803e61f6ac) Function +* [restoreFileStream](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ad11ce33d8317c86c335597d0e8389578) Function +* [resume](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a1bce7921ac7cedd5712423589b99afb2) Function +* [resumeLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a38ec9f0f44714dd151f7683721bd7ce8) Function +* [RHS](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a05eff77b1fab3100869de855008d8b02) Property +* [run](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1adf60ad0c84852250f14d27cfa689d8d0) Function +* [run](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1a8745a0b6d995a55b708876bcf0b6d7ab) Function +* [run](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a7891e5012feff9e7bbdec3bde6adb8e6) Function +* [run](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a158d8bbb37d23dd35bbf87b1340c95d6) Function +* [run](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1afcc83d74aabc7ddd66da4fccb708f0e9) Function +* [runAntFile](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2d684049210e4062f14cf2e3e2abb031) Function +* [runEnded](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1af1ec5576a28a72b94eca35294a49dff1) Function +* [runFailed](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint_1a7c8bc37e4f17ff29cc066d8e9645d9dd) Function +* [runInParallel](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a1e97168b7c275486400eaaf14e9a88d2) Property +* [runJobAsync](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a7cdc64aa2ca295ed608347a61e79b8ac) Function +* [runLastBranchByDefault](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6b9474faac3cad28e1a5d156438141a0) Property +* [runMacro](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a762c9d09a2d611300bc3e09f9891c86e) Function +* [runStarting](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1a05d371f3256cbd0515c1786d4ca42b46) Function + +## S + +* [SAFEARRAY](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a34d198c9ed66b975c39ed058511a3181) Function +* [SAFEARRAY](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa2ca200dd05dc8257c35af74035459e1) Function +* [SAFEARRAY](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider_1aa2d00c56cf6df0f49ed49a864e281f45) Function +* [save](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a7d30505236a3c1c3b804da8f7f924e26) Function +* [saveAllAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1afeb8dd96abface7ec4a37de262c88c85) Property +* [saveAllAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a98649448b98aa71aef4adc1e33c47570) Property +* [saveFile](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ae85020cbcdca30d63c0dc803f19b7599) Function +* [saveFileStream](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a840d41a9c874a046867c9d25c8a0d628) Function +* [saveModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a16dc53d7c16d4517b6859acc1ee25a50) Function +* [saveModelAs](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab3fcf686594e1e2f81b7814bab8a6752) Function +* [saveTemplate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a3919d10a314c536703149f6377f7f924) Function +* [saveToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a6efbbc76935609344ddfe8b48eaac5c1) Function +* [saveTradeStudy](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af139d41f66681c63c80243adbd48cbc0) Function +* [saveVersionedModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac658a0c1392f2fd8b851794c9ac1896f) Function +* [saveVersionedModelAs](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab65847c07b712a58acfe6a21659518b5) Function +* [saveWithModel](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a2ce9625b3829cc7569fee6949e227dfe) Property +* [saveWithModel](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a4ad8feb4200950e76e3ea66afcee286b) Property +* [screenUpdating](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acc9b3db9f6b75b711cf8106947576e89) Property +* [selectPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2110d97cf0636bd118ea3197ef9ba134) Function +* [selectX](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a54fca30f8b9b840cd4d130fffef89ba8) Function +* [selectY](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a82393da70a02822d7184a81430f45b94) Function +* [setAlternateParentFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a83b97e8dd461f4bc8fbe5cdc63809b74) Function +* [setArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a783239a87a41ba31461d61df639dd5f4) Function +* [setArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad252c204a64ece94a946dcdd22e569df) Function +* [setArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a89811fdbf06146c4bf0b14ea099df689) Function +* [setArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1addf446b647e3f8946e8e72825241e0d3) Function +* [setArrayMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a667cf875a43fda4c97325c3734ef9ed1) Function +* [setArrayMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1adc14eb60074b51d08f58f5f080f830b3) Function +* [setAssemblyStyle](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af1bef892aa57d153cd63b6f4ba9037f4) Function +* [setAuthor](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a0799afa68197fad61909e0a271e28993) Function +* [setAutoDelete](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a19e11dabaf88dae88622b82e9e53954a) Function +* [setBranchCondition](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1af539f83e9e44adfccbff2968cfdb3f39) Function +* [setColWidth](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ade404d7ea696919bbc331c9027315c0e) Function +* [setComponentRequirements](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a0b44c7a2dbdcac528e00911168a8ae05) Function +* [setCustomMetadata](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad106f381c9834b32c12e169264f1272a) Function +* [setCustomRun](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1ae0c7fcaf40dc9a73c3818e08fda4c954) Function +* [setDatabaseFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae38c2eeccd0c6e3c6c2e68063bd7008a) Function +* [setDataHistory](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a530e372d5d75f87574b4f5a7f8f25347) Function +* [setDescription](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a04419d1a39017fa8f13b83720fdca196) Function +* [setDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) Function +* [setDimensions](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a6a526c3b8680b1f5ececc326a340d14b) Function +* [setDimensions](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a397d1abf4ecf0a106e84112b5634efac) Function +* [setDimensions](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a791424f1645b40c0b9b9d509effb1df8) Function +* [setDimensions](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a1010ee85bb6325b98fab48f96b582103) Function +* [setDimensions](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a3526172d364bb842ab3bc25f1cedf31b) Function +* [setDimensions](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1aa3a9cdee8b632a3adda4e2d1814c66f8) Function +* [setDisplayFullNames](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a8be2f10ef4448bc73d4dc7c57f3350ca) Function +* [setDisplayUnits](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1aeac431029c07dddd0397914f6fb4d9d1) Function +* [setError](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a51fddca34fae5fbd0a5f5c858eddac26) Function +* [setExportToRemoteComponents](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1ad479e08f0fcaf6313a005c4fb3c80235) Function +* [setFileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab92bd8b81525ab620509e01219d733fe) Function +* [setFileExtension](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ab1a52e485c1d4c0384d17dca0a2f74be) Function +* [setFileFormat](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ad30b0ac3ddc36ac47b0f03662d3d4d0a) Function +* [setFileName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6824345c22985533b8e284b84e1c83f0) Function +* [setFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1aa34d6054f4542a34efb60a961ad78519) Function +* [setFormattedResult](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9d98950fdb4e2e3f07519c40580c8ae9) Function +* [setGeomViewerRunID](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af1cd6cc367767eafd9ee19b54cac0305) Function +* [setHelpURL](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1af83b75cc2e88ab4935fdbd04e094bc21) Function +* [setHighlightedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aea1fd966af29d2f3d0f7d95ac8f93ce3) Function +* [setIcon](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ad14bf669563d84f430c220a1bc1bd94c) Function +* [setIconPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a65a6502ad779fd4394d06f45adabc398) Function +* [setInitialValue](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a37b148f160421cc772d96d616cc58a67) Function +* [setInitialValue](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a34b3939cccf3f8862301863629b63434) Function +* [setInitialValue](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a61c5bac06b87725ae41b9a17f90b886b) Function +* [setInitialValue](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a4f198a32ba9ba7975e6a81f769a6df0f) Function +* [setInitialValue](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1af05313d1d5dce644dc1e0fb7217e18a0) Function +* [setInput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1abd6b3fa7a63b620f95141c191cd1c29e) Function +* [setInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a44b3d2bd5e6037197449aaa92c6fd725) Function +* [setIsBinary](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ad6f0e0cc2595b7a2726f8d38ec573e2e) Function +* [setKeywords](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a1cafe3fad847bbafcea6adc616c2f97b) Function +* [setLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) Function +* [setLength](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a2bf47781f038fae8dc22e6edb04149a9) Function +* [setLength](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a5e70599413156ef04aa8ddfd03958320) Function +* [setLength](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a66119cc8d733c8a2d6a8101569768662) Function +* [setLength](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a91d122341cefcb887c3871d43ea34524) Function +* [setLength](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2cfaecd2a821841d414f0d9ac505659f) Function +* [setLength](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ab20a6b27ddb532d0186532a52a148d91) Function +* [setLink](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a89561753d60d803cc6427c6af5005484) Function +* [setLocation](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1abb2aeef39615e67a90e950314ea02744) Function +* [setLoginCallback](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a156c716bde56ad5bc070f00e2037a2da) Function +* [setMacroScript](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae2b0614b8c0367ab7893c5fb32e14b96) Function +* [setMacroScriptLanguage](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7b92a22213e11d5f4b3ad8dfe7a894f9) Function +* [setMacroTimeout](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a559cd3b9f0e68e5ecc2c4006c8014667) Function +* [setMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6cef469cbdd030f510d7bb51e686c257) Function +* [setMemberDescription](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7f78fbf9eec449dd61dd06f9d18cbfd6) Function +* [setMemberDimensions](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a4e889147b9f6274163e2ede028fbf1b5) Function +* [setMemberEnumAliases](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a18bf5de57cd2d0343bb90267608621d8) Function +* [setMemberEnumValues](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa2399f22fd7fc4daf9687fab4e4e512a) Function +* [setMemberLength](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aec74047ec9cf7e9b93b0b4509da57f15) Function +* [setMemberLowerBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1af9965da5833253a2234df86f677093) Function +* [setMemberProperty](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a15c71dd9da7797408006e31677e9901f) Function +* [setMemberUnits](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a033310bf93afceacc24f097ce738a135) Function +* [setMemberUpperBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac86c323427541c659a79974e19ad2692) Function +* [setMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a44df8b08cf7cb9cf6d1a5b72136d5f52) Function +* [setMenuItem](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1aa76ac2aefb1a69021d5f536db66c0c4b) Function +* [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) Function +* [setMetadata](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1aa1e66114f498d0a1238237ad6caa1348) Function +* [setMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a772ffc624a737a4808eb8dfc9ff41e0d) Function +* [setMetadata](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a6771c11a9e1388bc4da11b9fae91e2e8) Function +* [setMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a41eb816b08e0e89739822ba87e5416c6) Function +* [setMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a56d1d2b85ec3b4c43589c25887c1dd95) Function +* [setMetadata](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a499a962844cae63886b79779e39db700) Function +* [setMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a46a06089e51539cdb69a6404db042d28) Function +* [setMetadata](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ad532913f25d0b0d02cc2c27105e7ecc8) Function +* [setMetadata](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a3c257357cc786dc18d4187d14b030813) Function +* [setMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae69f586d5f6a7cf93728f99a47b841cf) Function +* [setMetadata](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ad80d2a2e770297e5e57af0cd86601f83) Function +* [setMetadata](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1d611e44da36abed0a41c6f688344841) Function +* [setMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a31e14e94dd9316f40bf963a9da9939f7) Function +* [setMetadata](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1afee8a9cb2ea3d6728cacba4aeaa9ff7a) Function +* [setMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a495551c5a05027a8537ffce75f333f8e) Function +* [setMetadata](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ac5062f1a9bcf780f891c6abeb0bcb391) Function +* [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) Function +* [setMetaData](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a9479fcb9ffceb4360b99be62d77eabad) Function +* [setModelCenter](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a38e366a60626a29afa74869e40f156c6) Function +* [setName](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1afbfd0ce277fb01a5539d791b371ab0de) Function +* [setNumExpectedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a8ee93fde7260e85a34331b2c32a1289c) Function +* [setNumExpectedRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a2760890872ed478c72439fc063f4e9aa) Function +* [setNumRuns](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a89e662a1a1c15ed27f8517b5a526b94d) Function +* [setNumThreads](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a034974bf844d74af316ef687be4b84f7) Function +* [setPassword](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a677e2965bfb8998dc4546673f95355de) Function +* [setPreference](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac7c886a8b0333b565333d6b16d9ab824) Function +* [setRefPropValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a93e2bd4cf0f592ca8ec2a626fbd57432) Function +* [setRefPropValue](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1af41e2e8abdbc5959543416e21bc73793) Function +* [setResult](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9260828e57d6cee2ec51e26dcef48ea7) Function +* [setResultAsFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a8fe368442becfe48a2642b16d9a73e3c) Function +* [setRunInParallel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a660d28f5c25a2efbe370cb162bc58f4e) Function +* [setRunInputs](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a2d73e6a448ba816d2f4025d5f95b285e) Function +* [setRunName](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1adff96af9fbbb349cd4d0d69aab8a1b43) Function +* [setRunOnlyMode](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aba91dde2a4c0674816c3781ed873457e) Function +* [setRunValues](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aa6fcc8d517001f5b1e1c2b4cb9d6a95c) Function +* [setScheduler](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa312b4e6e4585bd0f4d7cc9a69d1d7ec) Function +* [setShortVariableNames](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae53e12cca23a7988b0d8c7dfdbe14308) Function +* [setSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b7b41ca5463a86aecb2368d73464c0e) Function +* [setSize](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ad76100b2b7c20def871a1ffdc745e5da) Function +* [setSourceFromFile](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aa34064721143d9012bfe5c0c899415a8) Function +* [setSourceFromString](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ab41aea5c06252f82fc831ea6af40e1b1) Function +* [setStartContext](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ab7f82a38962d77ab437299dd6cbe50a1) Function +* [setTitle](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a74456073f4bc7e13d954972991583b58) Function +* [setTradeStudySetup](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1acfc1654be0cc6fbe5469b487f9576bb9) Function +* [setTradeStudyType](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a7e9c912ffb74926c67437bf50b8b944f) Function +* [setUniqueID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1adc572aab955548292d15997e1b519434) Function +* [setupPlotsPost](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2f726b811f8e11e39612bfd8b082ef68) Function +* [setupPlotsPre](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a21238a932694565dbf0e2115c80ae59b) Function +* [setUserName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a359b38b4b8bc935b9eb5cf9e68a3a34f) Function +* [setUsernamePassword](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab6b36fde7ab38b09357add72dcbaf225) Function +* [setValidateAll](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1aefca61419c9622f520429f257aa6061c) Function +* [setValue](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa3bdaab478a67db1dd4cb7921de5ed72) Function +* [setValue](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1acbaaac83aab3ce3951ed1be15ad3f6ca) Function +* [setValue](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a18caa8754a18f914632f71675d6821dd) Function +* [setValue](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a535535c056577a2306bfd089423a6e8b) Function +* [setValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a8ef388f09dd24fd704b46a7446016951) Function +* [setValue](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a34205a2be0ffe6695721d957cd90f963) Function +* [setVariableInputs](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a5f77ca1741019e90b1d348a7b4c20b04) Function +* [setVariables](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a03a16eed6dbd98df2286d42f3a47db56) Function +* [setVariableValues](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aff837e76c92ab15ac33eebfe3f348c99) Function +* [setVersion](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a13e4e0a07dfd282fa44afcb16c06aac8) Function +* [setXMLExtension](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a70666088b3363b2c9738cd15ec446d8e) Function +* [show](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad1f82e4921ee4c4db89b43fe92bf171d) Function +* [show](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aa35c0fb45f677b3c2daf475e53107773) Function +* [show](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1adeb4964522dc6e485c3de4bef39a9019) Function +* [show](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a2dcb6077094c93a8484123a0c5633dae) Function +* [show](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a344fe33286c0d548dfb35b472cfcc1d6) Function +* [show](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1a0e233fef605747c79f16a6032e4ebd01) Function +* [show](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ad7d6f94d38270f36b80ed3c0109312dd) Function +* [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a7238385b054e9afddbe65c65644826e4) Function +* [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a81aebef74679c6364f184219c22da93a) Function +* [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1ac84a2866cfcedd306eeabd757d8c0877) Property +* [show](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1ae8ccfc592c21eb6adffad9502e4b28fb) Function +* [showAt](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a69bf3249d5ef44ef0eee2152724f9457) Function +* [showFileBrowseDialog](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a9dabff9569cfbb6c65ccdae26aab3ff7) Function +* [showFileSaveDialog](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a23ea9bc699e8f31401f96d2594f79ae6) Function +* [showGeomTooltip](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a89fb0170b61fdd2e320c52a8b370e99c) Function +* [showGeomViewer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a7d467a6fb859b8cb7f63c04f84f75dfa) Function +* [ShowHelp](interfaceModelCenter_1_1IShowHelpEvents.md#interfaceModelCenter_1_1IShowHelpEvents_1a9e94376ebaa4b126ce37c5c541e8f5cb) Function +* [showLegacy](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity_1af5b6718a60c0ac08286e7ae40df8332a) Function +* [showPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad1fc33915ad5917cd645e795251f01de) Function +* [size](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a9a38726b51caed75a30ae66b82959f64) Property +* [size](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ada4924e975e5e04d2c6f7104f2626212) Property +* [size](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aeb3ca2a904ddc619edad7828c6c4492f) Property +* [size](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aed6f1989cc53493063439e96852be675) Property +* [size](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a49fc48bf1f28f403f2b96b92fb8e5819) Property +* [size](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a0ec169188c7e660a32e9a3bc6792d26f) Property +* [size](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4164bff5f32408083a55fc9a327ebc66) Property +* [startGUIMode](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a06c77786a3965c9ca7c72c6ba7af7ad3) Function +* [startRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a74028f784809522e15bf71133d8fd23c) Function +* [startRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a4c2a3c1d083373801689d9dacc1fd530) Function +* [StartToolRun](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1a4bd376f4406023fdb8c562c3e530e32c) Function +* [state](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1ace7a19354a1c40a3f64464fb87b992ba) Property +* [storeCurrentDesignPoint](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aed3d0ea61e181d39e6bbf38a5ad0a401) Function +* [storeCustomDesignPoint](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a0beef1e5e859c093f079e64792e9ed8e) Function +* [stringToDouble](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a2576f20eaa4ec6133a734ea09d86130a) Function +* [stringToLong](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a9e0774cef531d24731ac6c320cfd837c) Function +* [stringToString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1ac1b65cffaf6712d53e58935e3c1592c9) Function +* [submit](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad1b204f5e684c57b28dc1e3dc733e285) Function +* [suggestedCountFrom](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a07162878a7dcf1c2a6ea41a56c9ddb6b) Property +* [suggestedDependentVars](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae1e8705d32948c759d3ab3e59bf6306b) Property +* [suggestedIndependantVar](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3b5732bdccab13e2a7ed55c852d4c55b) Property +* [suggestedIndependentVar](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a1713976f65a0fdc2d37e9606bbc8672b) Property +* [supportsParallelExecution](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1afc7560080c238a34ac8d339d80175327) Property +* [suspendLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a8a637411378f91597e5612e2e03c959d) Function + +## T + +* [timeout](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a3a0d87f35ccd9845a8dc70e1ccf531eb) Property +* [title](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1aaa7d8507dbf83d2cad6eea2266fa98fb) Property +* [title](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1ad9f9fdbe48e40c42f7d80eb57b072ae7) Property +* [toCSV](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ada3b86a293b267a74999e35c70fea775) Function +* [toCSVFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a582bd6a4ad61e03070dcde9e4df76812) Function +* [toFile](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a21c5941a7054482e4f7fd13e55db2738) Function +* [toFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa3da8eb730cd02ed21080272cc41deb5) Function +* [toFile](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6bd774581876d61cdeaf9637e470b0fe) Function +* [toFileAbsolute](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a118321f9f4f870bd9ec196813546b6f3) Function +* [toFileAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a45afd477c357c9c3002a4046c1eefd32) Function +* [toFileAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a4904889be1812816c742b23763d0229e) Function +* [toFormattedString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1fb28d4b74c3d0121725f15773f7d1bb) Function +* [toFormattedString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abf09981270a02adab12c6bd420e07a22) Function +* [toFormattedStringAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac4e47bfae3990e33c748b44580244be3) Function +* [toFormattedStringAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a7c3ea8978f890824c3e08134c7bf7747) Function +* [toFormattedStringAbsoluteEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ac4c96b591adc0b61b3db5eaa90c3b3cd) Function +* [toFormattedStringAbsoluteEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a7a0ff2e8e1875ee5465deadb6496b81c) Function +* [toFormattedStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aac1d778fd393456a7097eb9f6ac40daa) Function +* [toFormattedStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a895cc520f94cb105b922380b105f448d) Function +* [ToolClosed](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1aceebb769e27511c9b87462b8fa9ef16f) Function +* [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) Function +* [toString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a39294beb6d830e498ee8aca7a25cc4a6) Function +* [toString](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a97263640728fae5de92a272345ce0a01) Function +* [toString](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1a14fe2c260d7d43a7f6d1cf661a34189d) Function +* [toString](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1af9938e6a1943072ae9e89a19e4461a3f) Function +* [toString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1af417ef0e71fabce8379be30e4d176355) Function +* [toString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a59f1d75b8e24323ea9bf523159f04f69) Function +* [toString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7ba909789490822b7ab12891075a9e56) Function +* [toString](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ae28a776965df5807d9ce8b2e0d995867) Function +* [toString](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a0bda0cd0ea97014dc4be4ee2af69e55c) Function +* [toString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a83e5e9905df758b37c901bae5e87430e) Function +* [toString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a2ec6bbef037c4c0a6ab5e510f9063923) Function +* [toString](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acc675e2c9045387d4ceb956d7d7d9f70) Function +* [toString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aaa37debc6216a5419715e0c542555850) Function +* [toString](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a6675d6a6451c20b11b43ad594af28bcc) Function +* [toString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1aa735025db3ac6e13cb486f8629b86a69) Function +* [toString](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a46f43be460cbd0d90493a6f9f26eb65d) Function +* [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a58cdb46e4e8dca27761d7bd976c8fcf2) Function +* [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1aaff0d58b0b3d2d90566fae1277ea4a45) Function +* [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a3f6d767abcf9b50ee14ac7be20ef964a) Property +* [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) Function +* [toString](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a075c34c41b0461b36077d19c314fdc2a) Function +* [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) Function +* [toStringAbsolute](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa07f73fa1f449045d77725b0fef00739) Function +* [toStringAbsolute](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ad3fdc29d883580eaf57b83a7b796c703) Function +* [toStringAbsolute](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1adbd82fbad4622d8c2d91533d536a7ea0) Function +* [toStringAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a89797e61eedee333bd67b55b653ec21f) Function +* [toStringAbsolute](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ac8f43fca8b974b224bd64a78bd3bdda3) Function +* [toStringAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a0dda099769e13bdd8c5c076fc7d9378a) Function +* [toStringAbsolute](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a711f2c70a30362b587b39f5cd3775f71) Function +* [toStringAbsolute](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5bc139ce096dbc917734386869a3be78) Function +* [toStringAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac13b9c8e85a30831a81cedcdca610e01) Function +* [toStringAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af042cdd3c4908daa767f6b0dce043e75) Function +* [toStringAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a1a0ecbbccb3fe3404c79976e9f07b8db) Function +* [toStringAbsolute](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a510fd4577f2a29cf0fef6d1c8fe43c94) Function +* [toStringAbsolute](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1adfb1dee0a1fd5b541eacba1e4cbba7ad) Function +* [toStringAbsolute](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ae9ed673188c2c46e2c3883cdd65b3af5) Function +* [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) Function +* [toStringAbsoluteEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a2e3041440581aab716c684fe88d2ee87) Function +* [toStringAbsoluteEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aaa425c05112e2f9568bb13886800dbba) Function +* [toStringAbsoluteEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab1252981582cec6fd3662321c9c4ce28) Function +* [toStringAbsoluteEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a15dfd2825b183a80b93d849ce3429ca3) Function +* [toStringAbsoluteEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5794b0c172b46da36d761bf31046db07) Function +* [toStringAbsoluteEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aac2b33985ad310362db7c8c878096ae8) Function +* [toStringAbsoluteEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a3684e3b0b2d36a599f75236a6f5e90e7) Function +* [toStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a37c622ae9f50579f714ce98c0379cd98) Function +* [toStringEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1af151b1686dbe379f876131afd8c2c71e) Function +* [toStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ac16f0cbbb0d4c51cb5cc7dfc0c251f88) Function +* [toStringEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1afac8b4ceedd459ad68bed98ae18ea6a8) Function +* [toStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae3d6633e9533a68590025dee14298912) Function +* [toStringEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1af2ff697565c81552d49c0237cfc89ef7) Function +* [toStringEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a9013b29e3ca18c5a0ecaff8dc6d19b5f) Function +* [toXML](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1afc2dbe6d642993070f320d76f0b1f6b6) Function +* [toXML](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac6e672dc87278a4037bbf085b76f6aa4) Function +* [toXML](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a9e16b89241b7593088803ace922f5ced) Function +* [toXMLFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a889efcee9f2e90cf7de94b3d521f4cdd) Function +* [toXMLFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a7d11e224b1eaac4fab085ed9fa3d183b) Function +* [toXMLSaveContext](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a9ce95b6c36069c784ea2389d85dde7ec) Function +* [toXMLSaveContext](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a21df6ed38dc18c8cc9054f40f1f9daaf) Function +* [trace](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a97945d07f653d3cb3e483b512f7c569d) Function +* [TradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ad9db0e1ec3dee4b67da4fd2bd197f497) Property +* [TradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a781692e887426951e2913672d9f94a78) Property +* [tradeStudyClosed](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1a9434138abbfd489946e6657ce904dcac) Function +* [tradeStudyEnd](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a85f4a4b6557102133fc5dad3ef0a1ff8) Function +* [TradeStudyFormat](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dca) Enumeration type +* [tradeStudyModelFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aeecce56460ab6c1c203c9d56433f4371) Property +* [TradeStudyPlugIn](namespaceTradeStudyPlugIn.md#namespaceTradeStudyPlugIn) Namespace +* [TradeStudyPlugIn::ICombinedPlugIn](interfaceTradeStudyPlugIn_1_1ICombinedPlugIn.md#interfaceTradeStudyPlugIn_1_1ICombinedPlugIn) Interface +* [TradeStudyPlugIn::ITradeStudy3JobInfo](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo) Interface +* [TradeStudyPlugIn::ITradeStudy3JobManager](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager) Interface +* [TradeStudyPlugIn::ITradeStudy3JobResult](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult) Interface +* [TradeStudyPlugIn::ITradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback) Interface +* [TradeStudyPlugIn::ITradeStudyPlugIn](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn) Interface +* [TradeStudyPlugIn::ITradeStudyPlugIn2](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2) Interface +* [TradeStudyPlugIn::ITradeStudyPlugIn3](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3) Interface +* [TradeStudyPlugIn::IVariableMetaDataProvider](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider) Interface +* [TradeStudyPlugIn::IWindowed](interfaceTradeStudyPlugIn_1_1IWindowed.md#interfaceTradeStudyPlugIn_1_1IWindowed) Interface +* [TradeStudyPlugIn::TradeStudyPlugIn](classTradeStudyPlugIn_1_1TradeStudyPlugIn.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn) Class +* [TradeStudyPlugIn::TradeStudyPlugIn2](classTradeStudyPlugIn_1_1TradeStudyPlugIn2.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn2) Class +* [TradeStudyPlugIn.odl](TradeStudyPlugIn_8odl.md#TradeStudyPlugIn_8odl) File +* [tradeStudyStart](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a39de949b1cdace01114ee9391fc4a484) Function +* [tradeStudyUri](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aefa05eb2c41402bebce7e388d06d08e8) Property +* [transformAVPoint](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a23a3683a4c5b5f4380e33232e2ca30be) Function +* [TS\_FORMAT\_PXT\_COMPRESSED](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaac387037adbfc62827fa1523fc69a1278) Enumerator +* [TS\_FORMAT\_PXT\_UNCOMPRESSED](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaaeead4e562c092545f613d220eb2df08e) Enumerator +* [TS\_FORMAT\_PXTZ](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaac6d6ad08981541727efbbf8c181674cf) Enumerator +* [TS\_FORMAT\_TSTUDY](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dcaa3332e2d8a655365e5c1fee1d8f1fa436) Enumerator +* [type](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1ab613172a10fa02c2756813e75944536a) Variable +* [type](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ad46181f350249f42a737877eb3ce6c97) Property +* [type](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1a8fc783420e2ab3163a2552436d694d0a) Property + +## U + +* [unAssociatedInstance](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a21a60528e3b43cbbbbc131adaf5a1151) Function +* [units](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a48e1dedfd188d030f71a196434ebaf3b) Variable +* [units](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1aff5fbd1ebbbe6b3d4bd7ce114a09f40e) Property +* [units](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ae91fd63ce08d3af74fb22132b5626432) Property +* [units](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ad5b4b178eafbe9ebf4e55b3f5e158622) Property +* [units](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1afe8daf819657e592587af96079b0a0a9) Property +* [units](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a3752ce74846eb04caed29711d1da302d) Property +* [units](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1abea210199b644bc3da685775950b9368) Property +* [updateComparisonViewHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad687c055e59a0bb50aac411174fa9a70) Function +* [updateComponent](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a7f5a3a1914714827435dfd59e9be5e32) Function +* [updateGeomViewerHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab9e6e926290d9a829d5e90b17911fb22) Function +* [updateHint](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a6394212eddc67589ac43fbd85826bbc2) Function +* [updateThumbHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1adda950ce0660029538ab7bdb541c6f2c) Function +* [upperBound](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1aeda7394339c56c5493cfad15d26b0b3e) Variable +* [upperBound](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5e7eff43bb2a4ca6eed5cd8e95b0e182) Property +* [upperBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad4a4c720baa19775898e45381b881fcd) Property +* [upperBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a7585c786507e272216ec790ce278fd10) Property +* [upperBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a1a062cc1750c92e8db32de2b53d83e9a) Property +* [upperBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abc988cc945fcc8e2cf905c885a180542) Property +* [url](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1addbccbd60da206c6fb480eb4fe05e967) Property +* [Url](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1a8dcb7034aa38f98bae308f4a9425ee43) Property +* [userData](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1af405572d6c2bafc56164b2ce5b97b1a3) Property +* [userData](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1ae7e1acce8fef11c88ba939aba11604ee) Property +* [userData](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6590d1a787dc12285407656bfc22cbd7) Property +* [userData](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ade9f3ed3c58d1f3eb9914c3a395eb7a6) Property + +## V + +* [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) Function +* [validate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa221cef15629c5acf569329c0e089b3a) Function +* [validate](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ae3cb5f6c787efb879f5d85a5ee5ee344) Function +* [validate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1abc755512c485531a61f10d2bc5d691b0) Function +* [validate](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1abddc8770d26e37ac9319be5b90bc6e3e) Function +* [validate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a506a66d66cb52b49d7385351bf0cfa46) Function +* [validate](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa3fdf5883f1849f93bf87256b9100d0b) Function +* [validate](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a62715d2cd23f7a7daafe7568d1a6e32d) Function +* [validate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a84ab133f5b1147d475fb8e2c4275b32b) Function +* [validate](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a2807c2dd1e70fe7d8eab0af0a64e2d74) Function +* [validate](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a56e476d33f05ee8b4faa077396704fa6) Function +* [validate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1af1dd28c351fcda3e3fea31facbd4fca3) Function +* [validate](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a16aec4b64f98c5dfb3f66c497691e447) Function +* [validate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a86b82bcfb1ccfa2428968307eaa07108) Function +* [validate](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a7bddbd595f981680f8eb062d950f20d7) Function +* [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) Function +* [validateAll](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a913715f9bb137763d7b099cfe8bd9b57) Property +* [value](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aafaaa11ebda98ac168f489abd5385422) Property +* [value](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a71678d5b3009123d0401d7715c5dcdf6) Property +* [value](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a025854ed57fb252dde2b341182cd7e7a) Property +* [value](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab6fd11161c6f26426d3205c88025a962) Property +* [value](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aceacfa8c1f90207042abb68d4175679d) Property +* [value](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1aa7a7d4145814425b6ea93e831854d84c) Property +* [value](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a5b7408868a080c3d2b0b6812dc13a536) Property +* [value](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1af89ea57b9feb5597f3e190af1c8b5bf9) Property +* [value](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a44a74adf54ce33e5e11d52ff561b37ad) Property +* [value](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ae013f10c0800acb5229f245f10d687f3) Property +* [value](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1aa7b9346ccbe5c4088c45e09ffb8b7d02) Property +* [value](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a2b4b654f1094bfd632e383909ea37bad) Property +* [value](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a8626c616deb64d587178b6c1cbdc2974) Property +* [value](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a778d71ffd4daf5160b2594672b0cb7c8) Property +* [value](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad9e0cf09c5c40b6272808d3ba83489ba) Property +* [value](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a902f599bd7fe0bed1c5f1f51a49e291e) Property +* [value](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a2e307144f16d81645b5ce2cc30b01ae3) Property +* [value](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ae449bcebd78b7ec3fe365cd8fbd3dac7) Property +* [value](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1afd9e0eaba3274e5802f25fe40f039c16) Property +* [value](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ab56992c6033247f7a5c262e63e728467) Property +* [valueAbsolute](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a875503e8827a33a2d15497b21c50b840) Property +* [valueAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a364aa148101fa8ea9ddc2d624f96fcf5) Property +* [valueAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a5e2a2a61e1c4978200a2009c1f6ab74c) Property +* [valueAbsolute](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1abe143a72a2b1f663e41bf0af0118d5db) Property +* [Variables](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a88d34960f336b71cc7f4beff3b4bbaba) Property +* [Variables](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aad57025fe620abbaae1543962ed2676c) Property +* [Variables](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1a6e92dee614068ff99c03164e7305119a) Property +* [Variables](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a377c50131d329f7fe0e1508bafff61dc) Property +* [Variables](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a54219eed78fa8eed485e8da974458ea1) Property +* [variablesChanged](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a9a2402c1679d7707f2f274399276107d) Function +* [varValue](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a44619a37f14a5ff181483dcf993d1424) Variable +* [verifySslWarning](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback_1a9c27b392b3c109f6abe689251e1e27c7) Function +* [version](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3072c85db32956a1c302668a49b031f8) Property +* [VersionStatus](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0) Enumeration type +* [Visible](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a4e7368bd0265ae9a637cfd675b5bd264) Property + +## W + +* [waitForCompletion](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ad76c0b31771a31a827235d0306529ebc) Function +* [waitForJobCompletion](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a65bfecf019c1e9c8752fa3c90fd5d3a7) Function +* [warmStartStudyComplete](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac68974459907dcaf6b35ea631bba2801) Property +* [warn](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1acf5456282ad4295bfbb5dc3d6c41b8b2) Function +* [wasHalted](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a103d78a1bad75512c13080d2467fb11e) Property +* [writeFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac5ccf89eeca381ed315bbc4080c5df6b) Function +* [writeFileAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ae4220f9f0731a8078169bab709fb9198) Function + +## _ + * [\_item](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1a63a265a486f6a3a5df9cde8b65217d5f) Property \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/index.md index a75927db86..e155af857c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/index.md @@ -1,21 +1,21 @@ -# Contents pages - -* [Global contents](global_contents.md) -* [Interfaces](interface_contents.md) -* [Classes](class_contents.md) -* [Structures](struct_contents.md) -* [Namespaces](namespace_contents.md) -* [Files](file_contents.md) -* [Pages](page_contents.md) -* [Directories](dir_contents.md) - -# Index pages - -* [Global index](global_index.md) -* [Interfaces](interface_index.md) -* [Classes](class_index.md) -* [Structures](struct_index.md) -* [Namespaces](namespace_index.md) -* [Files](file_index.md) -* [Pages](page_index.md) +# Contents pages + +* [Global contents](global_contents.md) +* [Interfaces](interface_contents.md) +* [Classes](class_contents.md) +* [Structures](struct_contents.md) +* [Namespaces](namespace_contents.md) +* [Files](file_contents.md) +* [Pages](page_contents.md) +* [Directories](dir_contents.md) + +# Index pages + +* [Global index](global_index.md) +* [Interfaces](interface_index.md) +* [Classes](class_index.md) +* [Structures](struct_index.md) +* [Namespaces](namespace_index.md) +* [Files](file_index.md) +* [Pages](page_index.md) * [Directories](dir_index.md) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceComponentPlugIn_1_1IComponentPlugIn.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceComponentPlugIn_1_1IComponentPlugIn.md index 8e6f4c221c..9acff86f0c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceComponentPlugIn_1_1IComponentPlugIn.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceComponentPlugIn_1_1IComponentPlugIn.md @@ -1,144 +1,137 @@ - -# Interface ComponentPlugIn::IComponentPlugIn - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_ComponentPlugIn/ComponentPlugIn.odl` (line 18) - - - - - -## Members - -* [construct](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1ace85f5a1c843051fe7513c591c373164) -* [fromString](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1a3e35deaee9587905584aa8926b2076de) -* [onEnd](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1aa280f5643ed0afe304a3ea2556b41159) -* [run](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1a8745a0b6d995a55b708876bcf0b6d7ab) -* [show](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1adeb4964522dc6e485c3de4bef39a9019) -* [toString](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1a14fe2c260d7d43a7f6d1cf661a34189d) - -## Public functions - - - -### Function construct - -![][public] - -``` -void ComponentPlugIn::IComponentPlugIn::construct(IDispatch *modelCenter, IDispatch *addToModel, [defaultvalue(NULL)]IDispatch *dataCollector) -``` - - - - - - - -**Parameters**: - -* IDispatch * **modelCenter** -* IDispatch * **addToModel** -* _[defaultvalue(NULL)]_ IDispatch * **dataCollector** - -**Return type**: void - - - -### Function show - -![][public] - -``` -boolean ComponentPlugIn::IComponentPlugIn::show() -``` - - - - - - - -**Return type**: boolean - - - -### Function toString - -![][public] - -``` -BSTR ComponentPlugIn::IComponentPlugIn::toString() -``` - - - - - - - -**Return type**: BSTR - - - -### Function fromString - -![][public] - -``` -void ComponentPlugIn::IComponentPlugIn::fromString(BSTR setupString) -``` - - - - - - - -**Parameters**: - -* BSTR **setupString** - -**Return type**: void - - - -### Function run - -![][public] - -``` -void ComponentPlugIn::IComponentPlugIn::run() -``` - - - - - - - -**Return type**: void - - - -### Function onEnd - -![][public] - -``` -void ComponentPlugIn::IComponentPlugIn::onEnd() -``` - - - - - - - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ComponentPlugIn::IComponentPlugIn + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_ComponentPlugIn/ComponentPlugIn.odl` (line 18) + + + + + +## Members + +* [construct](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1ace85f5a1c843051fe7513c591c373164) +* [fromString](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1a3e35deaee9587905584aa8926b2076de) +* [onEnd](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1aa280f5643ed0afe304a3ea2556b41159) +* [run](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1a8745a0b6d995a55b708876bcf0b6d7ab) +* [show](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1adeb4964522dc6e485c3de4bef39a9019) +* [toString](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn_1a14fe2c260d7d43a7f6d1cf661a34189d) + +## Public functions + + +### Function construct + +![][public] + +``` +void ComponentPlugIn::IComponentPlugIn::construct(IDispatch *modelCenter, IDispatch *addToModel, [defaultvalue(NULL)]IDispatch *dataCollector) +``` + + + + + + + +**Parameters**: + +* IDispatch * **modelCenter** +* IDispatch * **addToModel** +* _[defaultvalue(NULL)]_ IDispatch * **dataCollector** + +**Return type**: void + + +### Function show + +![][public] + +``` +boolean ComponentPlugIn::IComponentPlugIn::show() +``` + + + + + + + +**Return type**: boolean + + +### Function toString + +![][public] + +``` +BSTR ComponentPlugIn::IComponentPlugIn::toString() +``` + + + + + + + +**Return type**: BSTR + + +### Function fromString + +![][public] + +``` +void ComponentPlugIn::IComponentPlugIn::fromString(BSTR setupString) +``` + + + + + + + +**Parameters**: + +* BSTR **setupString** + +**Return type**: void + + +### Function run + +![][public] + +``` +void ComponentPlugIn::IComponentPlugIn::run() +``` + + + + + + + +**Return type**: void + + +### Function onEnd + +![][public] + +``` +void ComponentPlugIn::IComponentPlugIn::onEnd() +``` + + + + + + + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IAddToModel.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IAddToModel.md index 4214c4d984..921cb6d339 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IAddToModel.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IAddToModel.md @@ -1,888 +1,887 @@ - -# Interface ModelCenter::IAddToModel - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 121) - - - -COM Instance. - - - - - -Examples: - - - - - - -**Adding to the Model**: - -This example is of adding a Trade Study or Data Collector Plug-In to the Model as a Component. -``` -Dim atm As IAddToModel - -atm.addInput "x", "double", "0" -atm.addInput "x2", "double", "0" -atm.addOutput "y", "double", "0" -atm.addToModel -``` - - -**Adding an input**: - -A sample Component Plug-In has input x and output y. Add another input x2. -``` -Dim atm As IAddToModel - -atm.addInput "x", "double", "0" -atm.addInput "x2", "double", "0" -atm.addOutput "y", "double", "0" -atm.updateComponent -``` - - -**Removing an output**: - -A sample Component Plug-In has input x and outputs y, y2. Remove the y2 variable. -``` -Dim atm As IAddToModel - -atm.addInput "x", "double", "0" -atm.addOutput "y", "double", "0" -atm.updateComponent -``` - -## Members - -* [addInput](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a62816c713535ea573159c78f709aa04e) -* [addInput2](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a915f8989fd54300d4ce830d37c2682bf) -* [addMethod](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a1ef6ce942ff5def3c8faa1c4d6d52106) -* [addOutput](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a073c5f4a93c492f05fe361ca1799974e) -* [addOutput2](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a34633d249d8fd7b02a28c3158c6dbae6) -* [addToModel](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a58f5f3bc676a7c683ea4fc9b531d608f) -* [addToModel2](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ab0bc1abd000532d2d89d6179868431fc) -* [addToModel3](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac2d1861e463ef89757948bb091502dbb) -* [autoRun](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1aa714911e950223667ee525a435b00b7a) -* [clearBusyFlag](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1aa73cb2b559ec21ef817b241e7f943e8a) -* [getComponent](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ae5ee8b89f3b20182eb2ab707460fe751) -* [getProgID](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a0b7490ab8fe0d89e8ecb6478cfbee8e9) -* [getRegID](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac0dd856b24d06484c6ded0aba0199016) -* [prevalidateInputs](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac59a55cf1a42f612e494d429c3879595) -* [setAuthor](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a0799afa68197fad61909e0a271e28993) -* [setComponentRequirements](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a0b44c7a2dbdcac528e00911168a8ae05) -* [setDescription](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a04419d1a39017fa8f13b83720fdca196) -* [setHelpURL](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1af83b75cc2e88ab4935fdbd04e094bc21) -* [setIcon](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ad14bf669563d84f430c220a1bc1bd94c) -* [setKeywords](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a1cafe3fad847bbafcea6adc616c2f97b) -* [setVersion](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a13e4e0a07dfd282fa44afcb16c06aac8) -* [updateComponent](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a7f5a3a1914714827435dfd59e9be5e32) - -## Properties - - -### Property prevalidateInputs - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IAddToModel::prevalidateInputs -``` - - - -Whether or not pre-validate inputs before running is turned on for the Component. - - - - - - -**Returns**: - -yes(TRUE) or no(FALSE). - -Example demonstrating how to set the prevalidateInputs property of the Component: -``` -Dim atm As IAddToModel - -atm.prevalidateInputs=false -``` - - - -**Return type**: boolean - - -### Property autoRun - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IAddToModel::autoRun -``` - - - -Whether or not auto-run if inputs change is turned on for the Component. - - - - - - -**Returns**: - -yes(TRUE) or no(FALSE). - -Example demonstrating how to set the autoRun property: -``` -Dim atm As IAddToModel - -atm.autoRun=True -``` - - - -**Return type**: boolean - -## Public functions - - -### Function addToModel - -![][public] - -``` -void ModelCenter::IAddToModel::addToModel() -``` - - - -Adds a Trade Study or Data Collector Plug-In to the Model as a Component Plug-In. This method is not allowed to be called in the run() method. - - - -**Return type**: void - - -### Function updateComponent - -![][public] - -``` -void ModelCenter::IAddToModel::updateComponent() -``` - - - -Reinitializes the inputs and outputs of a Component Plug-In. The [addInput()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a62816c713535ea573159c78f709aa04e) and [addOutput()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a073c5f4a93c492f05fe361ca1799974e) methods must be called for each input and output for the new configuration before calling [updateComponent()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a7f5a3a1914714827435dfd59e9be5e32). This method is not allowed to be called in the run() method. - - - -**Return type**: void - - -### Function getComponent - -![][public] - -``` -IDispatch * ModelCenter::IAddToModel::getComponent() -``` - - - -Gets a pointer to the IAddToModel object's [IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) object. - - - - - - -**Returns**: - -IDispatch* to an [IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) object. - - - -**Return type**: IDispatch * - - -### Function getRegID - -![][public] - -``` -BSTR ModelCenter::IAddToModel::getRegID() -``` - - - -Gets the Plug-In Registry ID that is required for the createDataCollector method in the [IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) object. ModelCenter must must know the Registry ID of the Plug-In so Trade Study Files can be saved/restored if the user chooses to do so. - - - - - -Example demonstrating how to query the IAddToModel object for the Registry ID: -``` -Dim atm As IAddToModel - -Dim Str As String -Str=atm.getRegID() -``` - - - - - - -**Returns**: - -Registry ID of the Plug-In. - - - -**Return type**: BSTR - - -### Function addInput - -![][public] - -``` -IDispatch * ModelCenter::IAddToModel::addInput(BSTR name, BSTR type, [optional]VARIANT value) -``` - - - -Adds a pending input variable to the IAddToModel object IO structure. The IAddToModel object's input variables are updated when the [addToModel()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a58f5f3bc676a7c683ea4fc9b531d608f) or [updateComponent()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a7f5a3a1914714827435dfd59e9be5e32) methods are called. - - - - - - -**Parameters**: - -* **name**: The name of the pending variable. -* **type**: The type of the variable. Add "[]" to the end of the type to indicate an array.
- Valid types include: -* "double" - double - -* "int" - integer - -* "string" - string - -* "bool" - boolean - -* "ref" - reference - -* "file" - A binary or ascii file - -* "object" - object variable (The default class type "PHXNonStrictType" will be used) - -* "quad" - Quad Facet Geometry, a geometry type composed of multiple quadrilaterals. - -* "sor" - Surface of Revolution, a geometry type defined by a profile curve rotated about an axis. - -* "nurbs" - A geometry type for NURBS. - -* "bspline" - A geometry type for B-Spline curves. - -* "ruled" - A geometry type for ruled surfaces. - -* "skinned" - A geometry type for skinned surfaces. - -* "node" - A geometry type for displaying multiple points in space. -* **value**: Value of the variable. If the variable is an array, then each variable value should be separated by a semi-colon:
- addInput( "myVar", "double[]", "0;1;2.3;4.56" ) - - -**Returns**: - -IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object - - - -**Parameters**: - -* BSTR **name** -* BSTR **type** -* _[optional]_ VARIANT **value** - -**Return type**: IDispatch * - - -### Function addOutput - -![][public] - -``` -IDispatch * ModelCenter::IAddToModel::addOutput(BSTR name, BSTR type, [optional]VARIANT value) -``` - - - -Adds a pending output variable to the IAddToModel object IO structure. The IAddToModel object's output variables are updated when the [addToModel()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a58f5f3bc676a7c683ea4fc9b531d608f) or [updateComponent()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a7f5a3a1914714827435dfd59e9be5e32) methods are called. - - - - - - -**Parameters**: - -* **name**: The name of the pending variable. -* **type**: The type of the variable. Add "[]" to the end of the type to indicate an array.
- Valid types include: -* "double" - double - -* "int" - integer - -* "string" - string - -* "bool" - boolean - -* "ref" - reference - -* "file" - A binary or ascii file - -* "object" - object variable (The default class type "PHXNonStrictType" will be used) - -* "quad" - Quad Facet Geometry, a geometry type composed of multiple quadrilaterals. - -* "sor" - Surface of Revolution, a geometry type defined by a profile curve rotated about an axis. - -* "nurbs" - A geometry type for NURBS. - -* "bspline" - A geometry type for B-Spline curves. - -* "ruled" - A geometry type for ruled surfaces. - -* "skinned" - A geometry type for skinned surfaces. - -* "node" - A geometry type for displaying multiple points in space. -* **value**: Value of the variable. If the variable is an array, then each variable value should be separated by a semi-colon:
- addInput( "myVar", "double[]", "0;1;2.3;4.56" ) - - -**Returns**: - -IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object - - - -**Parameters**: - -* BSTR **name** -* BSTR **type** -* _[optional]_ VARIANT **value** - -**Return type**: IDispatch * - - -### Function getProgID - -![][public] - -``` -BSTR ModelCenter::IAddToModel::getProgID() -``` - - - -Gets the ProgID for COM Plug-Ins. The ProgID is the the string used to create an instance of a COM object (ex. "Phoenix.myPlugIn"). - - - - - -Example demonstrating how to get the ProgID of a Plug-In: -``` -Dim atm As IAddToModel - -Dim Str As String -Str=atm.getProgID() -``` - - - - - - -**Returns**: - -ProgID of the COM Plug-In. - - - -**Return type**: BSTR - - -### Function setAuthor - -![][public] - -``` -void ModelCenter::IAddToModel::setAuthor(BSTR author) -``` - - - -Defines the author of this Plug-In. Use this method to set the Component metadata when you add a Trade Study or Data Collector Plug-In to the Model. - - - - - - -**Parameters**: - -* **author**: The author of this Plug-In. - - - -**Parameters**: - -* BSTR **author** - -**Return type**: void - - -### Function setDescription - -![][public] - -``` -void ModelCenter::IAddToModel::setDescription(BSTR description) -``` - - - -Defines the description of this Plug-In. Use this method to set the Component metadata when you add a Trade Study or Data Collector Plug-In to the Model. - - - - - - -**Parameters**: - -* **description**: The description for this Plug-In. - - - -**Parameters**: - -* BSTR **description** - -**Return type**: void - - -### Function setVersion - -![][public] - -``` -void ModelCenter::IAddToModel::setVersion(BSTR version) -``` - - - -Defines the version of this Plug-In. Use this method to set the Component metadata when you add a Trade Study or Data Collector Plug-In to the Model. - - - - - - -**Parameters**: - -* **version**: The version information for this Plug-In. - - - -**Parameters**: - -* BSTR **version** - -**Return type**: void - - -### Function setHelpURL - -![][public] - -``` -void ModelCenter::IAddToModel::setHelpURL(BSTR helpURL) -``` - - - -Defines the help URL of this Plug-In. Use this method to set the Component metadata when you add a Trade Study or Data Collector Plug-In to the Model. - - - - - - -**Parameters**: - -* **helpURL**: The help URL for this Plug-In. - - - -**Parameters**: - -* BSTR **helpURL** - -**Return type**: void - - -### Function setKeywords - -![][public] - -``` -void ModelCenter::IAddToModel::setKeywords(BSTR keywords) -``` - - - -Defines the keywords for this Plug-In. Use this method to set the Component metadata when you add a Trade Study or Data Collector Plug-In to the Model. - - - - - - -**Parameters**: - -* **keywords**: The keywords for this Plug-In. - - - -**Parameters**: - -* BSTR **keywords** - -**Return type**: void - - -### Function clearBusyFlag - -![][public] - -``` -void ModelCenter::IAddToModel::clearBusyFlag() -``` - - - -Clears the busy state of [ModelCenter](namespaceModelCenter.md#namespaceModelCenter). - - - -**Return type**: void - - -### Function addToModel2 - -![][public] - -``` -boolean ModelCenter::IAddToModel::addToModel2() -``` - - - -Adds a Trade Study or Data Collector Plug-In to the Model as a Component Plug-In. This method is not allowed to be called in the run() method. - - - - - - -**Returns**: - -Whether or not the operation completed successfully. - - - -**Return type**: boolean - - -### Function setComponentRequirements - -![][public] - -``` -void ModelCenter::IAddToModel::setComponentRequirements(BSTR compReq) -``` - - - -Defines the requirements for this Plug-In. Use this method to set the Component metadata when you add a Trade Study or Data Collector Plug-In to the Model. - - - - - - -**Parameters**: - -* **compReq**: A comma separated list of requirement specifiers for this Plug-In. - - - -**Parameters**: - -* BSTR **compReq** - -**Return type**: void - - -### Function setIcon - -![][public] - -``` -void ModelCenter::IAddToModel::setIcon(BSTR iconFile) -``` - - - -Sets the Plug-In icon. -**Parameters**: - -* **iconFile**: The file path to the icon file. - - - -**Parameters**: - -* BSTR **iconFile** - -**Return type**: void - - -### Function addMethod - -![][public] - -``` -void ModelCenter::IAddToModel::addMethod(BSTR name, [optional]VARIANT displayName) -``` - - - -Adds the method. - - - - - - -**Parameters**: - -* **name**: The name of the method. -* **displayName**: The display name of the method. - - - -**Parameters**: - -* BSTR **name** -* _[optional]_ VARIANT **displayName** - -**Return type**: void - - -### Function addInput2 - -![][public] - -``` -IDispatch * ModelCenter::IAddToModel::addInput2(BSTR name, BSTR type, BSTR classURL, [optional]VARIANT value) -``` - - - -Adds a pending input variable to the IAddToModel object IO structure. The IAddToModel object's input variables are updated when the [addToModel()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a58f5f3bc676a7c683ea4fc9b531d608f) or [updateComponent()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a7f5a3a1914714827435dfd59e9be5e32) methods are called. This method can be used to add an "object" variable with a specified class type. - - - - - - -**Parameters**: - -* **name**: The name of the pending variable. -* **type**: The type of the variable. Add "[]" to the end of the type to indicate an array.
- Valid types include: -* "double" - double - -* "int" - integer - -* "string" - string - -* "bool" - boolean - -* "ref" - reference - -* "file" - A binary or ascii file - -* "object" - object variable (The default class type "PHXNonStrictType" will be used if classURL is empty) - -* "quad" - Quad Facet Geometry, a geometry type composed of multiple quadrilaterals. - -* "sor" - Surface of Revolution, a geometry type defined by a profile curve rotated about an axis. - -* "nurbs" - A geometry type for NURBS. - -* "bspline" - A geometry type for B-Spline curves. - -* "ruled" - A geometry type for ruled surfaces. - -* "skinned" - A geometry type for skinned surfaces. - -* "node" - A geometry type for displaying multiple points in space. -* **classURL**: Class of the object variable. If an empty string is passed, PHXNonStrictType will be used. -* **value**: Value of the variable. If the variable is an array, then each variable value should be separated by a semi-colon:
- addInput( "myVar", "double[]", "0;1;2.3;4.56" ) - - -**Returns**: - -IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object - - - -**Parameters**: - -* BSTR **name** -* BSTR **type** -* BSTR **classURL** -* _[optional]_ VARIANT **value** - -**Return type**: IDispatch * - - -### Function addOutput2 - -![][public] - -``` -IDispatch * ModelCenter::IAddToModel::addOutput2(BSTR name, BSTR type, BSTR classURL, [optional]VARIANT value) -``` - - - -Adds a pending output variable to the IAddToModel object IO structure. The IAddToModel object's output variables are updated when the [addToModel()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a58f5f3bc676a7c683ea4fc9b531d608f) or [updateComponent()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a7f5a3a1914714827435dfd59e9be5e32) methods are called. - - - - - - -**Parameters**: - -* **name**: The name of the pending variable. -* **type**: The type of the variable. Add "[]" to the end of the type to indicate an array.
- Valid types include: -* "double" - double - -* "int" - integer - -* "string" - string - -* "bool" - boolean - -* "ref" - reference - -* "file" - A binary or ascii file - -* "object" - object variable (The default class type "PHXNonStrictType" will be used) - -* "quad" - Quad Facet Geometry, a geometry type composed of multiple quadrilaterals. - -* "sor" - Surface of Revolution, a geometry type defined by a profile curve rotated about an axis. - -* "nurbs" - A geometry type for NURBS. - -* "bspline" - A geometry type for B-Spline curves. - -* "ruled" - A geometry type for ruled surfaces. - -* "skinned" - A geometry type for skinned surfaces. - -* "node" - A geometry type for displaying multiple points in space. -* **classURL**: Class of the object variable. If an empty string is passed, PHXNonStrictType will be used. -* **value**: Value of the variable. If the variable is an array, then each variable value should be separated by a semi-colon:
- addInput( "myVar", "double[]", "0;1;2.3;4.56" ) - - -**Returns**: - -IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object - - - -**Parameters**: - -* BSTR **name** -* BSTR **type** -* BSTR **classURL** -* _[optional]_ VARIANT **value** - -**Return type**: IDispatch * - - -### Function addToModel3 - -![][public] - -``` -BSTR ModelCenter::IAddToModel::addToModel3(BSTR suggestedName) -``` - - - -Adds a Trade Study or Data Collector Plug-In to the Model as a Component Plug-In. This method is not allowed to be called in the run() method. - - - - - - -**Parameters**: - -* **suggestedName**: Desired name for the component. This name will be used unless a component of that name already exists, in which case the variable name will be the desired name plus a number tagged on to the end. - - -**Returns**: - -Whether or not the operation completed successfully. - - - -**Parameters**: - -* BSTR **suggestedName** - -**Return type**: BSTR - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IAddToModel + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 121) + + + +COM Instance. + + + + + +Examples: + + + + + + +**Adding to the Model**: + +This example is of adding a Trade Study or Data Collector Plug-In to the Model as a Component. +``` +Dim atm As IAddToModel + +atm.addInput "x", "double", "0" +atm.addInput "x2", "double", "0" +atm.addOutput "y", "double", "0" +atm.addToModel +``` + + +**Adding an input**: + +A sample Component Plug-In has input x and output y. Add another input x2. +``` +Dim atm As IAddToModel + +atm.addInput "x", "double", "0" +atm.addInput "x2", "double", "0" +atm.addOutput "y", "double", "0" +atm.updateComponent +``` + + +**Removing an output**: + +A sample Component Plug-In has input x and outputs y, y2. Remove the y2 variable. +``` +Dim atm As IAddToModel + +atm.addInput "x", "double", "0" +atm.addOutput "y", "double", "0" +atm.updateComponent +``` + +## Members + +* [addInput](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a62816c713535ea573159c78f709aa04e) +* [addInput2](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a915f8989fd54300d4ce830d37c2682bf) +* [addMethod](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a1ef6ce942ff5def3c8faa1c4d6d52106) +* [addOutput](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a073c5f4a93c492f05fe361ca1799974e) +* [addOutput2](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a34633d249d8fd7b02a28c3158c6dbae6) +* [addToModel](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a58f5f3bc676a7c683ea4fc9b531d608f) +* [addToModel2](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ab0bc1abd000532d2d89d6179868431fc) +* [addToModel3](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac2d1861e463ef89757948bb091502dbb) +* [autoRun](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1aa714911e950223667ee525a435b00b7a) +* [clearBusyFlag](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1aa73cb2b559ec21ef817b241e7f943e8a) +* [getComponent](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ae5ee8b89f3b20182eb2ab707460fe751) +* [getProgID](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a0b7490ab8fe0d89e8ecb6478cfbee8e9) +* [getRegID](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac0dd856b24d06484c6ded0aba0199016) +* [prevalidateInputs](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac59a55cf1a42f612e494d429c3879595) +* [setAuthor](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a0799afa68197fad61909e0a271e28993) +* [setComponentRequirements](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a0b44c7a2dbdcac528e00911168a8ae05) +* [setDescription](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a04419d1a39017fa8f13b83720fdca196) +* [setHelpURL](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1af83b75cc2e88ab4935fdbd04e094bc21) +* [setIcon](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ad14bf669563d84f430c220a1bc1bd94c) +* [setKeywords](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a1cafe3fad847bbafcea6adc616c2f97b) +* [setVersion](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a13e4e0a07dfd282fa44afcb16c06aac8) +* [updateComponent](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a7f5a3a1914714827435dfd59e9be5e32) + +## Properties + + +### Property prevalidateInputs + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IAddToModel::prevalidateInputs +``` + + + +Whether or not pre-validate inputs before running is turned on for the Component. + + + + + + +**Returns**: + +yes(TRUE) or no(FALSE). + +Example demonstrating how to set the prevalidateInputs property of the Component: +``` +Dim atm As IAddToModel + +atm.prevalidateInputs=false +``` + + + +**Return type**: boolean + + +### Property autoRun + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IAddToModel::autoRun +``` + + + +Whether or not auto-run if inputs change is turned on for the Component. + + + + + + +**Returns**: + +yes(TRUE) or no(FALSE). + +Example demonstrating how to set the autoRun property: +``` +Dim atm As IAddToModel + +atm.autoRun=True +``` + + + +**Return type**: boolean + +## Public functions + + +### Function addToModel + +![][public] + +``` +void ModelCenter::IAddToModel::addToModel() +``` + + + +Adds a Trade Study or Data Collector Plug-In to the Model as a Component Plug-In. This method is not allowed to be called in the run() method. + + + +**Return type**: void + + +### Function updateComponent + +![][public] + +``` +void ModelCenter::IAddToModel::updateComponent() +``` + + + +Reinitializes the inputs and outputs of a Component Plug-In. The [addInput()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a62816c713535ea573159c78f709aa04e) and [addOutput()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a073c5f4a93c492f05fe361ca1799974e) methods must be called for each input and output for the new configuration before calling [updateComponent()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a7f5a3a1914714827435dfd59e9be5e32). This method is not allowed to be called in the run() method. + + + +**Return type**: void + + +### Function getComponent + +![][public] + +``` +IDispatch * ModelCenter::IAddToModel::getComponent() +``` + + + +Gets a pointer to the IAddToModel object's [IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) object. + + + + + + +**Returns**: + +IDispatch* to an [IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) object. + + + +**Return type**: IDispatch * + + +### Function getRegID + +![][public] + +``` +BSTR ModelCenter::IAddToModel::getRegID() +``` + + + +Gets the Plug-In Registry ID that is required for the createDataCollector method in the [IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) object. ModelCenter must must know the Registry ID of the Plug-In so Trade Study Files can be saved/restored if the user chooses to do so. + + + + + +Example demonstrating how to query the IAddToModel object for the Registry ID: +``` +Dim atm As IAddToModel + +Dim Str As String +Str=atm.getRegID() +``` + + + + + + +**Returns**: + +Registry ID of the Plug-In. + + + +**Return type**: BSTR + + +### Function addInput + +![][public] + +``` +IDispatch * ModelCenter::IAddToModel::addInput(BSTR name, BSTR type, [optional]VARIANT value) +``` + + + +Adds a pending input variable to the IAddToModel object IO structure. The IAddToModel object's input variables are updated when the [addToModel()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a58f5f3bc676a7c683ea4fc9b531d608f) or [updateComponent()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a7f5a3a1914714827435dfd59e9be5e32) methods are called. + + + + + + +**Parameters**: + +* **name**: The name of the pending variable. +* **type**: The type of the variable. Add "[]" to the end of the type to indicate an array.
+ Valid types include: +* "double" - double + +* "int" - integer + +* "string" - string + +* "bool" - boolean + +* "ref" - reference + +* "file" - A binary or ascii file + +* "object" - object variable (The default class type "PHXNonStrictType" will be used) + +* "quad" - Quad Facet Geometry, a geometry type composed of multiple quadrilaterals. + +* "sor" - Surface of Revolution, a geometry type defined by a profile curve rotated about an axis. + +* "nurbs" - A geometry type for NURBS. + +* "bspline" - A geometry type for B-Spline curves. + +* "ruled" - A geometry type for ruled surfaces. + +* "skinned" - A geometry type for skinned surfaces. + +* "node" - A geometry type for displaying multiple points in space. +* **value**: Value of the variable. If the variable is an array, then each variable value should be separated by a semi-colon:
+ addInput( "myVar", "double[]", "0;1;2.3;4.56" ) + + +**Returns**: + +IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object + + + +**Parameters**: + +* BSTR **name** +* BSTR **type** +* _[optional]_ VARIANT **value** + +**Return type**: IDispatch * + + +### Function addOutput + +![][public] + +``` +IDispatch * ModelCenter::IAddToModel::addOutput(BSTR name, BSTR type, [optional]VARIANT value) +``` + + + +Adds a pending output variable to the IAddToModel object IO structure. The IAddToModel object's output variables are updated when the [addToModel()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a58f5f3bc676a7c683ea4fc9b531d608f) or [updateComponent()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a7f5a3a1914714827435dfd59e9be5e32) methods are called. + + + + + + +**Parameters**: + +* **name**: The name of the pending variable. +* **type**: The type of the variable. Add "[]" to the end of the type to indicate an array.
+ Valid types include: +* "double" - double + +* "int" - integer + +* "string" - string + +* "bool" - boolean + +* "ref" - reference + +* "file" - A binary or ascii file + +* "object" - object variable (The default class type "PHXNonStrictType" will be used) + +* "quad" - Quad Facet Geometry, a geometry type composed of multiple quadrilaterals. + +* "sor" - Surface of Revolution, a geometry type defined by a profile curve rotated about an axis. + +* "nurbs" - A geometry type for NURBS. + +* "bspline" - A geometry type for B-Spline curves. + +* "ruled" - A geometry type for ruled surfaces. + +* "skinned" - A geometry type for skinned surfaces. + +* "node" - A geometry type for displaying multiple points in space. +* **value**: Value of the variable. If the variable is an array, then each variable value should be separated by a semi-colon:
+ addInput( "myVar", "double[]", "0;1;2.3;4.56" ) + + +**Returns**: + +IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object + + + +**Parameters**: + +* BSTR **name** +* BSTR **type** +* _[optional]_ VARIANT **value** + +**Return type**: IDispatch * + + +### Function getProgID + +![][public] + +``` +BSTR ModelCenter::IAddToModel::getProgID() +``` + + + +Gets the ProgID for COM Plug-Ins. The ProgID is the the string used to create an instance of a COM object (ex. "Phoenix.myPlugIn"). + + + + + +Example demonstrating how to get the ProgID of a Plug-In: +``` +Dim atm As IAddToModel + +Dim Str As String +Str=atm.getProgID() +``` + + + + + + +**Returns**: + +ProgID of the COM Plug-In. + + + +**Return type**: BSTR + + +### Function setAuthor + +![][public] + +``` +void ModelCenter::IAddToModel::setAuthor(BSTR author) +``` + + + +Defines the author of this Plug-In. Use this method to set the Component metadata when you add a Trade Study or Data Collector Plug-In to the Model. + + + + + + +**Parameters**: + +* **author**: The author of this Plug-In. + + + +**Parameters**: + +* BSTR **author** + +**Return type**: void + + +### Function setDescription + +![][public] + +``` +void ModelCenter::IAddToModel::setDescription(BSTR description) +``` + + + +Defines the description of this Plug-In. Use this method to set the Component metadata when you add a Trade Study or Data Collector Plug-In to the Model. + + + + + + +**Parameters**: + +* **description**: The description for this Plug-In. + + + +**Parameters**: + +* BSTR **description** + +**Return type**: void + + +### Function setVersion + +![][public] + +``` +void ModelCenter::IAddToModel::setVersion(BSTR version) +``` + + + +Defines the version of this Plug-In. Use this method to set the Component metadata when you add a Trade Study or Data Collector Plug-In to the Model. + + + + + + +**Parameters**: + +* **version**: The version information for this Plug-In. + + + +**Parameters**: + +* BSTR **version** + +**Return type**: void + + +### Function setHelpURL + +![][public] + +``` +void ModelCenter::IAddToModel::setHelpURL(BSTR helpURL) +``` + + + +Defines the help URL of this Plug-In. Use this method to set the Component metadata when you add a Trade Study or Data Collector Plug-In to the Model. + + + + + + +**Parameters**: + +* **helpURL**: The help URL for this Plug-In. + + + +**Parameters**: + +* BSTR **helpURL** + +**Return type**: void + + +### Function setKeywords + +![][public] + +``` +void ModelCenter::IAddToModel::setKeywords(BSTR keywords) +``` + + + +Defines the keywords for this Plug-In. Use this method to set the Component metadata when you add a Trade Study or Data Collector Plug-In to the Model. + + + + + + +**Parameters**: + +* **keywords**: The keywords for this Plug-In. + + + +**Parameters**: + +* BSTR **keywords** + +**Return type**: void + + +### Function clearBusyFlag + +![][public] + +``` +void ModelCenter::IAddToModel::clearBusyFlag() +``` + + + +Clears the busy state of [ModelCenter](namespaceModelCenter.md#namespaceModelCenter). + + + +**Return type**: void + + +### Function addToModel2 + +![][public] + +``` +boolean ModelCenter::IAddToModel::addToModel2() +``` + + + +Adds a Trade Study or Data Collector Plug-In to the Model as a Component Plug-In. This method is not allowed to be called in the run() method. + + + + + + +**Returns**: + +Whether or not the operation completed successfully. + + + +**Return type**: boolean + + +### Function setComponentRequirements + +![][public] + +``` +void ModelCenter::IAddToModel::setComponentRequirements(BSTR compReq) +``` + + + +Defines the requirements for this Plug-In. Use this method to set the Component metadata when you add a Trade Study or Data Collector Plug-In to the Model. + + + + + + +**Parameters**: + +* **compReq**: A comma separated list of requirement specifiers for this Plug-In. + + + +**Parameters**: + +* BSTR **compReq** + +**Return type**: void + + +### Function setIcon + +![][public] + +``` +void ModelCenter::IAddToModel::setIcon(BSTR iconFile) +``` + + + +Sets the Plug-In icon. +**Parameters**: + +* **iconFile**: The file path to the icon file. + + + +**Parameters**: + +* BSTR **iconFile** + +**Return type**: void + + +### Function addMethod + +![][public] + +``` +void ModelCenter::IAddToModel::addMethod(BSTR name, [optional]VARIANT displayName) +``` + + + +Adds the method. + + + + + + +**Parameters**: + +* **name**: The name of the method. +* **displayName**: The display name of the method. + + + +**Parameters**: + +* BSTR **name** +* _[optional]_ VARIANT **displayName** + +**Return type**: void + + +### Function addInput2 + +![][public] + +``` +IDispatch * ModelCenter::IAddToModel::addInput2(BSTR name, BSTR type, BSTR classURL, [optional]VARIANT value) +``` + + + +Adds a pending input variable to the IAddToModel object IO structure. The IAddToModel object's input variables are updated when the [addToModel()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a58f5f3bc676a7c683ea4fc9b531d608f) or [updateComponent()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a7f5a3a1914714827435dfd59e9be5e32) methods are called. This method can be used to add an "object" variable with a specified class type. + + + + + + +**Parameters**: + +* **name**: The name of the pending variable. +* **type**: The type of the variable. Add "[]" to the end of the type to indicate an array.
+ Valid types include: +* "double" - double + +* "int" - integer + +* "string" - string + +* "bool" - boolean + +* "ref" - reference + +* "file" - A binary or ascii file + +* "object" - object variable (The default class type "PHXNonStrictType" will be used if classURL is empty) + +* "quad" - Quad Facet Geometry, a geometry type composed of multiple quadrilaterals. + +* "sor" - Surface of Revolution, a geometry type defined by a profile curve rotated about an axis. + +* "nurbs" - A geometry type for NURBS. + +* "bspline" - A geometry type for B-Spline curves. + +* "ruled" - A geometry type for ruled surfaces. + +* "skinned" - A geometry type for skinned surfaces. + +* "node" - A geometry type for displaying multiple points in space. +* **classURL**: Class of the object variable. If an empty string is passed, PHXNonStrictType will be used. +* **value**: Value of the variable. If the variable is an array, then each variable value should be separated by a semi-colon:
+ addInput( "myVar", "double[]", "0;1;2.3;4.56" ) + + +**Returns**: + +IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object + + + +**Parameters**: + +* BSTR **name** +* BSTR **type** +* BSTR **classURL** +* _[optional]_ VARIANT **value** + +**Return type**: IDispatch * + + +### Function addOutput2 + +![][public] + +``` +IDispatch * ModelCenter::IAddToModel::addOutput2(BSTR name, BSTR type, BSTR classURL, [optional]VARIANT value) +``` + + + +Adds a pending output variable to the IAddToModel object IO structure. The IAddToModel object's output variables are updated when the [addToModel()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a58f5f3bc676a7c683ea4fc9b531d608f) or [updateComponent()](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1a7f5a3a1914714827435dfd59e9be5e32) methods are called. + + + + + + +**Parameters**: + +* **name**: The name of the pending variable. +* **type**: The type of the variable. Add "[]" to the end of the type to indicate an array.
+ Valid types include: +* "double" - double + +* "int" - integer + +* "string" - string + +* "bool" - boolean + +* "ref" - reference + +* "file" - A binary or ascii file + +* "object" - object variable (The default class type "PHXNonStrictType" will be used) + +* "quad" - Quad Facet Geometry, a geometry type composed of multiple quadrilaterals. + +* "sor" - Surface of Revolution, a geometry type defined by a profile curve rotated about an axis. + +* "nurbs" - A geometry type for NURBS. + +* "bspline" - A geometry type for B-Spline curves. + +* "ruled" - A geometry type for ruled surfaces. + +* "skinned" - A geometry type for skinned surfaces. + +* "node" - A geometry type for displaying multiple points in space. +* **classURL**: Class of the object variable. If an empty string is passed, PHXNonStrictType will be used. +* **value**: Value of the variable. If the variable is an array, then each variable value should be separated by a semi-colon:
+ addInput( "myVar", "double[]", "0;1;2.3;4.56" ) + + +**Returns**: + +IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object + + + +**Parameters**: + +* BSTR **name** +* BSTR **type** +* BSTR **classURL** +* _[optional]_ VARIANT **value** + +**Return type**: IDispatch * + + +### Function addToModel3 + +![][public] + +``` +BSTR ModelCenter::IAddToModel::addToModel3(BSTR suggestedName) +``` + + + +Adds a Trade Study or Data Collector Plug-In to the Model as a Component Plug-In. This method is not allowed to be called in the run() method. + + + + + + +**Parameters**: + +* **suggestedName**: Desired name for the component. This name will be used unless a component of that name already exists, in which case the variable name will be the desired name plus a number tagged on to the end. + + +**Returns**: + +Whether or not the operation completed successfully. + + + +**Parameters**: + +* BSTR **suggestedName** + +**Return type**: BSTR + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IArray.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IArray.md index 22ad5c0948..2d9e08a676 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IArray.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IArray.md @@ -1,1388 +1,1387 @@ - -# Interface ModelCenter::IArray - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 421) - - - -Base class for all array types. Has common functionality for getting/setting array sizes and getting/setting values as strings. - - - - - -Arrays start at 0 length by default. So you must set the size before you can assign individual array elements. - -**Inherits from**: - -* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) - -**Inherited by**: - -* [ModelCenter::IBooleanArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray) -* [ModelCenter::IDoubleArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray) -* [ModelCenter::IFileArray](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray) -* [ModelCenter::IIntegerArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray) -* [ModelCenter::IReferenceArray](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray) -* [ModelCenter::IStringArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray) - -## Members - -* [autoSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aca63a47369d69cbbf53532286b64a611) -* [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) -* [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) -* [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) -* [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) -* [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) -* [fromStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad23f4082662c464be07251d6d1695a2d) -* [getDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a83abe70ccf5e8a0a582748d84e3d7956) -* [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) -* [getLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) -* [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) -* [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) -* [getSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a3d171136e0b219dd4e2d0d1b4bb9aa1f) -* [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) -* [hasChanged](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad7310b48379f9d4f8d4688d11ccf0185) -* [hide](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac7ae926ce6dea385cb26901c86c7fccd) -* [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) -* [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) -* [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) -* [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) -* [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) -* [length](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af118bdf4b120050d6700a7ceae7f5bec) -* [numDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a29af128098031d3d75f20bb0fafe633a) -* [OwningComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aab060b2f29895c77882494f7194f55e0) -* [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) -* [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) -* [setDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) -* [setLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) -* [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) -* [setSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b7b41ca5463a86aecb2368d73464c0e) -* [size](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a9a38726b51caed75a30ae66b82959f64) -* [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) -* [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) -* [toStringAbsoluteEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a2e3041440581aab716c684fe88d2ee87) -* [toStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a37c622ae9f50579f714ce98c0379cd98) -* [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) - -## Properties - - -### Property hasChanged - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IArray::hasChanged -``` - - - - - - - -**Return type**: boolean - - -### Property hide - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IArray::hide -``` - - - - - - - -**Return type**: boolean - - -### Property OwningComponent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IArray::OwningComponent -``` - - - - - - - -**Return type**: LPDISPATCH - - -### Property size - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IArray::size -``` - - - -Alias for length property - - - -**Return type**: long - - -### Property autoSize - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IArray::autoSize -``` - - - -Whether or not the array is set to automatically size itself. If false and the array is linked from upstream, the upstream array must be exactly the same size or an error ensues. If true, the array will resize itself when the link is validated. - - - -**Return type**: boolean - - -### Property numDimensions - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IArray::numDimensions -``` - - - -Number of dimensions this array has. Defaults to 1. Changing the number of dimensions will lose all previous data in the array. - - - -**Return type**: long - - -### Property length - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IArray::length -``` - - - -Size of the array. Alias for the length property. Only useful if the array is 1 dimensional. Use the [getLength()](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb), [setLength()](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8), numDimensions, or [setDimensions()](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) methods and properties for multi-dimensional arrays On initialization, the array is 0 length by default. To fill in values on a newly created array, set the size/length first. - - - -**Return type**: long - -## Public functions - - -### Function isValid - -![][public] - -``` -boolean ModelCenter::IArray::isValid() -``` - - - -Finds out whether or not the array is valid. - - - - - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Return type**: boolean - -**Reimplements**: [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) - -**Reimplemented by**: - -* [isValid](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d13fb275a266aa85280b6beed8be176) -* [isValid](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a4d7719052c0b341f91436d3a0da270cc) -* [isValid](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a1d3371b70abb06b2eff5d1ada8aa114f) -* [isValid](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ab3d891c3978182e073923a56b4dbe89b) -* [isValid](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a366cf132edcae4c78ff3c3c29d81ad03) -* [isValid](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8b738f7eef3f9a3f8a723cede3809f47) - - -### Function validate - -![][public] - -``` -void ModelCenter::IArray::validate() -``` - - - -Causes the array to validate itself. - - - -**Return type**: void - -**Reimplements**: [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) - -**Reimplemented by**: - -* [validate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa221cef15629c5acf569329c0e089b3a) -* [validate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1abc755512c485531a61f10d2bc5d691b0) -* [validate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a506a66d66cb52b49d7385351bf0cfa46) -* [validate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a84ab133f5b1147d475fb8e2c4275b32b) -* [validate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1af1dd28c351fcda3e3fea31facbd4fca3) -* [validate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a86b82bcfb1ccfa2428968307eaa07108) - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IArray::getName() -``` - - - -Gets the name of the array. - - - - - - -**Returns**: - -The name of the array. - - - -**Return type**: BSTR - -**Reimplements**: [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) - -**Reimplemented by**: - -* [getName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a471100848db5a6f0c08f2920aa283ac6) -* [getName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe2789906f30f6a082e5d3d79e2b5bbc) -* [getName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a3f04f85ebe4f50a88c7cc3a61ae597f6) -* [getName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a79fdcc3e290b4b0df816f69d8a8d5f9d) -* [getName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a282d98574e8d65d85c9908b6799321b7) -* [getName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a0a90870618bd396edc53c27ff0b8c9af) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IArray::getFullName() -``` - - - -Gets the full ModelCenter path of the array. - - - - - - -**Returns**: - -The full ModelCenter path of the array. - - - -**Return type**: BSTR - -**Reimplements**: [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) - -**Reimplemented by**: - -* [getFullName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a498741fde4d9eeec6eb3f8171e3161d8) -* [getFullName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a225331135b6efad1b05c399869975962) -* [getFullName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7aada275954e2fff6bdea69b8a96bd0c) -* [getFullName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a8c74276fefc00a8b85a576e1d1b58053) -* [getFullName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a44ebe17869a3b1b95568ea46299a9f3f) -* [getFullName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4ca185e60b69ce2ff41d19a2270bc28b) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IArray::getType() -``` - - - -Gets the type of the array. - - - - - - -**Returns**: - -The type of the array as a string. - - - -**Return type**: BSTR - -**Reimplements**: [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) - -**Reimplemented by**: - -* [getType](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad8d2b43dd9f4b3656dba1e8570f7f747) -* [getType](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a59535b93acdadae5c47ebb3f148cc8a7) -* [getType](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a6614c3d1ae621d218762e8ed8ec58222) -* [getType](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a05e311dcfb051f0df6afc99dd01d6773) -* [getType](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac3c3f33a239fe1182da434d7570346df) -* [getType](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a582f9e8e47e60eca8041b98c996a4f4f) - - -### Function isInput - -![][public] - -``` -boolean ModelCenter::IArray::isInput() -``` - - - -Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) - -**Reimplemented by**: - -* [isInput](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa87e846de03852ee40e909935c2ec470) -* [isInput](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa0a3e17384092dbeb0cef004db873191) -* [isInput](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9e45ea90908321e84979e5b8d2f50357) -* [isInput](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a3752394336c9689384efac1005422431) -* [isInput](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ae7e5c76cfd592a71fc7e5785c7cf6394) -* [isInput](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a3b7b397239f04cf9ea9358f9477ee2c4) - - -### Function toString - -![][public] - -``` -BSTR ModelCenter::IArray::toString() -``` - - - -Converts the array to a string, validating the array if necessary. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. - - - - - - -**Returns**: - -The converted string value of the array. - - - -**Return type**: BSTR - -**Reimplements**: [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) - -**Reimplemented by**: - -* [toString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a39294beb6d830e498ee8aca7a25cc4a6) -* [toString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1af417ef0e71fabce8379be30e4d176355) -* [toString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7ba909789490822b7ab12891075a9e56) -* [toString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a83e5e9905df758b37c901bae5e87430e) -* [toString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aaa37debc6216a5419715e0c542555850) -* [toString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1aa735025db3ac6e13cb486f8629b86a69) - - -### Function fromString - -![][public] - -``` -void ModelCenter::IArray::fromString(BSTR value) -``` - - - -Sets the value of the array from a specified string. For 1D arrays, the specification is of the form '1,2,3'.
-For nD arrays, the specification is of the form 'bounds[2,2,2] {1,2,3,4,5,6,7,8}'.
-String arrays may optionally have the elements quoted in the form 'bounds[2,3] {"a", "b,c", "d", "", "e", "f"}' - - - - - - -**Parameters**: - -* **value**: New value. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - -**Reimplements**: [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) - -**Reimplemented by**: - -* [fromString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1af5d6c192774673f4f4bf7514b35f8ccf) -* [fromString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3faefed33c99ee3ffb10b5e0e21d239a) -* [fromString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab107312b8a5b1e8e96ae2a3678ef9897) -* [fromString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af3d5cd8601c1227d439b7b3f74cc2d16) -* [fromString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9cb9dab871b4e86ed66fb53cc5473ebd) -* [fromString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a65a839b63dfb0495f577bf70ca87a320) - - -### Function toStringAbsolute - -![][public] - -``` -BSTR ModelCenter::IArray::toStringAbsolute() -``` - - - -Converts the array to a string. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. - - - - - - -**Returns**: - -The converted string value of the array. - - - -**Return type**: BSTR - -**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) - -**Reimplemented by**: - -* [toStringAbsolute](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa07f73fa1f449045d77725b0fef00739) -* [toStringAbsolute](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1adbd82fbad4622d8c2d91533d536a7ea0) -* [toStringAbsolute](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ac8f43fca8b974b224bd64a78bd3bdda3) -* [toStringAbsolute](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5bc139ce096dbc917734386869a3be78) -* [toStringAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a1a0ecbbccb3fe3404c79976e9f07b8db) -* [toStringAbsolute](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1adfb1dee0a1fd5b541eacba1e4cbba7ad) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IArray::invalidate() -``` - - - -Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. - - - -**Return type**: void - -**Reimplements**: [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) - -**Reimplemented by**: - -* [invalidate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a04e162fdfae6e99e6dcfd926adfca7b1) -* [invalidate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a032e132c6c6a61f81370942921ab2edf) -* [invalidate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7599948212f77bb66f8ef42fc98e53ce) -* [invalidate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a521514c594a1ab4e30669305585530b7) -* [invalidate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a56ea1d83eb42dda4a7c06b6fbbf6ffd5) -* [invalidate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac6dd084c61d7ce2631d207242eca89bf) - - -### Function directPrecedents - -![][public] - -``` -LPDISPATCH ModelCenter::IArray::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) - -**Reimplemented by**: - -* [directPrecedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a605c25813e75d1709e364eef080f68e9) -* [directPrecedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3ab4fe76950c76fbdd2e76ea3f4fb08b) -* [directPrecedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9f84f73f3b65f16fa507678c53c67527) -* [directPrecedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae3879cd50b0512f2b5660765393bd24e) -* [directPrecedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aa8041fca418266f2bee129804654abab) -* [directPrecedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a40c76b900187ef244f14c5c8e9bb65bf) - - -### Function directDependents - -![][public] - -``` -LPDISPATCH ModelCenter::IArray::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) - -**Reimplemented by**: - -* [directDependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a6ed20fe44044c682471c7066ae2bd303) -* [directDependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe14e74990edda2c656035bbcd8e2af2) -* [directDependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab61572acbd0617f5c51b04b2ae4bbdba) -* [directDependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a44b3a3cc73cd46ea7661e776b20b4ded) -* [directDependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a862a4306dbf867e3db316d9547cea277) -* [directDependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4820176e7ca9e1c3173d602308144c62) - - -### Function precedentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IArray::precedentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) - -**Reimplemented by**: - -* [precedentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a428a6e6a2a2be52d77bfe96323fea64f) -* [precedentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a640715d1e272c8f15d8cc4c2b466d990) -* [precedentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a998c2f1327219560aacd3d65d2c178b6) -* [precedentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ac71c9a184e57f627b336438de0b7a238) -* [precedentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a084d49d02b9ff5812166721fcdc86018) -* [precedentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a19c1ae9d08b968bae4b6fdd1ec74fc3e) - - -### Function dependentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IArray::dependentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) - -**Reimplemented by**: - -* [dependentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1abadb81820fd0b415fa9e78ce6c867c55) -* [dependentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a0201276e7d000c4869e4798cfdb68d8b) -* [dependentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a90373b06919789f06f52dd22a0339847) -* [dependentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a399b9b49ca3133d2a49923637f19609a) -* [dependentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1add9bd8c41cd4a5c77f7e762768b441a5) -* [dependentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4227d6aca4e2d7791cea69efeb5b81fd) - - -### Function precedents - -![][public] - -``` -LPDISPATCH ModelCenter::IArray::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) - -**Reimplemented by**: - -* [precedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d7349a2273e5b9eaaab5271918eed6f) -* [precedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a5973cfc6b1e41db214568a7e95979eef) -* [precedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1abf61619be1e057cf2c42189456169041) -* [precedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a01bd8fce84abbb243a9f7e3c771c185c) -* [precedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aea1973c58e45bafe3aeea797b91a4f6b) -* [precedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a913272799193e5d02033c63c746ead9e) - - -### Function dependents - -![][public] - -``` -LPDISPATCH ModelCenter::IArray::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) - -**Reimplemented by**: - -* [dependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a386477ffe54e2d0f351f9dc7fbb49712) -* [dependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a6e0601946499c985be03e00354c8acb3) -* [dependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1af16a20eacc6734b343762565ec8b20d6) -* [dependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af6712999aa6e50091a95dd66db088661) -* [dependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a7a3b136537fb09914b87b5997b937df0) -* [dependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a392d8e4080854c954c165833bb89a7db) - - -### Function isInputToComponent - -![][public] - -``` -boolean ModelCenter::IArray::isInputToComponent() -``` - - - -Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) - -**Reimplemented by**: - -* [isInputToComponent](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a871c46c1f732b2885e2ef1fa2080a3e8) -* [isInputToComponent](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a86e51010b5f7765c036af36bd9452622) -* [isInputToComponent](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a29e9bceef09e96ad83ce6c0618eb17dd) -* [isInputToComponent](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a2a19aa7ca1e4c4fb862016aede378c05) -* [isInputToComponent](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a317b7b47fa55798e212c426b4ac8f014) -* [isInputToComponent](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ad59d273bea1a7e02540520e9b4428264) - - -### Function isInputToModel - -![][public] - -``` -boolean ModelCenter::IArray::isInputToModel() -``` - - - -Checks whether or not the variable is an input. A linked input returns false (Output). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) - -**Reimplemented by**: - -* [isInputToModel](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a364726a017aca71bdb22d43530cc9426) -* [isInputToModel](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a78d5b37b715d259e29e0de79fa58508d) -* [isInputToModel](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1accf93e4a9fe2c9eb205ccdf1704f3f9e) -* [isInputToModel](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a41c321c0260174a4c118e309fbd13085) -* [isInputToModel](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2d16dbc50ee0f77d5ca99b8a600e5023) -* [isInputToModel](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1af1da4c99c6359d527ad57c9433333a36) - - -### Function setMetadata - -![][public] - -``` -void ModelCenter::IArray::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) -``` - - - -Sets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata specifier used to store the data. -* **type**:
-* **value**:
-* **access**:
-* **archive**:
- - - -**Parameters**: - -* BSTR **name** -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** -* VARIANT **value** -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** -* boolean **archive** - -**Return type**: void - -**Reimplements**: [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) - -**Reimplemented by**: - -* [setMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a772ffc624a737a4808eb8dfc9ff41e0d) -* [setMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a56d1d2b85ec3b4c43589c25887c1dd95) -* [setMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a46a06089e51539cdb69a6404db042d28) -* [setMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae69f586d5f6a7cf93728f99a47b841cf) -* [setMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a31e14e94dd9316f40bf963a9da9939f7) -* [setMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a495551c5a05027a8537ffce75f333f8e) - - -### Function getMetadata - -![][public] - -``` -VARIANT ModelCenter::IArray::getMetadata(BSTR name) -``` - - - -Gets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata key name. - - -**Returns**: - -Metadata value. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -**Reimplements**: [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) - -**Reimplemented by**: - -* [getMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa6b44db219dbaf49be81841dc459f4ae) -* [getMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a1a41489453d177315ae18ef464e8907b) -* [getMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ae315b5cc3acb88a2edabaa8eea7a6690) -* [getMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a76933c6f159d52907c0b9f6ba3d13136) -* [getMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac6becc1bb1c5206e972c266164f838ca) -* [getMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac730dc0fbfc8ae56788048e6c0fb80fa) - - -### Function toStringEx - -![][public] - -``` -BSTR ModelCenter::IArray::toStringEx(long index) -``` - - - -Converts the value of an array element to a string, validating the array if necessary. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The value of the element as a string. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - -**Reimplemented by**: - -* [toStringEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1af151b1686dbe379f876131afd8c2c71e) -* [toStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ac16f0cbbb0d4c51cb5cc7dfc0c251f88) -* [toStringEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1afac8b4ceedd459ad68bed98ae18ea6a8) -* [toStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae3d6633e9533a68590025dee14298912) -* [toStringEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1af2ff697565c81552d49c0237cfc89ef7) -* [toStringEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a9013b29e3ca18c5a0ecaff8dc6d19b5f) - - -### Function fromStringEx - -![][public] - -``` -void ModelCenter::IArray::fromStringEx(BSTR value, long index) -``` - - - -Sets the value of an array element from a specified string. - - - - - - -**Parameters**: - -* **value**: New value. -* **index**: Index of the array element (0-based index). - - - -**Parameters**: - -* BSTR **value** -* long **index** - -**Return type**: void - -**Reimplemented by**: - -* [fromStringEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a8d7b18dca2bbe96aa0ee3718e433e272) -* [fromStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad068bdf2a8fb66fea7cfb3a3111fb176) -* [fromStringEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aa104ba67a0164c27a33017aabd29d83d) -* [fromStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a26f9cfd27774a2233ae2cb232cc8fec9) -* [fromStringEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2a286a07b606f7e90ac4e1d281a49d38) -* [fromStringEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8fa6aff7c64224c1c488d5866dfc4865) - - -### Function toStringAbsoluteEx - -![][public] - -``` -BSTR ModelCenter::IArray::toStringAbsoluteEx(long index) -``` - - - -Converts the value of an array element to a string. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The value of the element as a string. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - -**Reimplemented by**: - -* [toStringAbsoluteEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aaa425c05112e2f9568bb13886800dbba) -* [toStringAbsoluteEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab1252981582cec6fd3662321c9c4ce28) -* [toStringAbsoluteEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a15dfd2825b183a80b93d849ce3429ca3) -* [toStringAbsoluteEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5794b0c172b46da36d761bf31046db07) -* [toStringAbsoluteEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aac2b33985ad310362db7c8c878096ae8) -* [toStringAbsoluteEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a3684e3b0b2d36a599f75236a6f5e90e7) - - -### Function getLength - -![][public] - -``` -long ModelCenter::IArray::getLength([optional] VARIANT dim) -``` - - - -Get the length of the n'th dimension of the array. - - - - - - -**Parameters**: - -* **dim**: Dimension of the array to query. This uses a 0 based index, so 0 will give you the first dimension, 1 the second, etc. If omitted, gives the first dimension - - -**Returns**: - -Length(size) of the array. - - - -**Parameters**: - -* _[optional]_ VARIANT **dim** - -**Return type**: long - -**Reimplemented by**: - -* [getLength](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad9da4a66a831de9a501a7aca13a6a84f) -* [getLength](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab0632e518febc3b1549fc35d932fd451) -* [getLength](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1acb6d739a4e50bcbbda5a5cf053ae21db) -* [getLength](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a8167ef387b9cc11bc76e9a0e0694a833) -* [getLength](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad88eff947daa184ab953839666729ae5) -* [getLength](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a39098992a1f29458010e4d18385d3681) - - -### Function setLength - -![][public] - -``` -void ModelCenter::IArray::setLength(long length, [optional] VARIANT dim) -``` - - - -Sets the length of the n'th dimension of the array - - - - - - -**Parameters**: - -* **length**: New length of the n'th dimension of the array -* **dim**: The dimension to set. This uses a 0 based index, so 0 will set the first dimension, 1 the second, etc. If omitted, sets the first dimension - - - -**Parameters**: - -* long **length** -* _[optional]_ VARIANT **dim** - -**Return type**: void - -**Reimplemented by**: - -* [setLength](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a2bf47781f038fae8dc22e6edb04149a9) -* [setLength](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a5e70599413156ef04aa8ddfd03958320) -* [setLength](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a66119cc8d733c8a2d6a8101569768662) -* [setLength](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a91d122341cefcb887c3871d43ea34524) -* [setLength](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2cfaecd2a821841d414f0d9ac505659f) -* [setLength](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ab20a6b27ddb532d0186532a52a148d91) - - -### Function setDimensions - -![][public] - -``` -void ModelCenter::IArray::setDimensions(long d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Sets the number of dimensions of an array and the length of each dimension in one call. An array initializes to 0 length. If any dimension of the array has 0 length, the whole array contains no data. You must set the array size before filling in values unless you are using the setArray() call. - - - - - - -**Parameters**: - -* **d1**: length of the 1st dimension of the array -* **d2**: length of the 2nd dimension of the array. If omitted, the array is 1 dimensional -* **d3**: length of the 3rd dimension of the array. If omitted, the array is 2 dimensional -* **d4**: length of the 4th dimension of the array. If omitted, the array is 3 dimensional -* **d5**: length of the 5th dimension of the array. If omitted, the array is 4 dimensional -* **d6**: length of the 6th dimension of the array. If omitted, the array is 5 dimensional -* **d7**: length of the 7th dimension of the array. If omitted, the array is 6 dimensional -* **d8**: length of the 8th dimension of the array. If omitted, the array is 7 dimensional -* **d9**: length of the 9th dimension of the array. If omitted, the array is 8 dimensional -* **d10**: length of the 10th dimension of the array. If omitted, the array is 9 dimensional - - - -**Parameters**: - -* long **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: void - -**Reimplemented by**: - -* [setDimensions](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a6a526c3b8680b1f5ececc326a340d14b) -* [setDimensions](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a397d1abf4ecf0a106e84112b5634efac) -* [setDimensions](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a791424f1645b40c0b9b9d509effb1df8) -* [setDimensions](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a1010ee85bb6325b98fab48f96b582103) -* [setDimensions](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a3526172d364bb842ab3bc25f1cedf31b) -* [setDimensions](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1aa3a9cdee8b632a3adda4e2d1814c66f8) - - -### Function getSize - -![][public] - -``` -long ModelCenter::IArray::getSize([optional] VARIANT dim) -``` - - - -Alias for the [getLength()](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) call - - - - - - -**Parameters**: - -* **dim**: Dimension of the array to query(0-based index). - - -**Returns**: - -Size of the dimension - - - -**Parameters**: - -* _[optional]_ VARIANT **dim** - -**Return type**: long - - -### Function setSize - -![][public] - -``` -void ModelCenter::IArray::setSize(long length, [optional] VARIANT dim) -``` - - - -Alias for the [setLength()](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) call - - - - - - -**Parameters**: - -* **length**: Length of the specified dimension -* **dim**: The dimension to set (0-based index). - - - -**Parameters**: - -* long **length** -* _[optional]_ VARIANT **dim** - -**Return type**: void - - -### Function getDimensions - -![][public] - -``` -VARIANT ModelCenter::IArray::getDimensions() -``` - - - -Gets the dimensions of the array. - - - - - - -**Returns**: - -Variant - either a single integer, in the case of a 1D array, or an array of integers, in the case of multi-dimensional arrays. - - - -**Return type**: VARIANT - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IArray + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 421) + + + +Base class for all array types. Has common functionality for getting/setting array sizes and getting/setting values as strings. + + + + + +Arrays start at 0 length by default. So you must set the size before you can assign individual array elements. + +**Inherits from**: + +* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) + +**Inherited by**: + +* [ModelCenter::IBooleanArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray) +* [ModelCenter::IDoubleArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray) +* [ModelCenter::IFileArray](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray) +* [ModelCenter::IIntegerArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray) +* [ModelCenter::IReferenceArray](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray) +* [ModelCenter::IStringArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray) + +## Members + +* [autoSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aca63a47369d69cbbf53532286b64a611) +* [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) +* [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) +* [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) +* [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) +* [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) +* [fromStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad23f4082662c464be07251d6d1695a2d) +* [getDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a83abe70ccf5e8a0a582748d84e3d7956) +* [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) +* [getLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) +* [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) +* [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) +* [getSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a3d171136e0b219dd4e2d0d1b4bb9aa1f) +* [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) +* [hasChanged](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad7310b48379f9d4f8d4688d11ccf0185) +* [hide](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac7ae926ce6dea385cb26901c86c7fccd) +* [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) +* [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) +* [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) +* [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) +* [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) +* [length](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af118bdf4b120050d6700a7ceae7f5bec) +* [numDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a29af128098031d3d75f20bb0fafe633a) +* [OwningComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aab060b2f29895c77882494f7194f55e0) +* [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) +* [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) +* [setDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) +* [setLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) +* [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) +* [setSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b7b41ca5463a86aecb2368d73464c0e) +* [size](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a9a38726b51caed75a30ae66b82959f64) +* [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) +* [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) +* [toStringAbsoluteEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a2e3041440581aab716c684fe88d2ee87) +* [toStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a37c622ae9f50579f714ce98c0379cd98) +* [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) + +## Properties + + +### Property hasChanged + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IArray::hasChanged +``` + + + + + + + +**Return type**: boolean + + +### Property hide + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IArray::hide +``` + + + + + + + +**Return type**: boolean + + +### Property OwningComponent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IArray::OwningComponent +``` + + + + + + + +**Return type**: LPDISPATCH + + +### Property size + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IArray::size +``` + + + +Alias for length property + + + +**Return type**: long + + +### Property autoSize + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IArray::autoSize +``` + + + +Whether or not the array is set to automatically size itself. If false and the array is linked from upstream, the upstream array must be exactly the same size or an error ensues. If true, the array will resize itself when the link is validated. + + + +**Return type**: boolean + + +### Property numDimensions + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IArray::numDimensions +``` + + + +Number of dimensions this array has. Defaults to 1. Changing the number of dimensions will lose all previous data in the array. + + + +**Return type**: long + + +### Property length + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IArray::length +``` + + + +Size of the array. Alias for the length property. Only useful if the array is 1 dimensional. Use the [getLength()](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb), [setLength()](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8), numDimensions, or [setDimensions()](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) methods and properties for multi-dimensional arrays On initialization, the array is 0 length by default. To fill in values on a newly created array, set the size/length first. + + + +**Return type**: long + +## Public functions + + +### Function isValid + +![][public] + +``` +boolean ModelCenter::IArray::isValid() +``` + + + +Finds out whether or not the array is valid. + + + + + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Return type**: boolean + +**Reimplements**: [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) + +**Reimplemented by**: + +* [isValid](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d13fb275a266aa85280b6beed8be176) +* [isValid](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a4d7719052c0b341f91436d3a0da270cc) +* [isValid](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a1d3371b70abb06b2eff5d1ada8aa114f) +* [isValid](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ab3d891c3978182e073923a56b4dbe89b) +* [isValid](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a366cf132edcae4c78ff3c3c29d81ad03) +* [isValid](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8b738f7eef3f9a3f8a723cede3809f47) + + +### Function validate + +![][public] + +``` +void ModelCenter::IArray::validate() +``` + + + +Causes the array to validate itself. + + + +**Return type**: void + +**Reimplements**: [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) + +**Reimplemented by**: + +* [validate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa221cef15629c5acf569329c0e089b3a) +* [validate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1abc755512c485531a61f10d2bc5d691b0) +* [validate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a506a66d66cb52b49d7385351bf0cfa46) +* [validate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a84ab133f5b1147d475fb8e2c4275b32b) +* [validate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1af1dd28c351fcda3e3fea31facbd4fca3) +* [validate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a86b82bcfb1ccfa2428968307eaa07108) + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IArray::getName() +``` + + + +Gets the name of the array. + + + + + + +**Returns**: + +The name of the array. + + + +**Return type**: BSTR + +**Reimplements**: [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) + +**Reimplemented by**: + +* [getName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a471100848db5a6f0c08f2920aa283ac6) +* [getName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe2789906f30f6a082e5d3d79e2b5bbc) +* [getName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a3f04f85ebe4f50a88c7cc3a61ae597f6) +* [getName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a79fdcc3e290b4b0df816f69d8a8d5f9d) +* [getName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a282d98574e8d65d85c9908b6799321b7) +* [getName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a0a90870618bd396edc53c27ff0b8c9af) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IArray::getFullName() +``` + + + +Gets the full ModelCenter path of the array. + + + + + + +**Returns**: + +The full ModelCenter path of the array. + + + +**Return type**: BSTR + +**Reimplements**: [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) + +**Reimplemented by**: + +* [getFullName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a498741fde4d9eeec6eb3f8171e3161d8) +* [getFullName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a225331135b6efad1b05c399869975962) +* [getFullName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7aada275954e2fff6bdea69b8a96bd0c) +* [getFullName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a8c74276fefc00a8b85a576e1d1b58053) +* [getFullName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a44ebe17869a3b1b95568ea46299a9f3f) +* [getFullName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4ca185e60b69ce2ff41d19a2270bc28b) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IArray::getType() +``` + + + +Gets the type of the array. + + + + + + +**Returns**: + +The type of the array as a string. + + + +**Return type**: BSTR + +**Reimplements**: [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) + +**Reimplemented by**: + +* [getType](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad8d2b43dd9f4b3656dba1e8570f7f747) +* [getType](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a59535b93acdadae5c47ebb3f148cc8a7) +* [getType](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a6614c3d1ae621d218762e8ed8ec58222) +* [getType](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a05e311dcfb051f0df6afc99dd01d6773) +* [getType](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac3c3f33a239fe1182da434d7570346df) +* [getType](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a582f9e8e47e60eca8041b98c996a4f4f) + + +### Function isInput + +![][public] + +``` +boolean ModelCenter::IArray::isInput() +``` + + + +Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) + +**Reimplemented by**: + +* [isInput](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa87e846de03852ee40e909935c2ec470) +* [isInput](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa0a3e17384092dbeb0cef004db873191) +* [isInput](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9e45ea90908321e84979e5b8d2f50357) +* [isInput](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a3752394336c9689384efac1005422431) +* [isInput](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ae7e5c76cfd592a71fc7e5785c7cf6394) +* [isInput](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a3b7b397239f04cf9ea9358f9477ee2c4) + + +### Function toString + +![][public] + +``` +BSTR ModelCenter::IArray::toString() +``` + + + +Converts the array to a string, validating the array if necessary. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. + + + + + + +**Returns**: + +The converted string value of the array. + + + +**Return type**: BSTR + +**Reimplements**: [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) + +**Reimplemented by**: + +* [toString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a39294beb6d830e498ee8aca7a25cc4a6) +* [toString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1af417ef0e71fabce8379be30e4d176355) +* [toString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7ba909789490822b7ab12891075a9e56) +* [toString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a83e5e9905df758b37c901bae5e87430e) +* [toString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aaa37debc6216a5419715e0c542555850) +* [toString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1aa735025db3ac6e13cb486f8629b86a69) + + +### Function fromString + +![][public] + +``` +void ModelCenter::IArray::fromString(BSTR value) +``` + + + +Sets the value of the array from a specified string. For 1D arrays, the specification is of the form '1,2,3'.
+For nD arrays, the specification is of the form 'bounds[2,2,2] {1,2,3,4,5,6,7,8}'.
+String arrays may optionally have the elements quoted in the form 'bounds[2,3] {"a", "b,c", "d", "", "e", "f"}' + + + + + + +**Parameters**: + +* **value**: New value. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + +**Reimplements**: [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) + +**Reimplemented by**: + +* [fromString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1af5d6c192774673f4f4bf7514b35f8ccf) +* [fromString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3faefed33c99ee3ffb10b5e0e21d239a) +* [fromString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab107312b8a5b1e8e96ae2a3678ef9897) +* [fromString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af3d5cd8601c1227d439b7b3f74cc2d16) +* [fromString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9cb9dab871b4e86ed66fb53cc5473ebd) +* [fromString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a65a839b63dfb0495f577bf70ca87a320) + + +### Function toStringAbsolute + +![][public] + +``` +BSTR ModelCenter::IArray::toStringAbsolute() +``` + + + +Converts the array to a string. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. + + + + + + +**Returns**: + +The converted string value of the array. + + + +**Return type**: BSTR + +**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) + +**Reimplemented by**: + +* [toStringAbsolute](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa07f73fa1f449045d77725b0fef00739) +* [toStringAbsolute](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1adbd82fbad4622d8c2d91533d536a7ea0) +* [toStringAbsolute](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ac8f43fca8b974b224bd64a78bd3bdda3) +* [toStringAbsolute](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5bc139ce096dbc917734386869a3be78) +* [toStringAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a1a0ecbbccb3fe3404c79976e9f07b8db) +* [toStringAbsolute](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1adfb1dee0a1fd5b541eacba1e4cbba7ad) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IArray::invalidate() +``` + + + +Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. + + + +**Return type**: void + +**Reimplements**: [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) + +**Reimplemented by**: + +* [invalidate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a04e162fdfae6e99e6dcfd926adfca7b1) +* [invalidate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a032e132c6c6a61f81370942921ab2edf) +* [invalidate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7599948212f77bb66f8ef42fc98e53ce) +* [invalidate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a521514c594a1ab4e30669305585530b7) +* [invalidate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a56ea1d83eb42dda4a7c06b6fbbf6ffd5) +* [invalidate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac6dd084c61d7ce2631d207242eca89bf) + + +### Function directPrecedents + +![][public] + +``` +LPDISPATCH ModelCenter::IArray::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) + +**Reimplemented by**: + +* [directPrecedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a605c25813e75d1709e364eef080f68e9) +* [directPrecedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3ab4fe76950c76fbdd2e76ea3f4fb08b) +* [directPrecedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9f84f73f3b65f16fa507678c53c67527) +* [directPrecedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae3879cd50b0512f2b5660765393bd24e) +* [directPrecedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aa8041fca418266f2bee129804654abab) +* [directPrecedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a40c76b900187ef244f14c5c8e9bb65bf) + + +### Function directDependents + +![][public] + +``` +LPDISPATCH ModelCenter::IArray::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) + +**Reimplemented by**: + +* [directDependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a6ed20fe44044c682471c7066ae2bd303) +* [directDependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe14e74990edda2c656035bbcd8e2af2) +* [directDependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab61572acbd0617f5c51b04b2ae4bbdba) +* [directDependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a44b3a3cc73cd46ea7661e776b20b4ded) +* [directDependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a862a4306dbf867e3db316d9547cea277) +* [directDependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4820176e7ca9e1c3173d602308144c62) + + +### Function precedentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IArray::precedentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) + +**Reimplemented by**: + +* [precedentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a428a6e6a2a2be52d77bfe96323fea64f) +* [precedentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a640715d1e272c8f15d8cc4c2b466d990) +* [precedentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a998c2f1327219560aacd3d65d2c178b6) +* [precedentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ac71c9a184e57f627b336438de0b7a238) +* [precedentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a084d49d02b9ff5812166721fcdc86018) +* [precedentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a19c1ae9d08b968bae4b6fdd1ec74fc3e) + + +### Function dependentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IArray::dependentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) + +**Reimplemented by**: + +* [dependentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1abadb81820fd0b415fa9e78ce6c867c55) +* [dependentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a0201276e7d000c4869e4798cfdb68d8b) +* [dependentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a90373b06919789f06f52dd22a0339847) +* [dependentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a399b9b49ca3133d2a49923637f19609a) +* [dependentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1add9bd8c41cd4a5c77f7e762768b441a5) +* [dependentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4227d6aca4e2d7791cea69efeb5b81fd) + + +### Function precedents + +![][public] + +``` +LPDISPATCH ModelCenter::IArray::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) + +**Reimplemented by**: + +* [precedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d7349a2273e5b9eaaab5271918eed6f) +* [precedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a5973cfc6b1e41db214568a7e95979eef) +* [precedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1abf61619be1e057cf2c42189456169041) +* [precedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a01bd8fce84abbb243a9f7e3c771c185c) +* [precedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aea1973c58e45bafe3aeea797b91a4f6b) +* [precedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a913272799193e5d02033c63c746ead9e) + + +### Function dependents + +![][public] + +``` +LPDISPATCH ModelCenter::IArray::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) + +**Reimplemented by**: + +* [dependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a386477ffe54e2d0f351f9dc7fbb49712) +* [dependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a6e0601946499c985be03e00354c8acb3) +* [dependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1af16a20eacc6734b343762565ec8b20d6) +* [dependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af6712999aa6e50091a95dd66db088661) +* [dependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a7a3b136537fb09914b87b5997b937df0) +* [dependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a392d8e4080854c954c165833bb89a7db) + + +### Function isInputToComponent + +![][public] + +``` +boolean ModelCenter::IArray::isInputToComponent() +``` + + + +Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) + +**Reimplemented by**: + +* [isInputToComponent](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a871c46c1f732b2885e2ef1fa2080a3e8) +* [isInputToComponent](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a86e51010b5f7765c036af36bd9452622) +* [isInputToComponent](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a29e9bceef09e96ad83ce6c0618eb17dd) +* [isInputToComponent](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a2a19aa7ca1e4c4fb862016aede378c05) +* [isInputToComponent](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a317b7b47fa55798e212c426b4ac8f014) +* [isInputToComponent](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ad59d273bea1a7e02540520e9b4428264) + + +### Function isInputToModel + +![][public] + +``` +boolean ModelCenter::IArray::isInputToModel() +``` + + + +Checks whether or not the variable is an input. A linked input returns false (Output). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) + +**Reimplemented by**: + +* [isInputToModel](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a364726a017aca71bdb22d43530cc9426) +* [isInputToModel](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a78d5b37b715d259e29e0de79fa58508d) +* [isInputToModel](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1accf93e4a9fe2c9eb205ccdf1704f3f9e) +* [isInputToModel](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a41c321c0260174a4c118e309fbd13085) +* [isInputToModel](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2d16dbc50ee0f77d5ca99b8a600e5023) +* [isInputToModel](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1af1da4c99c6359d527ad57c9433333a36) + + +### Function setMetadata + +![][public] + +``` +void ModelCenter::IArray::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) +``` + + + +Sets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata specifier used to store the data. +* **type**:
+* **value**:
+* **access**:
+* **archive**:
+ + + +**Parameters**: + +* BSTR **name** +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** +* VARIANT **value** +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** +* boolean **archive** + +**Return type**: void + +**Reimplements**: [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) + +**Reimplemented by**: + +* [setMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a772ffc624a737a4808eb8dfc9ff41e0d) +* [setMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a56d1d2b85ec3b4c43589c25887c1dd95) +* [setMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a46a06089e51539cdb69a6404db042d28) +* [setMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae69f586d5f6a7cf93728f99a47b841cf) +* [setMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a31e14e94dd9316f40bf963a9da9939f7) +* [setMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a495551c5a05027a8537ffce75f333f8e) + + +### Function getMetadata + +![][public] + +``` +VARIANT ModelCenter::IArray::getMetadata(BSTR name) +``` + + + +Gets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata key name. + + +**Returns**: + +Metadata value. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +**Reimplements**: [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) + +**Reimplemented by**: + +* [getMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa6b44db219dbaf49be81841dc459f4ae) +* [getMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a1a41489453d177315ae18ef464e8907b) +* [getMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ae315b5cc3acb88a2edabaa8eea7a6690) +* [getMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a76933c6f159d52907c0b9f6ba3d13136) +* [getMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac6becc1bb1c5206e972c266164f838ca) +* [getMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac730dc0fbfc8ae56788048e6c0fb80fa) + + +### Function toStringEx + +![][public] + +``` +BSTR ModelCenter::IArray::toStringEx(long index) +``` + + + +Converts the value of an array element to a string, validating the array if necessary. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The value of the element as a string. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + +**Reimplemented by**: + +* [toStringEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1af151b1686dbe379f876131afd8c2c71e) +* [toStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ac16f0cbbb0d4c51cb5cc7dfc0c251f88) +* [toStringEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1afac8b4ceedd459ad68bed98ae18ea6a8) +* [toStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae3d6633e9533a68590025dee14298912) +* [toStringEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1af2ff697565c81552d49c0237cfc89ef7) +* [toStringEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a9013b29e3ca18c5a0ecaff8dc6d19b5f) + + +### Function fromStringEx + +![][public] + +``` +void ModelCenter::IArray::fromStringEx(BSTR value, long index) +``` + + + +Sets the value of an array element from a specified string. + + + + + + +**Parameters**: + +* **value**: New value. +* **index**: Index of the array element (0-based index). + + + +**Parameters**: + +* BSTR **value** +* long **index** + +**Return type**: void + +**Reimplemented by**: + +* [fromStringEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a8d7b18dca2bbe96aa0ee3718e433e272) +* [fromStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad068bdf2a8fb66fea7cfb3a3111fb176) +* [fromStringEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aa104ba67a0164c27a33017aabd29d83d) +* [fromStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a26f9cfd27774a2233ae2cb232cc8fec9) +* [fromStringEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2a286a07b606f7e90ac4e1d281a49d38) +* [fromStringEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8fa6aff7c64224c1c488d5866dfc4865) + + +### Function toStringAbsoluteEx + +![][public] + +``` +BSTR ModelCenter::IArray::toStringAbsoluteEx(long index) +``` + + + +Converts the value of an array element to a string. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The value of the element as a string. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + +**Reimplemented by**: + +* [toStringAbsoluteEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aaa425c05112e2f9568bb13886800dbba) +* [toStringAbsoluteEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab1252981582cec6fd3662321c9c4ce28) +* [toStringAbsoluteEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a15dfd2825b183a80b93d849ce3429ca3) +* [toStringAbsoluteEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5794b0c172b46da36d761bf31046db07) +* [toStringAbsoluteEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aac2b33985ad310362db7c8c878096ae8) +* [toStringAbsoluteEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a3684e3b0b2d36a599f75236a6f5e90e7) + + +### Function getLength + +![][public] + +``` +long ModelCenter::IArray::getLength([optional] VARIANT dim) +``` + + + +Get the length of the n'th dimension of the array. + + + + + + +**Parameters**: + +* **dim**: Dimension of the array to query. This uses a 0 based index, so 0 will give you the first dimension, 1 the second, etc. If omitted, gives the first dimension + + +**Returns**: + +Length(size) of the array. + + + +**Parameters**: + +* _[optional]_ VARIANT **dim** + +**Return type**: long + +**Reimplemented by**: + +* [getLength](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad9da4a66a831de9a501a7aca13a6a84f) +* [getLength](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab0632e518febc3b1549fc35d932fd451) +* [getLength](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1acb6d739a4e50bcbbda5a5cf053ae21db) +* [getLength](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a8167ef387b9cc11bc76e9a0e0694a833) +* [getLength](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad88eff947daa184ab953839666729ae5) +* [getLength](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a39098992a1f29458010e4d18385d3681) + + +### Function setLength + +![][public] + +``` +void ModelCenter::IArray::setLength(long length, [optional] VARIANT dim) +``` + + + +Sets the length of the n'th dimension of the array + + + + + + +**Parameters**: + +* **length**: New length of the n'th dimension of the array +* **dim**: The dimension to set. This uses a 0 based index, so 0 will set the first dimension, 1 the second, etc. If omitted, sets the first dimension + + + +**Parameters**: + +* long **length** +* _[optional]_ VARIANT **dim** + +**Return type**: void + +**Reimplemented by**: + +* [setLength](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a2bf47781f038fae8dc22e6edb04149a9) +* [setLength](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a5e70599413156ef04aa8ddfd03958320) +* [setLength](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a66119cc8d733c8a2d6a8101569768662) +* [setLength](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a91d122341cefcb887c3871d43ea34524) +* [setLength](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2cfaecd2a821841d414f0d9ac505659f) +* [setLength](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ab20a6b27ddb532d0186532a52a148d91) + + +### Function setDimensions + +![][public] + +``` +void ModelCenter::IArray::setDimensions(long d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Sets the number of dimensions of an array and the length of each dimension in one call. An array initializes to 0 length. If any dimension of the array has 0 length, the whole array contains no data. You must set the array size before filling in values unless you are using the setArray() call. + + + + + + +**Parameters**: + +* **d1**: length of the 1st dimension of the array +* **d2**: length of the 2nd dimension of the array. If omitted, the array is 1 dimensional +* **d3**: length of the 3rd dimension of the array. If omitted, the array is 2 dimensional +* **d4**: length of the 4th dimension of the array. If omitted, the array is 3 dimensional +* **d5**: length of the 5th dimension of the array. If omitted, the array is 4 dimensional +* **d6**: length of the 6th dimension of the array. If omitted, the array is 5 dimensional +* **d7**: length of the 7th dimension of the array. If omitted, the array is 6 dimensional +* **d8**: length of the 8th dimension of the array. If omitted, the array is 7 dimensional +* **d9**: length of the 9th dimension of the array. If omitted, the array is 8 dimensional +* **d10**: length of the 10th dimension of the array. If omitted, the array is 9 dimensional + + + +**Parameters**: + +* long **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: void + +**Reimplemented by**: + +* [setDimensions](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a6a526c3b8680b1f5ececc326a340d14b) +* [setDimensions](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a397d1abf4ecf0a106e84112b5634efac) +* [setDimensions](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a791424f1645b40c0b9b9d509effb1df8) +* [setDimensions](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a1010ee85bb6325b98fab48f96b582103) +* [setDimensions](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a3526172d364bb842ab3bc25f1cedf31b) +* [setDimensions](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1aa3a9cdee8b632a3adda4e2d1814c66f8) + + +### Function getSize + +![][public] + +``` +long ModelCenter::IArray::getSize([optional] VARIANT dim) +``` + + + +Alias for the [getLength()](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) call + + + + + + +**Parameters**: + +* **dim**: Dimension of the array to query(0-based index). + + +**Returns**: + +Size of the dimension + + + +**Parameters**: + +* _[optional]_ VARIANT **dim** + +**Return type**: long + + +### Function setSize + +![][public] + +``` +void ModelCenter::IArray::setSize(long length, [optional] VARIANT dim) +``` + + + +Alias for the [setLength()](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) call + + + + + + +**Parameters**: + +* **length**: Length of the specified dimension +* **dim**: The dimension to set (0-based index). + + + +**Parameters**: + +* long **length** +* _[optional]_ VARIANT **dim** + +**Return type**: void + + +### Function getDimensions + +![][public] + +``` +VARIANT ModelCenter::IArray::getDimensions() +``` + + + +Gets the dimensions of the array. + + + + + + +**Returns**: + +Variant - either a single integer, in the case of a 1D array, or an array of integers, in the case of multi-dimensional arrays. + + + +**Return type**: VARIANT + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IAssemblies.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IAssemblies.md index 99cf101eea..af866cb974 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IAssemblies.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IAssemblies.md @@ -1,78 +1,77 @@ - -# Interface ModelCenter::IAssemblies - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 630) - - - -COM Instance. - -## Members - -* [Count](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies_1aee7be5ec0b95eaea973eb669981b4804) -* [Item](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies_1ae6f3debe976f58187639b34a900ea2b1) - -## Properties - - -### Property Count - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IAssemblies::Count -``` - - - -Number of Assemblies. - - - -**Return type**: VARIANT - -## Public functions - - -### Function Item - -![][public] - -``` -VARIANT ModelCenter::IAssemblies::Item(VARIANT id) -``` - - - -Gets a pointer to the specified Assembly. - - - - - - -**Parameters**: - -* **id**: ID of the specified Assembly. It can be a name or an index. - - -**Returns**: - -IDispatch* to an [IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) object. - - - -**Parameters**: - -* VARIANT **id** - -**Return type**: VARIANT - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IAssemblies + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 630) + + + +COM Instance. + +## Members + +* [Count](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies_1aee7be5ec0b95eaea973eb669981b4804) +* [Item](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies_1ae6f3debe976f58187639b34a900ea2b1) + +## Properties + + +### Property Count + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IAssemblies::Count +``` + + + +Number of Assemblies. + + + +**Return type**: VARIANT + +## Public functions + + +### Function Item + +![][public] + +``` +VARIANT ModelCenter::IAssemblies::Item(VARIANT id) +``` + + + +Gets a pointer to the specified Assembly. + + + + + + +**Parameters**: + +* **id**: ID of the specified Assembly. It can be a name or an index. + + +**Returns**: + +IDispatch* to an [IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) object. + + + +**Parameters**: + +* VARIANT **id** + +**Return type**: VARIANT + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IAssembly.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IAssembly.md index 294cf5b023..7c797ee5da 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IAssembly.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IAssembly.md @@ -1,651 +1,650 @@ - -# Interface ModelCenter::IAssembly - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 669) - - - -COM Instance. - -## Members - -* [addAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a1a55454ec16eadd67d23a8e134fccce7) -* [addAssembly2](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a1c73a3675ee4a70e9b31d2f63c86e630) -* [addVariable](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1af05ab7c452794c56cc54d77113cefdea) -* [Assemblies](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a00afe3dedbc3bb8b8a1cbdf5bd6333a1) -* [AssemblyType](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a12692b24f7c9fceec97847b204afecc4) -* [Components](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ad4c0ef9792a2f760b3639357126e56f6) -* [convertToSubmodel](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1afc8d8acd50c53726272ce0c983aa640f) -* [deleteVariable](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a92a8b6a732ebcd29f6fb33a448f9f4c9) -* [getFullName](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1aa62ac6d1100f85d3f212185812a9e517) -* [getMetadata](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ad0ea6a9bc76c34b8158454e27bbfd9b8) -* [getName](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a4b41d24972378517a23efafc6a0fc403) -* [getPositionX](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a476766c4bdcb9fb07f1fdd0a12a04ac0) -* [getPositionY](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ab58695afb7a8ecb8202a1b20011d384a) -* [Groups](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a1e5ca5f83e7c3debe3d63366948ad894) -* [iconID](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1af8ddf59c545db7695b90a2a64bdcc822) -* [IndexInParent](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a6e888824a16134a6797ec96745c9dd4f) -* [ParentAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a8cccd51f677c2d7c29c734a2c1009f45) -* [rename](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ac180bc4a2120cd22964998c75eed05f5) -* [setMetadata](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1aa1e66114f498d0a1238237ad6caa1348) -* [userData](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1af405572d6c2bafc56164b2ce5b97b1a3) -* [Variables](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a88d34960f336b71cc7f4beff3b4bbaba) - -## Properties - - -### Property Variables - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IAssembly::Variables -``` - - - -Pointer to the variables in the Assembly. - - - - - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Return type**: VARIANT - - -### Property Groups - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IAssembly::Groups -``` - - - -Pointer to the Groups in the Assembly. - - - - - - -**Returns**: - -IDispatch* to an [IGroups](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups) object. - - - -**Return type**: VARIANT - - -### Property Assemblies - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IAssembly::Assemblies -``` - - - -Pointer to the Assemblies in the Assembly. - - - - - - -**Returns**: - -IDispatch* to an [IAssemblies](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies) object. - - - -**Return type**: VARIANT - - -### Property Components - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IAssembly::Components -``` - - - -Pointer to the Components in the Assembly. - - - - - - -**Returns**: - -IDispatch* to an [IComponents](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents) object. - - - -**Return type**: VARIANT - - -### Property iconID - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -int ModelCenter::IAssembly::iconID -``` - - - -The ID number of the icon to use for the Assembly. - - - -**Return type**: int - - -### Property IndexInParent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -int ModelCenter::IAssembly::IndexInParent -``` - - - -Gets the position of the Assembly within the parent. - - - -**Return type**: int - - -### Property ParentAssembly - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IAssembly::ParentAssembly -``` - - - -Gets the parent of assembly of this assembly. - - - - - - -**Returns**: - -IDisplatch* to an [IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) object. - - - -**Return type**: LPDISPATCH - - -### Property AssemblyType - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IAssembly::AssemblyType -``` - - - -Gets the type of the Assembly (Sequence, Assembly, etc). - - - -**Return type**: BSTR - - -### Property userData - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IAssembly::userData -``` - - - -An arbitrary Variant which is not used internally by ModelCenter but can store data for programmatic purposes. Value is not stored across file save/load. - - - -**Return type**: VARIANT - -## Public functions - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IAssembly::getName() -``` - - - -Name of the Assembly. - - - - - - -**Returns**: - -The name of the Assembly. - - - -**Return type**: BSTR - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IAssembly::getFullName() -``` - - - -Full [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) path of the Assembly. - - - - - - -**Returns**: - -The full ModelCenter path of the Assembly. - - - -**Return type**: BSTR - - -### Function addAssembly - -![][public] - -``` -IDispatch * ModelCenter::IAssembly::addAssembly(BSTR name, [optional]VARIANT assemblyType) -``` - - - -This method creates a sub-Assembly in the current Assembly object. - - - - - - -**Parameters**: - -* **name**: The name of the sub-Assembly to create. -* **assemblyType**:
- - -**Returns**: - -IDispatch* to an [IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) object. - - - -**Parameters**: - -* BSTR **name** -* _[optional]_ VARIANT **assemblyType** - -**Return type**: IDispatch * - - -### Function addVariable - -![][public] - -``` -IDispatch * ModelCenter::IAssembly::addVariable(BSTR name, BSTR type) -``` - - - -Creates a variable for the current Assembly. - - - - - - -**Parameters**: - -* **name**: Name of the new variable to create. -* **type**: Type of the new variable. Possible types are: -* double - -* int - -* boolean - -* string - -* file - -* double[] - -* int[] - -* boolean[] - -* string[] - -* quadfacet - -* surfaceofrevolution - -* nurbs - -* bspline - -* ruled - -* skinned - -* vrml - -* node - - -**Returns**: - -IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object. - - - -**Parameters**: - -* BSTR **name** -* BSTR **type** - -**Return type**: IDispatch * - - -### Function rename - -![][public] - -``` -void ModelCenter::IAssembly::rename(BSTR name) -``` - - - -Renames the current Assembly. - - - - - - -**Parameters**: - -* **name**: New name of the Assembly. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: void - - -### Function deleteVariable - -![][public] - -``` -void ModelCenter::IAssembly::deleteVariable(BSTR name) -``` - - - -Deletes a variable from the current Assembly. - - - - - - -**Parameters**: - -* **name**: Name of the variable to delete. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: void - - -### Function addAssembly2 - -![][public] - -``` -LPDISPATCH ModelCenter::IAssembly::addAssembly2(BSTR name, VARIANT xPos, VARIANT yPos, [optional]VARIANT assemblyType) -``` - - - -This method creates a sub-Assembly in the current Assembly with a specific type and position. - - - - - - -**Parameters**: - -* **name**:
-* **xPos**:
-* **yPos**:
-* **assemblyType**:
- - -**Returns**: - -IDispatch* to an [IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) object. - - - -**Parameters**: - -* BSTR **name** -* VARIANT **xPos** -* VARIANT **yPos** -* _[optional]_ VARIANT **assemblyType** - -**Return type**: LPDISPATCH - - -### Function setMetadata - -![][public] - -``` -void ModelCenter::IAssembly::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) -``` - - - -Sets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata specifier used to store the data. -* **type**:
-* **value**:
-* **access**:
-* **archive**:
- - - -**Parameters**: - -* BSTR **name** -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** -* VARIANT **value** -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** -* boolean **archive** - -**Return type**: void - - -### Function getMetadata - -![][public] - -``` -VARIANT ModelCenter::IAssembly::getMetadata(BSTR name) -``` - - - -Gets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata key name. - - -**Returns**: - -Metadata value. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -## Private functions - - -### Function getPositionX - -![][private] - -``` -int ModelCenter::IAssembly::getPositionX() -``` - - - - - - - -**Return type**: int - - -### Function getPositionY - -![][private] - -``` -int ModelCenter::IAssembly::getPositionY() -``` - - - - - - - -**Return type**: int - - -### Function convertToSubmodel - -![][private] - -``` -void ModelCenter::IAssembly::convertToSubmodel(BSTR fileName, VersionStatus versionStatus, BSTR checkinMessage) -``` - - - - - - - -**Parameters**: - -* BSTR **fileName** -* [VersionStatus](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0) **versionStatus** -* BSTR **checkinMessage** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IAssembly + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 669) + + + +COM Instance. + +## Members + +* [addAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a1a55454ec16eadd67d23a8e134fccce7) +* [addAssembly2](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a1c73a3675ee4a70e9b31d2f63c86e630) +* [addVariable](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1af05ab7c452794c56cc54d77113cefdea) +* [Assemblies](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a00afe3dedbc3bb8b8a1cbdf5bd6333a1) +* [AssemblyType](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a12692b24f7c9fceec97847b204afecc4) +* [Components](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ad4c0ef9792a2f760b3639357126e56f6) +* [convertToSubmodel](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1afc8d8acd50c53726272ce0c983aa640f) +* [deleteVariable](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a92a8b6a732ebcd29f6fb33a448f9f4c9) +* [getFullName](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1aa62ac6d1100f85d3f212185812a9e517) +* [getMetadata](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ad0ea6a9bc76c34b8158454e27bbfd9b8) +* [getName](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a4b41d24972378517a23efafc6a0fc403) +* [getPositionX](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a476766c4bdcb9fb07f1fdd0a12a04ac0) +* [getPositionY](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ab58695afb7a8ecb8202a1b20011d384a) +* [Groups](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a1e5ca5f83e7c3debe3d63366948ad894) +* [iconID](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1af8ddf59c545db7695b90a2a64bdcc822) +* [IndexInParent](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a6e888824a16134a6797ec96745c9dd4f) +* [ParentAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a8cccd51f677c2d7c29c734a2c1009f45) +* [rename](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1ac180bc4a2120cd22964998c75eed05f5) +* [setMetadata](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1aa1e66114f498d0a1238237ad6caa1348) +* [userData](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1af405572d6c2bafc56164b2ce5b97b1a3) +* [Variables](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly_1a88d34960f336b71cc7f4beff3b4bbaba) + +## Properties + + +### Property Variables + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IAssembly::Variables +``` + + + +Pointer to the variables in the Assembly. + + + + + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Return type**: VARIANT + + +### Property Groups + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IAssembly::Groups +``` + + + +Pointer to the Groups in the Assembly. + + + + + + +**Returns**: + +IDispatch* to an [IGroups](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups) object. + + + +**Return type**: VARIANT + + +### Property Assemblies + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IAssembly::Assemblies +``` + + + +Pointer to the Assemblies in the Assembly. + + + + + + +**Returns**: + +IDispatch* to an [IAssemblies](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies) object. + + + +**Return type**: VARIANT + + +### Property Components + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IAssembly::Components +``` + + + +Pointer to the Components in the Assembly. + + + + + + +**Returns**: + +IDispatch* to an [IComponents](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents) object. + + + +**Return type**: VARIANT + + +### Property iconID + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +int ModelCenter::IAssembly::iconID +``` + + + +The ID number of the icon to use for the Assembly. + + + +**Return type**: int + + +### Property IndexInParent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +int ModelCenter::IAssembly::IndexInParent +``` + + + +Gets the position of the Assembly within the parent. + + + +**Return type**: int + + +### Property ParentAssembly + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IAssembly::ParentAssembly +``` + + + +Gets the parent of assembly of this assembly. + + + + + + +**Returns**: + +IDisplatch* to an [IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) object. + + + +**Return type**: LPDISPATCH + + +### Property AssemblyType + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IAssembly::AssemblyType +``` + + + +Gets the type of the Assembly (Sequence, Assembly, etc). + + + +**Return type**: BSTR + + +### Property userData + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IAssembly::userData +``` + + + +An arbitrary Variant which is not used internally by ModelCenter but can store data for programmatic purposes. Value is not stored across file save/load. + + + +**Return type**: VARIANT + +## Public functions + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IAssembly::getName() +``` + + + +Name of the Assembly. + + + + + + +**Returns**: + +The name of the Assembly. + + + +**Return type**: BSTR + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IAssembly::getFullName() +``` + + + +Full [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) path of the Assembly. + + + + + + +**Returns**: + +The full ModelCenter path of the Assembly. + + + +**Return type**: BSTR + + +### Function addAssembly + +![][public] + +``` +IDispatch * ModelCenter::IAssembly::addAssembly(BSTR name, [optional]VARIANT assemblyType) +``` + + + +This method creates a sub-Assembly in the current Assembly object. + + + + + + +**Parameters**: + +* **name**: The name of the sub-Assembly to create. +* **assemblyType**:
+ + +**Returns**: + +IDispatch* to an [IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) object. + + + +**Parameters**: + +* BSTR **name** +* _[optional]_ VARIANT **assemblyType** + +**Return type**: IDispatch * + + +### Function addVariable + +![][public] + +``` +IDispatch * ModelCenter::IAssembly::addVariable(BSTR name, BSTR type) +``` + + + +Creates a variable for the current Assembly. + + + + + + +**Parameters**: + +* **name**: Name of the new variable to create. +* **type**: Type of the new variable. Possible types are: +* double + +* int + +* boolean + +* string + +* file + +* double[] + +* int[] + +* boolean[] + +* string[] + +* quadfacet + +* surfaceofrevolution + +* nurbs + +* bspline + +* ruled + +* skinned + +* vrml + +* node + + +**Returns**: + +IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object. + + + +**Parameters**: + +* BSTR **name** +* BSTR **type** + +**Return type**: IDispatch * + + +### Function rename + +![][public] + +``` +void ModelCenter::IAssembly::rename(BSTR name) +``` + + + +Renames the current Assembly. + + + + + + +**Parameters**: + +* **name**: New name of the Assembly. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: void + + +### Function deleteVariable + +![][public] + +``` +void ModelCenter::IAssembly::deleteVariable(BSTR name) +``` + + + +Deletes a variable from the current Assembly. + + + + + + +**Parameters**: + +* **name**: Name of the variable to delete. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: void + + +### Function addAssembly2 + +![][public] + +``` +LPDISPATCH ModelCenter::IAssembly::addAssembly2(BSTR name, VARIANT xPos, VARIANT yPos, [optional]VARIANT assemblyType) +``` + + + +This method creates a sub-Assembly in the current Assembly with a specific type and position. + + + + + + +**Parameters**: + +* **name**:
+* **xPos**:
+* **yPos**:
+* **assemblyType**:
+ + +**Returns**: + +IDispatch* to an [IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) object. + + + +**Parameters**: + +* BSTR **name** +* VARIANT **xPos** +* VARIANT **yPos** +* _[optional]_ VARIANT **assemblyType** + +**Return type**: LPDISPATCH + + +### Function setMetadata + +![][public] + +``` +void ModelCenter::IAssembly::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) +``` + + + +Sets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata specifier used to store the data. +* **type**:
+* **value**:
+* **access**:
+* **archive**:
+ + + +**Parameters**: + +* BSTR **name** +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** +* VARIANT **value** +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** +* boolean **archive** + +**Return type**: void + + +### Function getMetadata + +![][public] + +``` +VARIANT ModelCenter::IAssembly::getMetadata(BSTR name) +``` + + + +Gets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata key name. + + +**Returns**: + +Metadata value. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +## Private functions + + +### Function getPositionX + +![][private] + +``` +int ModelCenter::IAssembly::getPositionX() +``` + + + + + + + +**Return type**: int + + +### Function getPositionY + +![][private] + +``` +int ModelCenter::IAssembly::getPositionY() +``` + + + + + + + +**Return type**: int + + +### Function convertToSubmodel + +![][private] + +``` +void ModelCenter::IAssembly::convertToSubmodel(BSTR fileName, VersionStatus versionStatus, BSTR checkinMessage) +``` + + + + + + + +**Parameters**: + +* BSTR **fileName** +* [VersionStatus](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0) **versionStatus** +* BSTR **checkinMessage** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IBooleanArray.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IBooleanArray.md index d7b0efade9..2ade1fedf2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IBooleanArray.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IBooleanArray.md @@ -1,1338 +1,1337 @@ - -# Interface ModelCenter::IBooleanArray - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 831) - - - -COM Instance. - -**Inherits from**: - -* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) - -## Members - -* [autoSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aca63a47369d69cbbf53532286b64a611) -* [dependentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1abadb81820fd0b415fa9e78ce6c867c55) -* [dependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a386477ffe54e2d0f351f9dc7fbb49712) -* [description](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ae3788aac4468e5c4d62e002663e8e729) -* [directDependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a6ed20fe44044c682471c7066ae2bd303) -* [directPrecedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a605c25813e75d1709e364eef080f68e9) -* [fromString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1af5d6c192774673f4f4bf7514b35f8ccf) -* [fromStringEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a8d7b18dca2bbe96aa0ee3718e433e272) -* [getArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ac522da7a239f7d74e52a445351e5996a) -* [getDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a83abe70ccf5e8a0a582748d84e3d7956) -* [getFullName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a498741fde4d9eeec6eb3f8171e3161d8) -* [getLength](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad9da4a66a831de9a501a7aca13a6a84f) -* [getMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa6b44db219dbaf49be81841dc459f4ae) -* [getName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a471100848db5a6f0c08f2920aa283ac6) -* [getSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a3d171136e0b219dd4e2d0d1b4bb9aa1f) -* [getType](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad8d2b43dd9f4b3656dba1e8570f7f747) -* [getValue](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9aa72924449a81d937830715bbe7503e) -* [getValueAbsolute](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad975bca587185786df34ddd600d7fe96) -* [hasChanged](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a5231acb6d280e70ecf75f906a357e3b4) -* [hide](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa6cabd1afd2f36f8e431da7342e9bdb7) -* [invalidate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a04e162fdfae6e99e6dcfd926adfca7b1) -* [isInput](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa87e846de03852ee40e909935c2ec470) -* [isInputToComponent](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a871c46c1f732b2885e2ef1fa2080a3e8) -* [isInputToModel](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a364726a017aca71bdb22d43530cc9426) -* [isValid](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d13fb275a266aa85280b6beed8be176) -* [length](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af118bdf4b120050d6700a7ceae7f5bec) -* [numDimensions](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a3edf21f87f8614c2b603aafba6f10cd2) -* [OwningComponent](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a22fbdf9f77a399b4c536aa78bcd826bf) -* [precedentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a428a6e6a2a2be52d77bfe96323fea64f) -* [precedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d7349a2273e5b9eaaab5271918eed6f) -* [setArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a783239a87a41ba31461d61df639dd5f4) -* [setDimensions](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a6a526c3b8680b1f5ececc326a340d14b) -* [setLength](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a2bf47781f038fae8dc22e6edb04149a9) -* [setMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a772ffc624a737a4808eb8dfc9ff41e0d) -* [setSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b7b41ca5463a86aecb2368d73464c0e) -* [setValue](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa3bdaab478a67db1dd4cb7921de5ed72) -* [size](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ada4924e975e5e04d2c6f7104f2626212) -* [toString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a39294beb6d830e498ee8aca7a25cc4a6) -* [toStringAbsolute](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa07f73fa1f449045d77725b0fef00739) -* [toStringAbsoluteEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aaa425c05112e2f9568bb13886800dbba) -* [toStringEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1af151b1686dbe379f876131afd8c2c71e) -* [validate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa221cef15629c5acf569329c0e089b3a) -* [value](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aafaaa11ebda98ac168f489abd5385422) -* [value](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a71678d5b3009123d0401d7715c5dcdf6) - -## Properties - - -### Property hasChanged - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IBooleanArray::hasChanged -``` - - - - - - - -**Return type**: boolean - - -### Property hide - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IBooleanArray::hide -``` - - - - - - - -**Return type**: boolean - - -### Property OwningComponent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IBooleanArray::OwningComponent -``` - - - - - - - -**Return type**: LPDISPATCH - - -### Property size - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IBooleanArray::size -``` - - - - - - - -**Return type**: long - - -### Property numDimensions - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IBooleanArray::numDimensions -``` - - - - - - - -**Return type**: long - - -### Property description - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IBooleanArray::description -``` - - - -Description of the array. - - - -**Return type**: BSTR - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 936) - -``` -VARIANT ModelCenter::IBooleanArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9) -``` - - - -Get the value of an array element. - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - -**Returns**: - -The value. - - - -**Return type**: VARIANT - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 952) - -``` -BOOL ModelCenter::IBooleanArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9,[optional] VARIANT d10) -``` - - - -Set the value of an array element. - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). -* **newValue**: The new value. - - - -**Return type**: BOOL - -## Public functions - - -### Function isValid - -![][public] - -``` -boolean ModelCenter::IBooleanArray::isValid() -``` - - - -Finds out whether or not the array is valid. - - - - - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Return type**: boolean - -**Reimplements**: [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) - - -### Function validate - -![][public] - -``` -void ModelCenter::IBooleanArray::validate() -``` - - - -Causes the array to validate itself. - - - -**Return type**: void - -**Reimplements**: [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IBooleanArray::getName() -``` - - - -Gets the name of the array. - - - - - - -**Returns**: - -The name of the array. - - - -**Return type**: BSTR - -**Reimplements**: [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IBooleanArray::getFullName() -``` - - - -Gets the full ModelCenter path of the array. - - - - - - -**Returns**: - -The full ModelCenter path of the array. - - - -**Return type**: BSTR - -**Reimplements**: [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IBooleanArray::getType() -``` - - - -Gets the type of the array. - - - - - - -**Returns**: - -The type of the array as a string. - - - -**Return type**: BSTR - -**Reimplements**: [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) - - -### Function isInput - -![][public] - -``` -boolean ModelCenter::IBooleanArray::isInput() -``` - - - -Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a364726a017aca71bdb22d43530cc9426). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) - - -### Function toString - -![][public] - -``` -BSTR ModelCenter::IBooleanArray::toString() -``` - - - -Converts the array to a string, validating it if necessary. The format is of the form "true, false, true" for one-dimensional arrays or "bounds[3,3] {true, false, true, false, true, false, true, false, true}" for multi-dimensional arrays. - - - - - - -**Returns**: - -String representation of the array. - - - -**Return type**: BSTR - -**Reimplements**: [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) - - -### Function fromString - -![][public] - -``` -void ModelCenter::IBooleanArray::fromString(BSTR value) -``` - - - -Sets the value of the array from a specified string. For 1D arrays, the specification is of the form 'true,false,true'.
-For nD arrays, the specification is of the form 'bounds[2,2,2] {true,false,true,false,true,false,true,false}'. - - - - - - -**Parameters**: - -* **value**: The new value. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - -**Reimplements**: [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) - - -### Function toStringAbsolute - -![][public] - -``` -BSTR ModelCenter::IBooleanArray::toStringAbsolute() -``` - - - -Converts the array to a string. The format is of the form "true, false, true" for one-dimensional arrays or "bounds[3,3] {true, false, true, false, true, false, true, false, true}" for multi-dimensional arrays. - - - - - - -**Returns**: - -String representation of the array. - - - -**Return type**: BSTR - -**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IBooleanArray::invalidate() -``` - - - -Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. - - - -**Return type**: void - -**Reimplements**: [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) - - -### Function directPrecedents - -![][public] - -``` -LPDISPATCH ModelCenter::IBooleanArray::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) - - -### Function directDependents - -![][public] - -``` -LPDISPATCH ModelCenter::IBooleanArray::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) - - -### Function precedentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IBooleanArray::precedentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) - - -### Function dependentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IBooleanArray::dependentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) - - -### Function precedents - -![][public] - -``` -LPDISPATCH ModelCenter::IBooleanArray::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) - - -### Function dependents - -![][public] - -``` -LPDISPATCH ModelCenter::IBooleanArray::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) - - -### Function isInputToComponent - -![][public] - -``` -boolean ModelCenter::IBooleanArray::isInputToComponent() -``` - - - -Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) - - -### Function isInputToModel - -![][public] - -``` -boolean ModelCenter::IBooleanArray::isInputToModel() -``` - - - -Checks whether or not the variable is an input. A linked input returns false (Output). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) - - -### Function setMetadata - -![][public] - -``` -void ModelCenter::IBooleanArray::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) -``` - - - -Sets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata specifier used to store the data. -* **type**:
-* **value**:
-* **access**:
-* **archive**:
- - - -**Parameters**: - -* BSTR **name** -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** -* VARIANT **value** -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** -* boolean **archive** - -**Return type**: void - -**Reimplements**: [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) - - -### Function getMetadata - -![][public] - -``` -VARIANT ModelCenter::IBooleanArray::getMetadata(BSTR name) -``` - - - -Gets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata key name. - - -**Returns**: - -Metadata value. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -**Reimplements**: [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) - - -### Function toStringEx - -![][public] - -``` -BSTR ModelCenter::IBooleanArray::toStringEx(long index) -``` - - - -Converts the value of an array element to a string, validating the array if necessary. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The value of the element as a string. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - -**Reimplements**: [toStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a37c622ae9f50579f714ce98c0379cd98) - - -### Function fromStringEx - -![][public] - -``` -void ModelCenter::IBooleanArray::fromStringEx(BSTR value, long index) -``` - - - -Sets the value of an array element from a specified string. - - - - - - -**Parameters**: - -* **value**: New value. -* **index**: Index of the array element (0-based index). - - - -**Parameters**: - -* BSTR **value** -* long **index** - -**Return type**: void - -**Reimplements**: [fromStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad23f4082662c464be07251d6d1695a2d) - - -### Function toStringAbsoluteEx - -![][public] - -``` -BSTR ModelCenter::IBooleanArray::toStringAbsoluteEx(long index) -``` - - - -Converts the value of an array element to a string. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The value of the element as a string. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - -**Reimplements**: [toStringAbsoluteEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a2e3041440581aab716c684fe88d2ee87) - - -### Function getLength - -![][public] - -``` -long ModelCenter::IBooleanArray::getLength([optional] VARIANT dim) -``` - - - -Get the length of the n'th dimension of the array. - - - - - - -**Parameters**: - -* **dim**: Dimension of the array to query. This uses a 0 based index, so 0 will give you the first dimension, 1 the second, etc. If omitted, gives the first dimension - - -**Returns**: - -Length(size) of the array. - - - -**Parameters**: - -* _[optional]_ VARIANT **dim** - -**Return type**: long - -**Reimplements**: [getLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) - - -### Function setLength - -![][public] - -``` -void ModelCenter::IBooleanArray::setLength(long length, [optional] VARIANT dim) -``` - - - -Sets the length of the n'th dimension of the array - - - - - - -**Parameters**: - -* **length**: New length of the n'th dimension of the array -* **dim**: The dimension to set. This uses a 0 based index, so 0 will set the first dimension, 1 the second, etc. If omitted, sets the first dimension - - - -**Parameters**: - -* long **length** -* _[optional]_ VARIANT **dim** - -**Return type**: void - -**Reimplements**: [setLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) - - -### Function setDimensions - -![][public] - -``` -void ModelCenter::IBooleanArray::setDimensions(long d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Sets the number of dimensions of an array and the length of each dimension in one call. An array initializes to 0 length. If any dimension of the array has 0 length, the whole array contains no data. You must set the array size before filling in values unless you are using the [setArray()](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a783239a87a41ba31461d61df639dd5f4) call. - - - - - - -**Parameters**: - -* **d1**: length of the 1st dimension of the array -* **d2**: length of the 2nd dimension of the array. If omitted, the array is 1 dimensional -* **d3**: length of the 3rd dimension of the array. If omitted, the array is 2 dimensional -* **d4**: length of the 4th dimension of the array. If omitted, the array is 3 dimensional -* **d5**: length of the 5th dimension of the array. If omitted, the array is 4 dimensional -* **d6**: length of the 6th dimension of the array. If omitted, the array is 5 dimensional -* **d7**: length of the 7th dimension of the array. If omitted, the array is 6 dimensional -* **d8**: length of the 8th dimension of the array. If omitted, the array is 7 dimensional -* **d9**: length of the 9th dimension of the array. If omitted, the array is 8 dimensional -* **d10**: length of the 10th dimension of the array. If omitted, the array is 9 dimensional - - - -**Parameters**: - -* long **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: void - -**Reimplements**: [setDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) - - -### Function getValue - -![][public] - -``` -boolean ModelCenter::IBooleanArray::getValue(VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Gets the value of an array element. - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - -**Returns**: - -The value. - - - -**Parameters**: - -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: boolean - - -### Function setValue - -![][public] - -``` -void ModelCenter::IBooleanArray::setValue(BOOL value, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Sets the value of an array element. - - - - - - -**Parameters**: - -* **value**: The new value. -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - - -**Parameters**: - -* BOOL **value** -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: void - - -### Function getArray - -![][public] - -``` -VARIANT ModelCenter::IBooleanArray::getArray() -``` - - - -Get the COM array. - - - - - - -**Returns**: - -The COM array. - - - -**Return type**: VARIANT - - -### Function setArray - -![][public] - -``` -void ModelCenter::IBooleanArray::setArray(VARIANT array) -``` - - - -Sets the COM array. - - - - - - -**Parameters**: - -* **array**: The COM array. - - - -**Parameters**: - -* VARIANT **array** - -**Return type**: void - - -### Function getValueAbsolute - -![][public] - -``` -boolean ModelCenter::IBooleanArray::getValueAbsolute(VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Gets the value of an array element without validating. - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - -**Returns**: - -The value. - - - -**Parameters**: - -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: boolean - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IBooleanArray + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 831) + + + +COM Instance. + +**Inherits from**: + +* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) + +## Members + +* [autoSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aca63a47369d69cbbf53532286b64a611) +* [dependentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1abadb81820fd0b415fa9e78ce6c867c55) +* [dependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a386477ffe54e2d0f351f9dc7fbb49712) +* [description](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ae3788aac4468e5c4d62e002663e8e729) +* [directDependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a6ed20fe44044c682471c7066ae2bd303) +* [directPrecedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a605c25813e75d1709e364eef080f68e9) +* [fromString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1af5d6c192774673f4f4bf7514b35f8ccf) +* [fromStringEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a8d7b18dca2bbe96aa0ee3718e433e272) +* [getArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ac522da7a239f7d74e52a445351e5996a) +* [getDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a83abe70ccf5e8a0a582748d84e3d7956) +* [getFullName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a498741fde4d9eeec6eb3f8171e3161d8) +* [getLength](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad9da4a66a831de9a501a7aca13a6a84f) +* [getMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa6b44db219dbaf49be81841dc459f4ae) +* [getName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a471100848db5a6f0c08f2920aa283ac6) +* [getSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a3d171136e0b219dd4e2d0d1b4bb9aa1f) +* [getType](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad8d2b43dd9f4b3656dba1e8570f7f747) +* [getValue](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9aa72924449a81d937830715bbe7503e) +* [getValueAbsolute](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad975bca587185786df34ddd600d7fe96) +* [hasChanged](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a5231acb6d280e70ecf75f906a357e3b4) +* [hide](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa6cabd1afd2f36f8e431da7342e9bdb7) +* [invalidate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a04e162fdfae6e99e6dcfd926adfca7b1) +* [isInput](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa87e846de03852ee40e909935c2ec470) +* [isInputToComponent](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a871c46c1f732b2885e2ef1fa2080a3e8) +* [isInputToModel](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a364726a017aca71bdb22d43530cc9426) +* [isValid](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d13fb275a266aa85280b6beed8be176) +* [length](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af118bdf4b120050d6700a7ceae7f5bec) +* [numDimensions](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a3edf21f87f8614c2b603aafba6f10cd2) +* [OwningComponent](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a22fbdf9f77a399b4c536aa78bcd826bf) +* [precedentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a428a6e6a2a2be52d77bfe96323fea64f) +* [precedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d7349a2273e5b9eaaab5271918eed6f) +* [setArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a783239a87a41ba31461d61df639dd5f4) +* [setDimensions](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a6a526c3b8680b1f5ececc326a340d14b) +* [setLength](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a2bf47781f038fae8dc22e6edb04149a9) +* [setMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a772ffc624a737a4808eb8dfc9ff41e0d) +* [setSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b7b41ca5463a86aecb2368d73464c0e) +* [setValue](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa3bdaab478a67db1dd4cb7921de5ed72) +* [size](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ada4924e975e5e04d2c6f7104f2626212) +* [toString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a39294beb6d830e498ee8aca7a25cc4a6) +* [toStringAbsolute](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa07f73fa1f449045d77725b0fef00739) +* [toStringAbsoluteEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aaa425c05112e2f9568bb13886800dbba) +* [toStringEx](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1af151b1686dbe379f876131afd8c2c71e) +* [validate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa221cef15629c5acf569329c0e089b3a) +* [value](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aafaaa11ebda98ac168f489abd5385422) +* [value](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a71678d5b3009123d0401d7715c5dcdf6) + +## Properties + + +### Property hasChanged + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IBooleanArray::hasChanged +``` + + + + + + + +**Return type**: boolean + + +### Property hide + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IBooleanArray::hide +``` + + + + + + + +**Return type**: boolean + + +### Property OwningComponent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IBooleanArray::OwningComponent +``` + + + + + + + +**Return type**: LPDISPATCH + + +### Property size + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IBooleanArray::size +``` + + + + + + + +**Return type**: long + + +### Property numDimensions + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IBooleanArray::numDimensions +``` + + + + + + + +**Return type**: long + + +### Property description + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IBooleanArray::description +``` + + + +Description of the array. + + + +**Return type**: BSTR + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 936) + +``` +VARIANT ModelCenter::IBooleanArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9) +``` + + + +Get the value of an array element. + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + +**Returns**: + +The value. + + + +**Return type**: VARIANT + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 952) + +``` +BOOL ModelCenter::IBooleanArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9,[optional] VARIANT d10) +``` + + + +Set the value of an array element. + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). +* **newValue**: The new value. + + + +**Return type**: BOOL + +## Public functions + + +### Function isValid + +![][public] + +``` +boolean ModelCenter::IBooleanArray::isValid() +``` + + + +Finds out whether or not the array is valid. + + + + + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Return type**: boolean + +**Reimplements**: [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) + + +### Function validate + +![][public] + +``` +void ModelCenter::IBooleanArray::validate() +``` + + + +Causes the array to validate itself. + + + +**Return type**: void + +**Reimplements**: [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IBooleanArray::getName() +``` + + + +Gets the name of the array. + + + + + + +**Returns**: + +The name of the array. + + + +**Return type**: BSTR + +**Reimplements**: [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IBooleanArray::getFullName() +``` + + + +Gets the full ModelCenter path of the array. + + + + + + +**Returns**: + +The full ModelCenter path of the array. + + + +**Return type**: BSTR + +**Reimplements**: [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IBooleanArray::getType() +``` + + + +Gets the type of the array. + + + + + + +**Returns**: + +The type of the array as a string. + + + +**Return type**: BSTR + +**Reimplements**: [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) + + +### Function isInput + +![][public] + +``` +boolean ModelCenter::IBooleanArray::isInput() +``` + + + +Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a364726a017aca71bdb22d43530cc9426). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) + + +### Function toString + +![][public] + +``` +BSTR ModelCenter::IBooleanArray::toString() +``` + + + +Converts the array to a string, validating it if necessary. The format is of the form "true, false, true" for one-dimensional arrays or "bounds[3,3] {true, false, true, false, true, false, true, false, true}" for multi-dimensional arrays. + + + + + + +**Returns**: + +String representation of the array. + + + +**Return type**: BSTR + +**Reimplements**: [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) + + +### Function fromString + +![][public] + +``` +void ModelCenter::IBooleanArray::fromString(BSTR value) +``` + + + +Sets the value of the array from a specified string. For 1D arrays, the specification is of the form 'true,false,true'.
+For nD arrays, the specification is of the form 'bounds[2,2,2] {true,false,true,false,true,false,true,false}'. + + + + + + +**Parameters**: + +* **value**: The new value. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + +**Reimplements**: [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) + + +### Function toStringAbsolute + +![][public] + +``` +BSTR ModelCenter::IBooleanArray::toStringAbsolute() +``` + + + +Converts the array to a string. The format is of the form "true, false, true" for one-dimensional arrays or "bounds[3,3] {true, false, true, false, true, false, true, false, true}" for multi-dimensional arrays. + + + + + + +**Returns**: + +String representation of the array. + + + +**Return type**: BSTR + +**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IBooleanArray::invalidate() +``` + + + +Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. + + + +**Return type**: void + +**Reimplements**: [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) + + +### Function directPrecedents + +![][public] + +``` +LPDISPATCH ModelCenter::IBooleanArray::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) + + +### Function directDependents + +![][public] + +``` +LPDISPATCH ModelCenter::IBooleanArray::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) + + +### Function precedentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IBooleanArray::precedentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) + + +### Function dependentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IBooleanArray::dependentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) + + +### Function precedents + +![][public] + +``` +LPDISPATCH ModelCenter::IBooleanArray::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) + + +### Function dependents + +![][public] + +``` +LPDISPATCH ModelCenter::IBooleanArray::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) + + +### Function isInputToComponent + +![][public] + +``` +boolean ModelCenter::IBooleanArray::isInputToComponent() +``` + + + +Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) + + +### Function isInputToModel + +![][public] + +``` +boolean ModelCenter::IBooleanArray::isInputToModel() +``` + + + +Checks whether or not the variable is an input. A linked input returns false (Output). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) + + +### Function setMetadata + +![][public] + +``` +void ModelCenter::IBooleanArray::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) +``` + + + +Sets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata specifier used to store the data. +* **type**:
+* **value**:
+* **access**:
+* **archive**:
+ + + +**Parameters**: + +* BSTR **name** +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** +* VARIANT **value** +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** +* boolean **archive** + +**Return type**: void + +**Reimplements**: [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) + + +### Function getMetadata + +![][public] + +``` +VARIANT ModelCenter::IBooleanArray::getMetadata(BSTR name) +``` + + + +Gets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata key name. + + +**Returns**: + +Metadata value. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +**Reimplements**: [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) + + +### Function toStringEx + +![][public] + +``` +BSTR ModelCenter::IBooleanArray::toStringEx(long index) +``` + + + +Converts the value of an array element to a string, validating the array if necessary. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The value of the element as a string. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + +**Reimplements**: [toStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a37c622ae9f50579f714ce98c0379cd98) + + +### Function fromStringEx + +![][public] + +``` +void ModelCenter::IBooleanArray::fromStringEx(BSTR value, long index) +``` + + + +Sets the value of an array element from a specified string. + + + + + + +**Parameters**: + +* **value**: New value. +* **index**: Index of the array element (0-based index). + + + +**Parameters**: + +* BSTR **value** +* long **index** + +**Return type**: void + +**Reimplements**: [fromStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad23f4082662c464be07251d6d1695a2d) + + +### Function toStringAbsoluteEx + +![][public] + +``` +BSTR ModelCenter::IBooleanArray::toStringAbsoluteEx(long index) +``` + + + +Converts the value of an array element to a string. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The value of the element as a string. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + +**Reimplements**: [toStringAbsoluteEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a2e3041440581aab716c684fe88d2ee87) + + +### Function getLength + +![][public] + +``` +long ModelCenter::IBooleanArray::getLength([optional] VARIANT dim) +``` + + + +Get the length of the n'th dimension of the array. + + + + + + +**Parameters**: + +* **dim**: Dimension of the array to query. This uses a 0 based index, so 0 will give you the first dimension, 1 the second, etc. If omitted, gives the first dimension + + +**Returns**: + +Length(size) of the array. + + + +**Parameters**: + +* _[optional]_ VARIANT **dim** + +**Return type**: long + +**Reimplements**: [getLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) + + +### Function setLength + +![][public] + +``` +void ModelCenter::IBooleanArray::setLength(long length, [optional] VARIANT dim) +``` + + + +Sets the length of the n'th dimension of the array + + + + + + +**Parameters**: + +* **length**: New length of the n'th dimension of the array +* **dim**: The dimension to set. This uses a 0 based index, so 0 will set the first dimension, 1 the second, etc. If omitted, sets the first dimension + + + +**Parameters**: + +* long **length** +* _[optional]_ VARIANT **dim** + +**Return type**: void + +**Reimplements**: [setLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) + + +### Function setDimensions + +![][public] + +``` +void ModelCenter::IBooleanArray::setDimensions(long d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Sets the number of dimensions of an array and the length of each dimension in one call. An array initializes to 0 length. If any dimension of the array has 0 length, the whole array contains no data. You must set the array size before filling in values unless you are using the [setArray()](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a783239a87a41ba31461d61df639dd5f4) call. + + + + + + +**Parameters**: + +* **d1**: length of the 1st dimension of the array +* **d2**: length of the 2nd dimension of the array. If omitted, the array is 1 dimensional +* **d3**: length of the 3rd dimension of the array. If omitted, the array is 2 dimensional +* **d4**: length of the 4th dimension of the array. If omitted, the array is 3 dimensional +* **d5**: length of the 5th dimension of the array. If omitted, the array is 4 dimensional +* **d6**: length of the 6th dimension of the array. If omitted, the array is 5 dimensional +* **d7**: length of the 7th dimension of the array. If omitted, the array is 6 dimensional +* **d8**: length of the 8th dimension of the array. If omitted, the array is 7 dimensional +* **d9**: length of the 9th dimension of the array. If omitted, the array is 8 dimensional +* **d10**: length of the 10th dimension of the array. If omitted, the array is 9 dimensional + + + +**Parameters**: + +* long **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: void + +**Reimplements**: [setDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) + + +### Function getValue + +![][public] + +``` +boolean ModelCenter::IBooleanArray::getValue(VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Gets the value of an array element. + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + +**Returns**: + +The value. + + + +**Parameters**: + +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: boolean + + +### Function setValue + +![][public] + +``` +void ModelCenter::IBooleanArray::setValue(BOOL value, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Sets the value of an array element. + + + + + + +**Parameters**: + +* **value**: The new value. +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + + +**Parameters**: + +* BOOL **value** +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: void + + +### Function getArray + +![][public] + +``` +VARIANT ModelCenter::IBooleanArray::getArray() +``` + + + +Get the COM array. + + + + + + +**Returns**: + +The COM array. + + + +**Return type**: VARIANT + + +### Function setArray + +![][public] + +``` +void ModelCenter::IBooleanArray::setArray(VARIANT array) +``` + + + +Sets the COM array. + + + + + + +**Parameters**: + +* **array**: The COM array. + + + +**Parameters**: + +* VARIANT **array** + +**Return type**: void + + +### Function getValueAbsolute + +![][public] + +``` +boolean ModelCenter::IBooleanArray::getValueAbsolute(VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Gets the value of an array element without validating. + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + +**Returns**: + +The value. + + + +**Parameters**: + +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: boolean + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IBooleanVariable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IBooleanVariable.md index ebf1809c6c..e16936a6d4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IBooleanVariable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IBooleanVariable.md @@ -1,829 +1,828 @@ - -# Interface ModelCenter::IBooleanVariable - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1045) - - - -COM Instance. - -**Inherits from**: - -* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) - -## Members - -* [dependentLinks](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a69e716f024970454d8c555c73df17360) -* [dependents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1afa6ea6f99c9eeb606ebe08b1e7d9c54d) -* [description](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a8035fb2b8276762f7b0b2b3e8b7d8cf5) -* [directDependents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a40dedf6b7b841a6699d545ea058ad2cd) -* [directPrecedents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ae54cdcd132e22278b8ddb00aaff236c7) -* [fromString](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a8b9fd88143b7b23e5f3ae9e229774a2b) -* [getFullName](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a19c8cfbcba0c9fc8eaae14bfaaa07d39) -* [getMetadata](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a74eae8f0c59826ea05228abfc9a9354a) -* [getName](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ac4595a4a7f2b81c6c5c2f1f5e3742f56) -* [getType](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a6e68844292a9f0b5e1924728465d02c0) -* [hasChanged](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a5b428150a22e87af248e5fc3277c70ae) -* [hide](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1aa3a5fa8309ca19d0bf787bbf7cbcbf54) -* [invalidate](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a1eecc6708b4fb8e29bfe73ead410adaa) -* [isInput](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ab8445c95fe06a4eb82ed55034c26d34e) -* [isInputToComponent](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1af27600cef7dfba2a97acbeb31e2bbe43) -* [isInputToModel](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a38875f7d7b47980f4d78d76a449bbb01) -* [isValid](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a877899b0c2bcc8400bcd8cfa31c4eb7a) -* [OwningComponent](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a67bcc3bdedde454663601bb945dd5bff) -* [precedentLinks](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ab5b740c028c3b878f1341efea2df0116) -* [precedents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1aa43bd8ee475029fc466b20cd3b1b686d) -* [setInitialValue](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a37b148f160421cc772d96d616cc58a67) -* [setMetadata](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a6771c11a9e1388bc4da11b9fae91e2e8) -* [toString](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a97263640728fae5de92a272345ce0a01) -* [toStringAbsolute](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ad3fdc29d883580eaf57b83a7b796c703) -* [validate](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ae3cb5f6c787efb879f5d85a5ee5ee344) -* [value](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a025854ed57fb252dde2b341182cd7e7a) -* [valueAbsolute](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a875503e8827a33a2d15497b21c50b840) - -## Properties - - -### Property hasChanged - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IBooleanVariable::hasChanged -``` - - - - - - - -**Return type**: boolean - - -### Property hide - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IBooleanVariable::hide -``` - - - - - - - -**Return type**: boolean - - -### Property OwningComponent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IBooleanVariable::OwningComponent -``` - - - - - - - -**Return type**: LPDISPATCH - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IBooleanVariable::value -``` - - - -The value of the variable. - - - -**Return type**: boolean - - -### Property valueAbsolute - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IBooleanVariable::valueAbsolute -``` - - - -The value of the variable. (Fetched without attempting to validate) - - - -**Return type**: boolean - - -### Property description - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IBooleanVariable::description -``` - - - -Description of the variable. - - - -**Return type**: BSTR - -## Public functions - - -### Function isValid - -![][public] - -``` -boolean ModelCenter::IBooleanVariable::isValid() -``` - - - -Returns whether or not the variable is valid. - - - - - - -**Returns**: - -True if variable is valid. False if the variable is not valid. - - - -**Return type**: boolean - -**Reimplements**: [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) - - -### Function validate - -![][public] - -``` -void ModelCenter::IBooleanVariable::validate() -``` - - - -Validates the variable by running the component if needed. - - - -**Return type**: void - -**Reimplements**: [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IBooleanVariable::getName() -``` - - - -Gets the name of the variable. - - - - - - -**Returns**: - -The name of the variable. - - - -**Return type**: BSTR - -**Reimplements**: [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IBooleanVariable::getFullName() -``` - - - -Gets the full ModelCenter path of the variable. - - - - - - -**Returns**: - -The full ModelCenter path of the variable. - - - -**Return type**: BSTR - -**Reimplements**: [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IBooleanVariable::getType() -``` - - - -Gets the type of the variable. - - - - - - -**Returns**: - -The type of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) - - -### Function isInput - -![][public] - -``` -boolean ModelCenter::IBooleanVariable::isInput() -``` - - - -Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a38875f7d7b47980f4d78d76a449bbb01). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) - - -### Function toString - -![][public] - -``` -BSTR ModelCenter::IBooleanVariable::toString() -``` - - - -Converts the variable value to a string, validating the variable if necessary. - - - - - - -**Returns**: - -The value of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) - - -### Function fromString - -![][public] - -``` -void ModelCenter::IBooleanVariable::fromString(BSTR value) -``` - - - -Sets the value of the variable from the specified string. - - - - - - -**Parameters**: - -* **value**: New value. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - -**Reimplements**: [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) - - -### Function toStringAbsolute - -![][public] - -``` -BSTR ModelCenter::IBooleanVariable::toStringAbsolute() -``` - - - -Converts the value of the variable to a string. - - - - - - -**Returns**: - -The value of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IBooleanVariable::invalidate() -``` - - - -Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. - - - -**Return type**: void - -**Reimplements**: [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) - - -### Function directPrecedents - -![][public] - -``` -LPDISPATCH ModelCenter::IBooleanVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) - - -### Function directDependents - -![][public] - -``` -LPDISPATCH ModelCenter::IBooleanVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) - - -### Function precedentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IBooleanVariable::precedentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) - - -### Function dependentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IBooleanVariable::dependentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) - - -### Function precedents - -![][public] - -``` -LPDISPATCH ModelCenter::IBooleanVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) - - -### Function dependents - -![][public] - -``` -LPDISPATCH ModelCenter::IBooleanVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) - - -### Function isInputToComponent - -![][public] - -``` -boolean ModelCenter::IBooleanVariable::isInputToComponent() -``` - - - -Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) - - -### Function isInputToModel - -![][public] - -``` -boolean ModelCenter::IBooleanVariable::isInputToModel() -``` - - - -Checks whether or not the variable is an input. A linked input returns false (Output). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) - - -### Function setMetadata - -![][public] - -``` -void ModelCenter::IBooleanVariable::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) -``` - - - -Sets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata specifier used to store the data. -* **type**:
-* **value**:
-* **access**:
-* **archive**:
- - - -**Parameters**: - -* BSTR **name** -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** -* VARIANT **value** -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** -* boolean **archive** - -**Return type**: void - -**Reimplements**: [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) - - -### Function getMetadata - -![][public] - -``` -VARIANT ModelCenter::IBooleanVariable::getMetadata(BSTR name) -``` - - - -Gets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata key name. - - -**Returns**: - -Metadata value. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -**Reimplements**: [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) - - -### Function setInitialValue - -![][public] - -``` -void ModelCenter::IBooleanVariable::setInitialValue(BOOL value) -``` - - - -Sets the initial value of the variable. - - - - - - -**Parameters**: - -* **value**: The initial value. - - - -**Parameters**: - -* BOOL **value** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IBooleanVariable + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1045) + + + +COM Instance. + +**Inherits from**: + +* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) + +## Members + +* [dependentLinks](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a69e716f024970454d8c555c73df17360) +* [dependents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1afa6ea6f99c9eeb606ebe08b1e7d9c54d) +* [description](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a8035fb2b8276762f7b0b2b3e8b7d8cf5) +* [directDependents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a40dedf6b7b841a6699d545ea058ad2cd) +* [directPrecedents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ae54cdcd132e22278b8ddb00aaff236c7) +* [fromString](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a8b9fd88143b7b23e5f3ae9e229774a2b) +* [getFullName](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a19c8cfbcba0c9fc8eaae14bfaaa07d39) +* [getMetadata](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a74eae8f0c59826ea05228abfc9a9354a) +* [getName](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ac4595a4a7f2b81c6c5c2f1f5e3742f56) +* [getType](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a6e68844292a9f0b5e1924728465d02c0) +* [hasChanged](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a5b428150a22e87af248e5fc3277c70ae) +* [hide](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1aa3a5fa8309ca19d0bf787bbf7cbcbf54) +* [invalidate](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a1eecc6708b4fb8e29bfe73ead410adaa) +* [isInput](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ab8445c95fe06a4eb82ed55034c26d34e) +* [isInputToComponent](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1af27600cef7dfba2a97acbeb31e2bbe43) +* [isInputToModel](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a38875f7d7b47980f4d78d76a449bbb01) +* [isValid](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a877899b0c2bcc8400bcd8cfa31c4eb7a) +* [OwningComponent](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a67bcc3bdedde454663601bb945dd5bff) +* [precedentLinks](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ab5b740c028c3b878f1341efea2df0116) +* [precedents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1aa43bd8ee475029fc466b20cd3b1b686d) +* [setInitialValue](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a37b148f160421cc772d96d616cc58a67) +* [setMetadata](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a6771c11a9e1388bc4da11b9fae91e2e8) +* [toString](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a97263640728fae5de92a272345ce0a01) +* [toStringAbsolute](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ad3fdc29d883580eaf57b83a7b796c703) +* [validate](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ae3cb5f6c787efb879f5d85a5ee5ee344) +* [value](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a025854ed57fb252dde2b341182cd7e7a) +* [valueAbsolute](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a875503e8827a33a2d15497b21c50b840) + +## Properties + + +### Property hasChanged + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IBooleanVariable::hasChanged +``` + + + + + + + +**Return type**: boolean + + +### Property hide + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IBooleanVariable::hide +``` + + + + + + + +**Return type**: boolean + + +### Property OwningComponent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IBooleanVariable::OwningComponent +``` + + + + + + + +**Return type**: LPDISPATCH + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IBooleanVariable::value +``` + + + +The value of the variable. + + + +**Return type**: boolean + + +### Property valueAbsolute + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IBooleanVariable::valueAbsolute +``` + + + +The value of the variable. (Fetched without attempting to validate) + + + +**Return type**: boolean + + +### Property description + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IBooleanVariable::description +``` + + + +Description of the variable. + + + +**Return type**: BSTR + +## Public functions + + +### Function isValid + +![][public] + +``` +boolean ModelCenter::IBooleanVariable::isValid() +``` + + + +Returns whether or not the variable is valid. + + + + + + +**Returns**: + +True if variable is valid. False if the variable is not valid. + + + +**Return type**: boolean + +**Reimplements**: [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) + + +### Function validate + +![][public] + +``` +void ModelCenter::IBooleanVariable::validate() +``` + + + +Validates the variable by running the component if needed. + + + +**Return type**: void + +**Reimplements**: [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IBooleanVariable::getName() +``` + + + +Gets the name of the variable. + + + + + + +**Returns**: + +The name of the variable. + + + +**Return type**: BSTR + +**Reimplements**: [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IBooleanVariable::getFullName() +``` + + + +Gets the full ModelCenter path of the variable. + + + + + + +**Returns**: + +The full ModelCenter path of the variable. + + + +**Return type**: BSTR + +**Reimplements**: [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IBooleanVariable::getType() +``` + + + +Gets the type of the variable. + + + + + + +**Returns**: + +The type of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) + + +### Function isInput + +![][public] + +``` +boolean ModelCenter::IBooleanVariable::isInput() +``` + + + +Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a38875f7d7b47980f4d78d76a449bbb01). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) + + +### Function toString + +![][public] + +``` +BSTR ModelCenter::IBooleanVariable::toString() +``` + + + +Converts the variable value to a string, validating the variable if necessary. + + + + + + +**Returns**: + +The value of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) + + +### Function fromString + +![][public] + +``` +void ModelCenter::IBooleanVariable::fromString(BSTR value) +``` + + + +Sets the value of the variable from the specified string. + + + + + + +**Parameters**: + +* **value**: New value. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + +**Reimplements**: [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) + + +### Function toStringAbsolute + +![][public] + +``` +BSTR ModelCenter::IBooleanVariable::toStringAbsolute() +``` + + + +Converts the value of the variable to a string. + + + + + + +**Returns**: + +The value of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IBooleanVariable::invalidate() +``` + + + +Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. + + + +**Return type**: void + +**Reimplements**: [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) + + +### Function directPrecedents + +![][public] + +``` +LPDISPATCH ModelCenter::IBooleanVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) + + +### Function directDependents + +![][public] + +``` +LPDISPATCH ModelCenter::IBooleanVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) + + +### Function precedentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IBooleanVariable::precedentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) + + +### Function dependentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IBooleanVariable::dependentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) + + +### Function precedents + +![][public] + +``` +LPDISPATCH ModelCenter::IBooleanVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) + + +### Function dependents + +![][public] + +``` +LPDISPATCH ModelCenter::IBooleanVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) + + +### Function isInputToComponent + +![][public] + +``` +boolean ModelCenter::IBooleanVariable::isInputToComponent() +``` + + + +Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) + + +### Function isInputToModel + +![][public] + +``` +boolean ModelCenter::IBooleanVariable::isInputToModel() +``` + + + +Checks whether or not the variable is an input. A linked input returns false (Output). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) + + +### Function setMetadata + +![][public] + +``` +void ModelCenter::IBooleanVariable::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) +``` + + + +Sets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata specifier used to store the data. +* **type**:
+* **value**:
+* **access**:
+* **archive**:
+ + + +**Parameters**: + +* BSTR **name** +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** +* VARIANT **value** +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** +* boolean **archive** + +**Return type**: void + +**Reimplements**: [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) + + +### Function getMetadata + +![][public] + +``` +VARIANT ModelCenter::IBooleanVariable::getMetadata(BSTR name) +``` + + + +Gets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata key name. + + +**Returns**: + +Metadata value. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +**Reimplements**: [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) + + +### Function setInitialValue + +![][public] + +``` +void ModelCenter::IBooleanVariable::setInitialValue(BOOL value) +``` + + + +Sets the initial value of the variable. + + + + + + +**Parameters**: + +* **value**: The initial value. + + + +**Parameters**: + +* BOOL **value** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ICachePin.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ICachePin.md index 08066d921e..5f75ccf089 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ICachePin.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ICachePin.md @@ -1,167 +1,166 @@ - -# Interface ModelCenter::ICachePin - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6566) - - - -A set of methods for cache pin functions. A cache pin is a "smart" pointer that manages file upload and download of a file to/from a cache. - -## Members - -* [checkinOnFlush](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1af839cced75ed11439b0027a55c6ab604) -* [IsValid](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1a6dd8e8226f7d5b089ef7e4ae49ca8b87) -* [LocalPath](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1abfc95b5a36c4544b8f58aaffc0d74751) -* [releasePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1a4349fd2038cad3cc22e04eba3d9effe5) -* [Url](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1a8dcb7034aa38f98bae308f4a9425ee43) - -## Properties - - -### Property Url - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::ICachePin::Url -``` - - - -Get the original URI of the resource; an invalid URI if nothing is pinned. - - - - - - -**Returns**: - -The original URI of the resource, or an invalid URI if nothing pinned. - - - -**Return type**: BSTR - - -### Property LocalPath - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::ICachePin::LocalPath -``` - - - -Get the local path of the file in the cache; empty if nothing is pinned. - - - - - - -**Returns**: - -The local path of the file in the cache, or empty if nothing pinned. - - - -**Return type**: BSTR - - -### Property IsValid - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::ICachePin::IsValid -``` - - - -Is this object pinning a file? - - - - - - -**Returns**: - -true or false - - - -**Return type**: boolean - -## Public functions - - -### Function releasePin - -![][public] - -``` -boolean ModelCenter::ICachePin::releasePin() -``` - - - -Unpin the current file if a file is pinned. Does not guarantee that the file will be flushed unless this was the last active pin on the file. - - - - - - -**Returns**: - -true if a file was previously pinned or false if not - - - -**Return type**: boolean - - -### Function checkinOnFlush - -![][public] - -``` -void ModelCenter::ICachePin::checkinOnFlush(BSTR message) -``` - - - -Checkin with the specified message when the file is unpinned. It must be open for write, and will be placed under version control if it isn't already. If the medium does not support version control, this is a no-op. - - - - - - -**Parameters**: - -* **message**: the checkin message; may not be nullptr - - - -**Parameters**: - -* BSTR **message** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::ICachePin + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6566) + + + +A set of methods for cache pin functions. A cache pin is a "smart" pointer that manages file upload and download of a file to/from a cache. + +## Members + +* [checkinOnFlush](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1af839cced75ed11439b0027a55c6ab604) +* [IsValid](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1a6dd8e8226f7d5b089ef7e4ae49ca8b87) +* [LocalPath](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1abfc95b5a36c4544b8f58aaffc0d74751) +* [releasePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1a4349fd2038cad3cc22e04eba3d9effe5) +* [Url](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin_1a8dcb7034aa38f98bae308f4a9425ee43) + +## Properties + + +### Property Url + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::ICachePin::Url +``` + + + +Get the original URI of the resource; an invalid URI if nothing is pinned. + + + + + + +**Returns**: + +The original URI of the resource, or an invalid URI if nothing pinned. + + + +**Return type**: BSTR + + +### Property LocalPath + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::ICachePin::LocalPath +``` + + + +Get the local path of the file in the cache; empty if nothing is pinned. + + + + + + +**Returns**: + +The local path of the file in the cache, or empty if nothing pinned. + + + +**Return type**: BSTR + + +### Property IsValid + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::ICachePin::IsValid +``` + + + +Is this object pinning a file? + + + + + + +**Returns**: + +true or false + + + +**Return type**: boolean + +## Public functions + + +### Function releasePin + +![][public] + +``` +boolean ModelCenter::ICachePin::releasePin() +``` + + + +Unpin the current file if a file is pinned. Does not guarantee that the file will be flushed unless this was the last active pin on the file. + + + + + + +**Returns**: + +true if a file was previously pinned or false if not + + + +**Return type**: boolean + + +### Function checkinOnFlush + +![][public] + +``` +void ModelCenter::ICachePin::checkinOnFlush(BSTR message) +``` + + + +Checkin with the specified message when the file is unpinned. It must be open for write, and will be placed under version control if it isn't already. If the medium does not support version control, this is a no-op. + + + + + + +**Parameters**: + +* **message**: the checkin message; may not be nullptr + + + +**Parameters**: + +* BSTR **message** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IComponent.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IComponent.md index b442c50d2d..812cbcd3f2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IComponent.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IComponent.md @@ -1,677 +1,676 @@ - -# Interface ModelCenter::IComponent - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1120) - - - -COM Instance. - -**Inherited by**: - -* [ModelCenter::IIfComponent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent) -* [ModelCenter::IScriptComponent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent) - -## Members - -* [AssociatedFiles](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aecece7b57424f027ba567415051d3bb5) -* [downloadValues](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a761c665246557b5b4201873a722d6fed) -* [getFullName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9309a89032b2d7d28baf279a3b76b5e8) -* [getMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a2bd6e585619f4cd76426932b62dcf60a) -* [getName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a19763f04596904ff5cab2f4f72f6f501) -* [getPositionX](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a0c3e0c952584ba25801114e01010eab0) -* [getPositionY](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1ad3da2b98a973112ea897cf3b146f0276) -* [getSource](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a7ee6752f95f3bdfbe83132a3a7794cb2) -* [getType](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a04395c5a8d6ceff26ae08e6c001bdd45) -* [getVariable](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afb270ae53383589c63f87b4e3385f128) -* [Groups](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a4393774e2d80bd06dfe8070ef87b146f) -* [IndexInParent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aafafc5168a78769e88de4505174b0daf) -* [invalidate](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a73c230184c72f5abcb7d3af5f91c9d1e) -* [invokeMethod](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afaddb2c21be03b26716594af883a51ee) -* [ParentAssembly](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a2da9bef2e46c87080698e624d80710f0) -* [reconnect](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a44d641cc9d4a797f88e56495c466479c) -* [rename](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9cae71e48e01e94d48c0353d3db4d90c) -* [run](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1adf60ad0c84852250f14d27cfa689d8d0) -* [setMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a41eb816b08e0e89739822ba87e5416c6) -* [show](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aa35c0fb45f677b3c2daf475e53107773) -* [userData](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1ae7e1acce8fef11c88ba939aba11604ee) -* [Variables](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aad57025fe620abbaae1543962ed2676c) - -## Properties - - -### Property Variables - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IComponent::Variables -``` - - - -Pointer to the variables in the Component. - - - - - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Return type**: VARIANT - - -### Property Groups - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IComponent::Groups -``` - - - -Pointer to the Groups in the Component. - - - - - - -**Returns**: - -IDispatch* to an [IGroups](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups) object. - - - -**Return type**: VARIANT - - -### Property userData - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IComponent::userData -``` - - - -An arbitrary Variant which is not used internally by ModelCenter but can store data for programmatic purposes. Value is not stored across file save/load. - - - -**Return type**: VARIANT - - -### Property AssociatedFiles - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IComponent::AssociatedFiles -``` - - - -A set of files associated with the Component. - - - - - - -**Returns**: - -Variant containing the list of associated files (string or array of strings) - - - -**Return type**: VARIANT - - -### Property IndexInParent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -int ModelCenter::IComponent::IndexInParent -``` - - - -Position of this component in the parent Assembly. - - - -**Return type**: int - - -### Property ParentAssembly - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IComponent::ParentAssembly -``` - - - -Parent assembly to this component. - - - - - - -**Returns**: - -IDispatch* to an [IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) object. - - - -**Return type**: LPDISPATCH - -## Public functions - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IComponent::getName() -``` - - - -Gets the name of the Component. - - - - - - -**Returns**: - -The name of the Component. - - - -**Return type**: BSTR - -**Reimplemented by**: - -* [getName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a97c817507e162f9422b2f73ab5c8cef1) -* [getName](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a88c3162ff460faee36d43d3903c7a498) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IComponent::getFullName() -``` - - - -Gets the full [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) path of the Component. - - - - - - -**Returns**: - -the full ModelCenter path of the Component. - - - -**Return type**: BSTR - -**Reimplemented by**: - -* [getFullName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a5766e80ec09baf80e3ad7c28e4dd3bd4) -* [getFullName](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a7e4a9eb5127e60bfbbd90640e35b32a7) - - -### Function run - -![][public] - -``` -void ModelCenter::IComponent::run() -``` - - - -Runs the Component. - - - -**Return type**: void - -**Reimplemented by**: - -* [run](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a7891e5012feff9e7bbdec3bde6adb8e6) -* [run](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1afcc83d74aabc7ddd66da4fccb708f0e9) - - -### Function getSource - -![][public] - -``` -BSTR ModelCenter::IComponent::getSource() -``` - - - -Gets the source of the Component. - - - - - - -**Returns**: - -The source of the Component. - - - -**Return type**: BSTR - -**Reimplemented by**: - -* [getSource](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae4cad8560e705e807f793a2dade750e2) -* [getSource](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a3dc2690409dd67fc5b3023e50d7abed0) - - -### Function invokeMethod - -![][public] - -``` -void ModelCenter::IComponent::invokeMethod(BSTR method) -``` - - - -Invokes one of the Component's methods. - - - - - - -**Parameters**: - -* **method**: The name of the method to invoke. - - - -**Parameters**: - -* BSTR **method** - -**Return type**: void - -**Reimplemented by**: - -* [invokeMethod](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a583b809498c69beadd39c1e21e2cebab) -* [invokeMethod](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a03484bf5c7636d2015b3b11c3849ac30) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IComponent::invalidate() -``` - - - -Invalidates the Component and all of its variables. - - - -**Return type**: void - -**Reimplemented by**: - -* [invalidate](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a78101d039853db9e2d989edef97f226b) -* [invalidate](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a70b40fcdb20ca2991b3db649f77eb55f) - - -### Function reconnect - -![][public] - -``` -void ModelCenter::IComponent::reconnect() -``` - - - -Reconnect a Component. - - - -**Return type**: void - -**Reimplemented by**: - -* [reconnect](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a67e294fa372905721460635514adcd35) -* [reconnect](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a716d694026d6ef45a78ab51a8d1f6eae) - - -### Function downloadValues - -![][public] - -``` -void ModelCenter::IComponent::downloadValues() -``` - - - -Downloads the component's variable values from [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) Remote Execution, if it's a MCRE component. - - - -**Return type**: void - -**Reimplemented by**: - -* [downloadValues](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a610d24ca2e023e09194b29c3115c6d84) -* [downloadValues](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ae380bd13a2c92b3392432f879e87baf2) - - -### Function getVariable - -![][public] - -``` -LPDISPATCH ModelCenter::IComponent::getVariable(BSTR name) -``` - - - -Gets the Variable by the specified name. - - - - - - -**Parameters**: - -* **name**: The name of the variable to retrieve in dotted notation relative to the Component. - - -**Returns**: - -IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: LPDISPATCH - -**Reimplemented by**: - -* [getVariable](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1af46fd2a7e5dda89d73e347b2fff75d16) -* [getVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ad88148c419a4c75c4c79b9d5e3c41eb6) - - -### Function rename - -![][public] - -``` -void ModelCenter::IComponent::rename(BSTR name) -``` - - - -Renames the current Component. - - - - - - -**Parameters**: - -* **name**: New name of the Component. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: void - -**Reimplemented by**: - -* [rename](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae64ae2e0082f2379391e6a49d5e57192) -* [rename](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a775db6663f994e82bb2529efe6585c8d) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IComponent::getType() -``` - - - -Gets the type of the component. Valid types include: -* Component - -* Assembly - -* Sequence - -* If - -* Parallel - -* Empty - -* ForEach - - - - - - - - -**Returns**: - -The type of the component. - - - -**Return type**: BSTR - -**Reimplemented by**: - -* [getType](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a9cbf40ea5229f4240bdb241e8d88329c) -* [getType](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a551d15c4f328f341d8cba0fe28bfd2b0) - - -### Function show - -![][public] - -``` -void ModelCenter::IComponent::show() -``` - - - -Show the GUI form associated with the component, if any. - - - -**Return type**: void - -**Reimplemented by**: - -* [show](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a344fe33286c0d548dfb35b472cfcc1d6) -* [show](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ad7d6f94d38270f36b80ed3c0109312dd) - - -### Function setMetadata - -![][public] - -``` -void ModelCenter::IComponent::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) -``` - - - -Sets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata specifier used to store the data. -* **type**:
-* **value**:
-* **access**:
-* **archive**:
- - - -**Parameters**: - -* BSTR **name** -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** -* VARIANT **value** -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** -* boolean **archive** - -**Return type**: void - - -### Function getMetadata - -![][public] - -``` -VARIANT ModelCenter::IComponent::getMetadata(BSTR name) -``` - - - -Gets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata key name. - - -**Returns**: - -Metadata value. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -## Private functions - - -### Function getPositionX - -![][private] - -``` -int ModelCenter::IComponent::getPositionX() -``` - - - - - - - -**Return type**: int - -**Reimplemented by**: - -* [getPositionX](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a205b99507e64a1ad621ee6aeb6cd6d0c) -* [getPositionX](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aa032eb6b3c27a69052a8eb81053dfc34) - - -### Function getPositionY - -![][private] - -``` -int ModelCenter::IComponent::getPositionY() -``` - - - - - - - -**Return type**: int - -**Reimplemented by**: - -* [getPositionY](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6cddb9b21c6b3b60a23f2a28d60ea17a) -* [getPositionY](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a7b5ce3f6ce5bfd44702ff1fb874fb9fd) - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IComponent + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1120) + + + +COM Instance. + +**Inherited by**: + +* [ModelCenter::IIfComponent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent) +* [ModelCenter::IScriptComponent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent) + +## Members + +* [AssociatedFiles](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aecece7b57424f027ba567415051d3bb5) +* [downloadValues](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a761c665246557b5b4201873a722d6fed) +* [getFullName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9309a89032b2d7d28baf279a3b76b5e8) +* [getMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a2bd6e585619f4cd76426932b62dcf60a) +* [getName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a19763f04596904ff5cab2f4f72f6f501) +* [getPositionX](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a0c3e0c952584ba25801114e01010eab0) +* [getPositionY](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1ad3da2b98a973112ea897cf3b146f0276) +* [getSource](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a7ee6752f95f3bdfbe83132a3a7794cb2) +* [getType](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a04395c5a8d6ceff26ae08e6c001bdd45) +* [getVariable](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afb270ae53383589c63f87b4e3385f128) +* [Groups](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a4393774e2d80bd06dfe8070ef87b146f) +* [IndexInParent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aafafc5168a78769e88de4505174b0daf) +* [invalidate](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a73c230184c72f5abcb7d3af5f91c9d1e) +* [invokeMethod](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afaddb2c21be03b26716594af883a51ee) +* [ParentAssembly](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a2da9bef2e46c87080698e624d80710f0) +* [reconnect](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a44d641cc9d4a797f88e56495c466479c) +* [rename](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9cae71e48e01e94d48c0353d3db4d90c) +* [run](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1adf60ad0c84852250f14d27cfa689d8d0) +* [setMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a41eb816b08e0e89739822ba87e5416c6) +* [show](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aa35c0fb45f677b3c2daf475e53107773) +* [userData](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1ae7e1acce8fef11c88ba939aba11604ee) +* [Variables](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aad57025fe620abbaae1543962ed2676c) + +## Properties + + +### Property Variables + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IComponent::Variables +``` + + + +Pointer to the variables in the Component. + + + + + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Return type**: VARIANT + + +### Property Groups + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IComponent::Groups +``` + + + +Pointer to the Groups in the Component. + + + + + + +**Returns**: + +IDispatch* to an [IGroups](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups) object. + + + +**Return type**: VARIANT + + +### Property userData + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IComponent::userData +``` + + + +An arbitrary Variant which is not used internally by ModelCenter but can store data for programmatic purposes. Value is not stored across file save/load. + + + +**Return type**: VARIANT + + +### Property AssociatedFiles + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IComponent::AssociatedFiles +``` + + + +A set of files associated with the Component. + + + + + + +**Returns**: + +Variant containing the list of associated files (string or array of strings) + + + +**Return type**: VARIANT + + +### Property IndexInParent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +int ModelCenter::IComponent::IndexInParent +``` + + + +Position of this component in the parent Assembly. + + + +**Return type**: int + + +### Property ParentAssembly + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IComponent::ParentAssembly +``` + + + +Parent assembly to this component. + + + + + + +**Returns**: + +IDispatch* to an [IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) object. + + + +**Return type**: LPDISPATCH + +## Public functions + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IComponent::getName() +``` + + + +Gets the name of the Component. + + + + + + +**Returns**: + +The name of the Component. + + + +**Return type**: BSTR + +**Reimplemented by**: + +* [getName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a97c817507e162f9422b2f73ab5c8cef1) +* [getName](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a88c3162ff460faee36d43d3903c7a498) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IComponent::getFullName() +``` + + + +Gets the full [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) path of the Component. + + + + + + +**Returns**: + +the full ModelCenter path of the Component. + + + +**Return type**: BSTR + +**Reimplemented by**: + +* [getFullName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a5766e80ec09baf80e3ad7c28e4dd3bd4) +* [getFullName](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a7e4a9eb5127e60bfbbd90640e35b32a7) + + +### Function run + +![][public] + +``` +void ModelCenter::IComponent::run() +``` + + + +Runs the Component. + + + +**Return type**: void + +**Reimplemented by**: + +* [run](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a7891e5012feff9e7bbdec3bde6adb8e6) +* [run](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1afcc83d74aabc7ddd66da4fccb708f0e9) + + +### Function getSource + +![][public] + +``` +BSTR ModelCenter::IComponent::getSource() +``` + + + +Gets the source of the Component. + + + + + + +**Returns**: + +The source of the Component. + + + +**Return type**: BSTR + +**Reimplemented by**: + +* [getSource](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae4cad8560e705e807f793a2dade750e2) +* [getSource](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a3dc2690409dd67fc5b3023e50d7abed0) + + +### Function invokeMethod + +![][public] + +``` +void ModelCenter::IComponent::invokeMethod(BSTR method) +``` + + + +Invokes one of the Component's methods. + + + + + + +**Parameters**: + +* **method**: The name of the method to invoke. + + + +**Parameters**: + +* BSTR **method** + +**Return type**: void + +**Reimplemented by**: + +* [invokeMethod](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a583b809498c69beadd39c1e21e2cebab) +* [invokeMethod](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a03484bf5c7636d2015b3b11c3849ac30) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IComponent::invalidate() +``` + + + +Invalidates the Component and all of its variables. + + + +**Return type**: void + +**Reimplemented by**: + +* [invalidate](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a78101d039853db9e2d989edef97f226b) +* [invalidate](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a70b40fcdb20ca2991b3db649f77eb55f) + + +### Function reconnect + +![][public] + +``` +void ModelCenter::IComponent::reconnect() +``` + + + +Reconnect a Component. + + + +**Return type**: void + +**Reimplemented by**: + +* [reconnect](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a67e294fa372905721460635514adcd35) +* [reconnect](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a716d694026d6ef45a78ab51a8d1f6eae) + + +### Function downloadValues + +![][public] + +``` +void ModelCenter::IComponent::downloadValues() +``` + + + +Downloads the component's variable values from [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) Remote Execution, if it's a MCRE component. + + + +**Return type**: void + +**Reimplemented by**: + +* [downloadValues](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a610d24ca2e023e09194b29c3115c6d84) +* [downloadValues](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ae380bd13a2c92b3392432f879e87baf2) + + +### Function getVariable + +![][public] + +``` +LPDISPATCH ModelCenter::IComponent::getVariable(BSTR name) +``` + + + +Gets the Variable by the specified name. + + + + + + +**Parameters**: + +* **name**: The name of the variable to retrieve in dotted notation relative to the Component. + + +**Returns**: + +IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: LPDISPATCH + +**Reimplemented by**: + +* [getVariable](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1af46fd2a7e5dda89d73e347b2fff75d16) +* [getVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ad88148c419a4c75c4c79b9d5e3c41eb6) + + +### Function rename + +![][public] + +``` +void ModelCenter::IComponent::rename(BSTR name) +``` + + + +Renames the current Component. + + + + + + +**Parameters**: + +* **name**: New name of the Component. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: void + +**Reimplemented by**: + +* [rename](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae64ae2e0082f2379391e6a49d5e57192) +* [rename](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a775db6663f994e82bb2529efe6585c8d) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IComponent::getType() +``` + + + +Gets the type of the component. Valid types include: +* Component + +* Assembly + +* Sequence + +* If + +* Parallel + +* Empty + +* ForEach + + + + + + + + +**Returns**: + +The type of the component. + + + +**Return type**: BSTR + +**Reimplemented by**: + +* [getType](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a9cbf40ea5229f4240bdb241e8d88329c) +* [getType](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a551d15c4f328f341d8cba0fe28bfd2b0) + + +### Function show + +![][public] + +``` +void ModelCenter::IComponent::show() +``` + + + +Show the GUI form associated with the component, if any. + + + +**Return type**: void + +**Reimplemented by**: + +* [show](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a344fe33286c0d548dfb35b472cfcc1d6) +* [show](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ad7d6f94d38270f36b80ed3c0109312dd) + + +### Function setMetadata + +![][public] + +``` +void ModelCenter::IComponent::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) +``` + + + +Sets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata specifier used to store the data. +* **type**:
+* **value**:
+* **access**:
+* **archive**:
+ + + +**Parameters**: + +* BSTR **name** +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** +* VARIANT **value** +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** +* boolean **archive** + +**Return type**: void + + +### Function getMetadata + +![][public] + +``` +VARIANT ModelCenter::IComponent::getMetadata(BSTR name) +``` + + + +Gets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata key name. + + +**Returns**: + +Metadata value. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +## Private functions + + +### Function getPositionX + +![][private] + +``` +int ModelCenter::IComponent::getPositionX() +``` + + + + + + + +**Return type**: int + +**Reimplemented by**: + +* [getPositionX](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a205b99507e64a1ad621ee6aeb6cd6d0c) +* [getPositionX](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aa032eb6b3c27a69052a8eb81053dfc34) + + +### Function getPositionY + +![][private] + +``` +int ModelCenter::IComponent::getPositionY() +``` + + + + + + + +**Return type**: int + +**Reimplemented by**: + +* [getPositionY](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6cddb9b21c6b3b60a23f2a28d60ea17a) +* [getPositionY](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a7b5ce3f6ce5bfd44702ff1fb874fb9fd) + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IComponents.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IComponents.md index ee95afc4d1..b406ea4df4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IComponents.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IComponents.md @@ -1,78 +1,77 @@ - -# Interface ModelCenter::IComponents - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1263) - - - -COM Instance. - -## Members - -* [Count](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents_1a657951d45a2e5d44a882ecc04e4abbae) -* [Item](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents_1a497784a98d679aa2ed109130ae004e0a) - -## Properties - - -### Property Count - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IComponents::Count -``` - - - -Number of Components. - - - -**Return type**: VARIANT - -## Public functions - - -### Function Item - -![][public] - -``` -VARIANT ModelCenter::IComponents::Item(VARIANT id) -``` - - - -Gets a pointer to the specified Component. - - - - - - -**Parameters**: - -* **id**: ID of the specified Component. It can be a name or an index. - - -**Returns**: - -IDispatch* to an [IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) object. - - - -**Parameters**: - -* VARIANT **id** - -**Return type**: VARIANT - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IComponents + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1263) + + + +COM Instance. + +## Members + +* [Count](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents_1a657951d45a2e5d44a882ecc04e4abbae) +* [Item](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents_1a497784a98d679aa2ed109130ae004e0a) + +## Properties + + +### Property Count + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IComponents::Count +``` + + + +Number of Components. + + + +**Return type**: VARIANT + +## Public functions + + +### Function Item + +![][public] + +``` +VARIANT ModelCenter::IComponents::Item(VARIANT id) +``` + + + +Gets a pointer to the specified Component. + + + + + + +**Parameters**: + +* **id**: ID of the specified Component. It can be a name or an index. + + +**Returns**: + +IDispatch* to an [IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) object. + + + +**Parameters**: + +* VARIANT **id** + +**Return type**: VARIANT + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ICustomDesignPoint.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ICustomDesignPoint.md index 67eabab3e5..965c183496 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ICustomDesignPoint.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ICustomDesignPoint.md @@ -1,96 +1,95 @@ - -# Interface ModelCenter::ICustomDesignPoint - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1492) - - - -COM Instance. - -## Members - -* [addVariable](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint_1a3c20c3bc3fa7ae5fb36154448d3ae13d) -* [runFailed](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint_1a7c8bc37e4f17ff29cc066d8e9645d9dd) - -## Public functions - - -### Function addVariable - -![][public] - -``` -void ModelCenter::ICustomDesignPoint::addVariable(BSTR name, BSTR equation, BOOL isNumeric, BOOL isValid, BOOL isInput, BSTR type, BSTR units, BSTR value) -``` - - - -Adds a variable to the custom design point. - - - - - - -**Parameters**: - -* **name**: The Data Collector name of the variable (can be anything). -* **equation**: The equation (usually the full ModelCenter variable name). -* **isNumeric**: Whether or not the variable is numeric. -* **isValid**: Whether or not the variable is valid for this run. -* **isInput**: Whether or not this variable is an input. -* **type**: The variable's type, i.e. "double". -* **units**: The units of the variable. -* **value**: The value of the variable for this run. - - - -**Parameters**: - -* BSTR **name** -* BSTR **equation** -* BOOL **isNumeric** -* BOOL **isValid** -* BOOL **isInput** -* BSTR **type** -* BSTR **units** -* BSTR **value** - -**Return type**: void - - -### Function runFailed - -![][public] - -``` -void ModelCenter::ICustomDesignPoint::runFailed(BSTR reason) -``` - - - -Tells the Data Collector that this run failed. - - - - - - -**Parameters**: - -* **reason**: The reason the run failed. - - - -**Parameters**: - -* BSTR **reason** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::ICustomDesignPoint + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1492) + + + +COM Instance. + +## Members + +* [addVariable](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint_1a3c20c3bc3fa7ae5fb36154448d3ae13d) +* [runFailed](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint_1a7c8bc37e4f17ff29cc066d8e9645d9dd) + +## Public functions + + +### Function addVariable + +![][public] + +``` +void ModelCenter::ICustomDesignPoint::addVariable(BSTR name, BSTR equation, BOOL isNumeric, BOOL isValid, BOOL isInput, BSTR type, BSTR units, BSTR value) +``` + + + +Adds a variable to the custom design point. + + + + + + +**Parameters**: + +* **name**: The Data Collector name of the variable (can be anything). +* **equation**: The equation (usually the full ModelCenter variable name). +* **isNumeric**: Whether or not the variable is numeric. +* **isValid**: Whether or not the variable is valid for this run. +* **isInput**: Whether or not this variable is an input. +* **type**: The variable's type, i.e. "double". +* **units**: The units of the variable. +* **value**: The value of the variable for this run. + + + +**Parameters**: + +* BSTR **name** +* BSTR **equation** +* BOOL **isNumeric** +* BOOL **isValid** +* BOOL **isInput** +* BSTR **type** +* BSTR **units** +* BSTR **value** + +**Return type**: void + + +### Function runFailed + +![][public] + +``` +void ModelCenter::ICustomDesignPoint::runFailed(BSTR reason) +``` + + + +Tells the Data Collector that this run failed. + + + + + + +**Parameters**: + +* **reason**: The reason the run failed. + + + +**Parameters**: + +* BSTR **reason** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IDataCollector.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IDataCollector.md index db63e5119d..1bcc6b1880 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IDataCollector.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IDataCollector.md @@ -1,838 +1,837 @@ - -# Interface ModelCenter::IDataCollector - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1531) - - - -COM Instance. - -## Members - -* [addCustom](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1acd3adc12cd4f94a2dbf436e8617cbf8a) -* [createEmptyRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1ab152e50d67d452b3f301ea18f732183d) -* [enableCarpetPlotTab](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a1e13b83ec71a3274399832bfe3471364) -* [enableGraphTab](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa2efe037d15784acff1d3291c482f276) -* [enableMainEffectsTab](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a11a172f0d359597318448e52fd991843) -* [endRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1af2b0ccb145e2775fc9958d3500cfb4bc) -* [exportToCSV](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a75c4f95d0b30e6edb92f98e378f7c4be) -* [fromString](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a42e57bafd047e98fff2902f213c48f61) -* [getDataExplorer](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa0b0a16e2c3c1f600a8435d6dca0c096) -* [getErrorID](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a5fac36a5e20d349ab8941387af60a576) -* [getErrorMessage](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1ac93c96f43f475bc237f396b717bc5408) -* [getNumFailedRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa169d7ec12253068db8fac00e201f6a9) -* [getNumRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1abe6a941ef83e86184ba40149f775d3f8) -* [getNumVariables](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1acaa00471b667aa04d3462fa4e26f8d36) -* [getValue](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa3502b40206d864d5bebd8cec59c71ed) -* [getVariableDescription](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a12a4f4daac61b17022aa54dcbb3ec84e) -* [hide](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a75d77af56d17b13040ea831d957a4cab) -* [isValid](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a2d858bdac93de126a13ced552898b3f9) -* [isVisible](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a986646a10f5885304323ceb7a737c76b) -* [newCustomDesignPoint](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a04f9887e54ecdb60a1f30abbdfbf975b) -* [save](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a7d30505236a3c1c3b804da8f7f924e26) -* [selectX](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a54fca30f8b9b840cd4d130fffef89ba8) -* [selectY](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a82393da70a02822d7184a81430f45b94) -* [setCustomRun](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1ae0c7fcaf40dc9a73c3818e08fda4c954) -* [setNumExpectedRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a2760890872ed478c72439fc063f4e9aa) -* [show](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a2dcb6077094c93a8484123a0c5633dae) -* [startRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a4c2a3c1d083373801689d9dacc1fd530) -* [storeCurrentDesignPoint](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aed3d0ea61e181d39e6bbf38a5ad0a401) -* [storeCustomDesignPoint](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a0beef1e5e859c093f079e64792e9ed8e) -* [toString](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1af9938e6a1943072ae9e89a19e4461a3f) - -## Properties - - -### Property isVisible - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BOOL ModelCenter::IDataCollector::isVisible -``` - - - -Determine if the data collector is visible - - - -**Return type**: BOOL - -## Public functions - - -### Function storeCurrentDesignPoint - -![][public] - -``` -void ModelCenter::IDataCollector::storeCurrentDesignPoint() -``` - - - -Stores the current Model values into the Data Collector as a run. - - - -**Return type**: void - - -### Function enableGraphTab - -![][public] - -``` -void ModelCenter::IDataCollector::enableGraphTab(BOOL flag) -``` - - - -Enables or disables the graph tab. - - - - - - -**Parameters**: - -* **flag**: Enable(TRUE) or Disable(FALSE). - - - -**Parameters**: - -* BOOL **flag** - -**Return type**: void - - -### Function show - -![][public] - -``` -void ModelCenter::IDataCollector::show() -``` - - - -Displays the Data Collector GUI. - - - -**Return type**: void - - -### Function addCustom - -![][public] - -``` -void ModelCenter::IDataCollector::addCustom(BSTR variable, BSTR label) -``` - - - -Adds a custom variable to the Data Collector. - - - - - - -**Parameters**: - -* **variable**: Name of the custom variable. -* **label**: Label of the custom variable. - - - -**Parameters**: - -* BSTR **variable** -* BSTR **label** - -**Return type**: void - - -### Function selectX - -![][public] - -``` -void ModelCenter::IDataCollector::selectX(BSTR name) -``` - - - -Selects the x-axis variable for the Data Collector graph. - - - - - - -**Parameters**: - -* **name**: Full ModelCenter path of the variable. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: void - - -### Function selectY - -![][public] - -``` -void ModelCenter::IDataCollector::selectY(BSTR name) -``` - - - -Selects a y-axis variable for the Data Collector graph. More than one y-axis variable can be selected. - - - - - - -**Parameters**: - -* **name**: Full ModelCenter path of the variable. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: void - - -### Function setNumExpectedRuns - -![][public] - -``` -void ModelCenter::IDataCollector::setNumExpectedRuns(long numRuns) -``` - - - -Sets the range of the Data Collector progress meter. - - - - - - -**Parameters**: - -* **numRuns**: Number of expected runs. - - - -**Parameters**: - -* long **numRuns** - -**Return type**: void - - -### Function startRuns - -![][public] - -``` -void ModelCenter::IDataCollector::startRuns() -``` - - - -Informs the Data Collector that data is about to be collected. - - - -**Return type**: void - - -### Function endRuns - -![][public] - -``` -void ModelCenter::IDataCollector::endRuns() -``` - - - -Informs the Data Collector that data collection is complete. - - - -**Return type**: void - - -### Function getNumFailedRuns - -![][public] - -``` -long ModelCenter::IDataCollector::getNumFailedRuns() -``` - - - -Finds out how many runs failed in the Data Collector. - - - - - - -**Returns**: - -The number of failed runs. - - - -**Return type**: long - - -### Function getErrorID - -![][public] - -``` -int ModelCenter::IDataCollector::getErrorID(long run) -``` - - - -Gets the error ID for the specified run. If the ID is 0, then the run succeeded. - - - - - - -**Parameters**: - -* **run**: Index of the run you want the error ID for (0-based index). - - -**Returns**: - -The error ID. - - - -**Parameters**: - -* long **run** - -**Return type**: int - - -### Function getErrorMessage - -![][public] - -``` -BSTR ModelCenter::IDataCollector::getErrorMessage(long run) -``` - - - -Gets the error message for a specified run. - - - - - - -**Parameters**: - -* **run**: Index of the run you want the error ID for (0-based index). - - -**Returns**: - -The error message. - - - -**Parameters**: - -* long **run** - -**Return type**: BSTR - - -### Function getNumRuns - -![][public] - -``` -long ModelCenter::IDataCollector::getNumRuns() -``` - - - -Finds out how many runs are in the Data Collector. - - - - - - -**Returns**: - -The number of runs. - - - -**Return type**: long - - -### Function getNumVariables - -![][public] - -``` -long ModelCenter::IDataCollector::getNumVariables() -``` - - - -Finds out how many variables are in the Data Collector. - - - - - - -**Returns**: - -The number of variables. - - - -**Return type**: long - - -### Function getValue - -![][public] - -``` -VARIANT ModelCenter::IDataCollector::getValue(VARIANT index, long run) -``` - - - -Gets the value for a variable/run combination. - - - - - - -**Parameters**: - -* **index**: Index of the variable location (0-based index). -* **run**: Index of the run (0-based index). - - -**Returns**: - -The value. - - - -**Parameters**: - -* VARIANT **index** -* long **run** - -**Return type**: VARIANT - - -### Function getVariableDescription - -![][public] - -``` -IDispatch * ModelCenter::IDataCollector::getVariableDescription(VARIANT index) -``` - - - -Gets the description of a variable. - - - - - - -**Parameters**: - -* **index**: Index of the variable location (0-based index). - - -**Returns**: - -An IDispatch* to the description of the variable. - - - -**Parameters**: - -* VARIANT **index** - -**Return type**: IDispatch * - - -### Function isValid - -![][public] - -``` -BOOL ModelCenter::IDataCollector::isValid(VARIANT index, long run) -``` - - - -Finds out whether or not a variable/run combination is valid. - - - - - - -**Parameters**: - -* **index**: Index of the variable location (0-based index). -* **run**: Index of the run (0-based index). - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Parameters**: - -* VARIANT **index** -* long **run** - -**Return type**: BOOL - - -### Function save - -![][public] - -``` -void ModelCenter::IDataCollector::save(BSTR fileName, BSTR displayName, BSTR description, BSTR author, BOOL saveModel) -``` - - - -Saves the data to a .pxt(ModelCenter Trade Study) file. - - - - - - -**Parameters**: - -* **fileName**: Path of the .pxt file to be saved. -* **displayName**: Display name of the Trade Study. -* **description**: Description of the Trade Study. -* **author**: Author of the Trade Study. -* **saveModel**: Whether or not to save the Model as part of the Trade Study. - - - -**Parameters**: - -* BSTR **fileName** -* BSTR **displayName** -* BSTR **description** -* BSTR **author** -* BOOL **saveModel** - -**Return type**: void - - -### Function exportToCSV - -![][public] - -``` -void ModelCenter::IDataCollector::exportToCSV(BSTR fileName) -``` - - - -Saves the Data Collector data as a comma separated list of values. - - - - - - -**Parameters**: - -* **fileName**: Path of the .csv file to write. - - - -**Parameters**: - -* BSTR **fileName** - -**Return type**: void - - -### Function toString - -![][public] - -``` -BSTR ModelCenter::IDataCollector::toString() -``` - - - -Converts the Data Collector setup and data to a string. - - - - - - -**Returns**: - -Converted value of the Data Collector as a string. - - - -**Return type**: BSTR - - -### Function fromString - -![][public] - -``` -void ModelCenter::IDataCollector::fromString(BSTR str) -``` - - - -Restores the Data Collector data and setup from a string. - - - - - - -**Parameters**: - -* **str**: String containing the Data Collector setup. - - - -**Parameters**: - -* BSTR **str** - -**Return type**: void - - -### Function getDataExplorer - -![][public] - -``` -IDispatch * ModelCenter::IDataCollector::getDataExplorer() -``` - - - -Returns the ModelCenter 6.0 API style object for the Data Collector (termed the Data Explorer). - - - - - - -**Returns**: - -An IDispatch* to a IDataExplorer object. - - - -**Return type**: IDispatch * - - -### Function hide - -![][public] - -``` -void ModelCenter::IDataCollector::hide() -``` - - - -Hides the Data Collector. - - - -**Return type**: void - -## Private functions - - -### Function enableCarpetPlotTab - -![][private] - -``` -void ModelCenter::IDataCollector::enableCarpetPlotTab(BSTR var1, BSTR var2, BSTR plotVar) -``` - - - - - - - -**Parameters**: - -* BSTR **var1** -* BSTR **var2** -* BSTR **plotVar** - -**Return type**: void - - -### Function storeCustomDesignPoint - -![][private] - -``` -void ModelCenter::IDataCollector::storeCustomDesignPoint(IDispatch *customDesignPoint) -``` - - - - - - - -**Parameters**: - -* IDispatch * **customDesignPoint** - -**Return type**: void - - -### Function createEmptyRuns - -![][private] - -``` -void ModelCenter::IDataCollector::createEmptyRuns(long numEmptyRuns) -``` - - - - - - - -**Parameters**: - -* long **numEmptyRuns** - -**Return type**: void - - -### Function setCustomRun - -![][private] - -``` -void ModelCenter::IDataCollector::setCustomRun(long index, IDispatch *customDesignPoint) -``` - - - - - - - -**Parameters**: - -* long **index** -* IDispatch * **customDesignPoint** - -**Return type**: void - - -### Function newCustomDesignPoint - -![][private] - -``` -IDispatch * ModelCenter::IDataCollector::newCustomDesignPoint() -``` - - - - - - - -**Return type**: IDispatch * - - -### Function enableMainEffectsTab - -![][private] - -``` -void ModelCenter::IDataCollector::enableMainEffectsTab() -``` - - - - - - - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IDataCollector + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1531) + + + +COM Instance. + +## Members + +* [addCustom](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1acd3adc12cd4f94a2dbf436e8617cbf8a) +* [createEmptyRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1ab152e50d67d452b3f301ea18f732183d) +* [enableCarpetPlotTab](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a1e13b83ec71a3274399832bfe3471364) +* [enableGraphTab](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa2efe037d15784acff1d3291c482f276) +* [enableMainEffectsTab](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a11a172f0d359597318448e52fd991843) +* [endRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1af2b0ccb145e2775fc9958d3500cfb4bc) +* [exportToCSV](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a75c4f95d0b30e6edb92f98e378f7c4be) +* [fromString](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a42e57bafd047e98fff2902f213c48f61) +* [getDataExplorer](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa0b0a16e2c3c1f600a8435d6dca0c096) +* [getErrorID](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a5fac36a5e20d349ab8941387af60a576) +* [getErrorMessage](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1ac93c96f43f475bc237f396b717bc5408) +* [getNumFailedRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa169d7ec12253068db8fac00e201f6a9) +* [getNumRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1abe6a941ef83e86184ba40149f775d3f8) +* [getNumVariables](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1acaa00471b667aa04d3462fa4e26f8d36) +* [getValue](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aa3502b40206d864d5bebd8cec59c71ed) +* [getVariableDescription](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a12a4f4daac61b17022aa54dcbb3ec84e) +* [hide](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a75d77af56d17b13040ea831d957a4cab) +* [isValid](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a2d858bdac93de126a13ced552898b3f9) +* [isVisible](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a986646a10f5885304323ceb7a737c76b) +* [newCustomDesignPoint](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a04f9887e54ecdb60a1f30abbdfbf975b) +* [save](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a7d30505236a3c1c3b804da8f7f924e26) +* [selectX](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a54fca30f8b9b840cd4d130fffef89ba8) +* [selectY](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a82393da70a02822d7184a81430f45b94) +* [setCustomRun](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1ae0c7fcaf40dc9a73c3818e08fda4c954) +* [setNumExpectedRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a2760890872ed478c72439fc063f4e9aa) +* [show](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a2dcb6077094c93a8484123a0c5633dae) +* [startRuns](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a4c2a3c1d083373801689d9dacc1fd530) +* [storeCurrentDesignPoint](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1aed3d0ea61e181d39e6bbf38a5ad0a401) +* [storeCustomDesignPoint](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1a0beef1e5e859c093f079e64792e9ed8e) +* [toString](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector_1af9938e6a1943072ae9e89a19e4461a3f) + +## Properties + + +### Property isVisible + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BOOL ModelCenter::IDataCollector::isVisible +``` + + + +Determine if the data collector is visible + + + +**Return type**: BOOL + +## Public functions + + +### Function storeCurrentDesignPoint + +![][public] + +``` +void ModelCenter::IDataCollector::storeCurrentDesignPoint() +``` + + + +Stores the current Model values into the Data Collector as a run. + + + +**Return type**: void + + +### Function enableGraphTab + +![][public] + +``` +void ModelCenter::IDataCollector::enableGraphTab(BOOL flag) +``` + + + +Enables or disables the graph tab. + + + + + + +**Parameters**: + +* **flag**: Enable(TRUE) or Disable(FALSE). + + + +**Parameters**: + +* BOOL **flag** + +**Return type**: void + + +### Function show + +![][public] + +``` +void ModelCenter::IDataCollector::show() +``` + + + +Displays the Data Collector GUI. + + + +**Return type**: void + + +### Function addCustom + +![][public] + +``` +void ModelCenter::IDataCollector::addCustom(BSTR variable, BSTR label) +``` + + + +Adds a custom variable to the Data Collector. + + + + + + +**Parameters**: + +* **variable**: Name of the custom variable. +* **label**: Label of the custom variable. + + + +**Parameters**: + +* BSTR **variable** +* BSTR **label** + +**Return type**: void + + +### Function selectX + +![][public] + +``` +void ModelCenter::IDataCollector::selectX(BSTR name) +``` + + + +Selects the x-axis variable for the Data Collector graph. + + + + + + +**Parameters**: + +* **name**: Full ModelCenter path of the variable. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: void + + +### Function selectY + +![][public] + +``` +void ModelCenter::IDataCollector::selectY(BSTR name) +``` + + + +Selects a y-axis variable for the Data Collector graph. More than one y-axis variable can be selected. + + + + + + +**Parameters**: + +* **name**: Full ModelCenter path of the variable. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: void + + +### Function setNumExpectedRuns + +![][public] + +``` +void ModelCenter::IDataCollector::setNumExpectedRuns(long numRuns) +``` + + + +Sets the range of the Data Collector progress meter. + + + + + + +**Parameters**: + +* **numRuns**: Number of expected runs. + + + +**Parameters**: + +* long **numRuns** + +**Return type**: void + + +### Function startRuns + +![][public] + +``` +void ModelCenter::IDataCollector::startRuns() +``` + + + +Informs the Data Collector that data is about to be collected. + + + +**Return type**: void + + +### Function endRuns + +![][public] + +``` +void ModelCenter::IDataCollector::endRuns() +``` + + + +Informs the Data Collector that data collection is complete. + + + +**Return type**: void + + +### Function getNumFailedRuns + +![][public] + +``` +long ModelCenter::IDataCollector::getNumFailedRuns() +``` + + + +Finds out how many runs failed in the Data Collector. + + + + + + +**Returns**: + +The number of failed runs. + + + +**Return type**: long + + +### Function getErrorID + +![][public] + +``` +int ModelCenter::IDataCollector::getErrorID(long run) +``` + + + +Gets the error ID for the specified run. If the ID is 0, then the run succeeded. + + + + + + +**Parameters**: + +* **run**: Index of the run you want the error ID for (0-based index). + + +**Returns**: + +The error ID. + + + +**Parameters**: + +* long **run** + +**Return type**: int + + +### Function getErrorMessage + +![][public] + +``` +BSTR ModelCenter::IDataCollector::getErrorMessage(long run) +``` + + + +Gets the error message for a specified run. + + + + + + +**Parameters**: + +* **run**: Index of the run you want the error ID for (0-based index). + + +**Returns**: + +The error message. + + + +**Parameters**: + +* long **run** + +**Return type**: BSTR + + +### Function getNumRuns + +![][public] + +``` +long ModelCenter::IDataCollector::getNumRuns() +``` + + + +Finds out how many runs are in the Data Collector. + + + + + + +**Returns**: + +The number of runs. + + + +**Return type**: long + + +### Function getNumVariables + +![][public] + +``` +long ModelCenter::IDataCollector::getNumVariables() +``` + + + +Finds out how many variables are in the Data Collector. + + + + + + +**Returns**: + +The number of variables. + + + +**Return type**: long + + +### Function getValue + +![][public] + +``` +VARIANT ModelCenter::IDataCollector::getValue(VARIANT index, long run) +``` + + + +Gets the value for a variable/run combination. + + + + + + +**Parameters**: + +* **index**: Index of the variable location (0-based index). +* **run**: Index of the run (0-based index). + + +**Returns**: + +The value. + + + +**Parameters**: + +* VARIANT **index** +* long **run** + +**Return type**: VARIANT + + +### Function getVariableDescription + +![][public] + +``` +IDispatch * ModelCenter::IDataCollector::getVariableDescription(VARIANT index) +``` + + + +Gets the description of a variable. + + + + + + +**Parameters**: + +* **index**: Index of the variable location (0-based index). + + +**Returns**: + +An IDispatch* to the description of the variable. + + + +**Parameters**: + +* VARIANT **index** + +**Return type**: IDispatch * + + +### Function isValid + +![][public] + +``` +BOOL ModelCenter::IDataCollector::isValid(VARIANT index, long run) +``` + + + +Finds out whether or not a variable/run combination is valid. + + + + + + +**Parameters**: + +* **index**: Index of the variable location (0-based index). +* **run**: Index of the run (0-based index). + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Parameters**: + +* VARIANT **index** +* long **run** + +**Return type**: BOOL + + +### Function save + +![][public] + +``` +void ModelCenter::IDataCollector::save(BSTR fileName, BSTR displayName, BSTR description, BSTR author, BOOL saveModel) +``` + + + +Saves the data to a .pxt(ModelCenter Trade Study) file. + + + + + + +**Parameters**: + +* **fileName**: Path of the .pxt file to be saved. +* **displayName**: Display name of the Trade Study. +* **description**: Description of the Trade Study. +* **author**: Author of the Trade Study. +* **saveModel**: Whether or not to save the Model as part of the Trade Study. + + + +**Parameters**: + +* BSTR **fileName** +* BSTR **displayName** +* BSTR **description** +* BSTR **author** +* BOOL **saveModel** + +**Return type**: void + + +### Function exportToCSV + +![][public] + +``` +void ModelCenter::IDataCollector::exportToCSV(BSTR fileName) +``` + + + +Saves the Data Collector data as a comma separated list of values. + + + + + + +**Parameters**: + +* **fileName**: Path of the .csv file to write. + + + +**Parameters**: + +* BSTR **fileName** + +**Return type**: void + + +### Function toString + +![][public] + +``` +BSTR ModelCenter::IDataCollector::toString() +``` + + + +Converts the Data Collector setup and data to a string. + + + + + + +**Returns**: + +Converted value of the Data Collector as a string. + + + +**Return type**: BSTR + + +### Function fromString + +![][public] + +``` +void ModelCenter::IDataCollector::fromString(BSTR str) +``` + + + +Restores the Data Collector data and setup from a string. + + + + + + +**Parameters**: + +* **str**: String containing the Data Collector setup. + + + +**Parameters**: + +* BSTR **str** + +**Return type**: void + + +### Function getDataExplorer + +![][public] + +``` +IDispatch * ModelCenter::IDataCollector::getDataExplorer() +``` + + + +Returns the ModelCenter 6.0 API style object for the Data Collector (termed the Data Explorer). + + + + + + +**Returns**: + +An IDispatch* to a IDataExplorer object. + + + +**Return type**: IDispatch * + + +### Function hide + +![][public] + +``` +void ModelCenter::IDataCollector::hide() +``` + + + +Hides the Data Collector. + + + +**Return type**: void + +## Private functions + + +### Function enableCarpetPlotTab + +![][private] + +``` +void ModelCenter::IDataCollector::enableCarpetPlotTab(BSTR var1, BSTR var2, BSTR plotVar) +``` + + + + + + + +**Parameters**: + +* BSTR **var1** +* BSTR **var2** +* BSTR **plotVar** + +**Return type**: void + + +### Function storeCustomDesignPoint + +![][private] + +``` +void ModelCenter::IDataCollector::storeCustomDesignPoint(IDispatch *customDesignPoint) +``` + + + + + + + +**Parameters**: + +* IDispatch * **customDesignPoint** + +**Return type**: void + + +### Function createEmptyRuns + +![][private] + +``` +void ModelCenter::IDataCollector::createEmptyRuns(long numEmptyRuns) +``` + + + + + + + +**Parameters**: + +* long **numEmptyRuns** + +**Return type**: void + + +### Function setCustomRun + +![][private] + +``` +void ModelCenter::IDataCollector::setCustomRun(long index, IDispatch *customDesignPoint) +``` + + + + + + + +**Parameters**: + +* long **index** +* IDispatch * **customDesignPoint** + +**Return type**: void + + +### Function newCustomDesignPoint + +![][private] + +``` +IDispatch * ModelCenter::IDataCollector::newCustomDesignPoint() +``` + + + + + + + +**Return type**: IDispatch * + + +### Function enableMainEffectsTab + +![][private] + +``` +void ModelCenter::IDataCollector::enableMainEffectsTab() +``` + + + + + + + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IDataMonitor.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IDataMonitor.md index db8e41a878..c056222337 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IDataMonitor.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IDataMonitor.md @@ -1,810 +1,809 @@ - -# Interface ModelCenter::IDataMonitor - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6232) - - - -COM Instance. - -## Members - -* [addItem](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a4b0569ecb495f20688d98060df763895) -* [addUnlinkedItem](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a8b2b470a890a2177bc1028408c7275e6) -* [getAutoDelete](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a163f13ac67226dfe0d816950061cc386) -* [getColWidth](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1aa7c5595c9eabf857b3adc02d30dcbb8e) -* [getDisplayFullNames](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a0cd9a14f007afaa719e20b54439ea98d) -* [getDisplayUnits](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ac11b644fdbd9f5e184a120a3bb6c7eb0) -* [getHeight](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a906ba9f57a9a472e1a70c151a50b1155) -* [getLink](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a9861b3ad530a4efbe4925c89550e8cc5) -* [getName](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a69e3af3092c78b0c19d9e3fb719f9b4b) -* [getTitle](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ae6aab41ece2d9cf2ac4285aa10cf156e) -* [getWidth](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1adb51a1067e48f2e1ab9b79874a2d8a66) -* [getX](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a610ec59f3295fe819e3a1aadd043927b) -* [getY](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a15d2803f54702b2198a2f0dc3f36d80d) -* [isRenamed](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1add033400b2b1694d63f67126639c198f) -* [isValid](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1abc151c7ba70d7f1e6249942a627e2171) -* [removeItem](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a6137208858071bb7fa35bebadcbaea47) -* [removeLink](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ad8044ca189f473cbbf095756dd2668f9) -* [setAutoDelete](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a19e11dabaf88dae88622b82e9e53954a) -* [setColWidth](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ade404d7ea696919bbc331c9027315c0e) -* [setDisplayFullNames](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a8be2f10ef4448bc73d4dc7c57f3350ca) -* [setDisplayUnits](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1aeac431029c07dddd0397914f6fb4d9d1) -* [setLink](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a89561753d60d803cc6427c6af5005484) -* [setLocation](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1abb2aeef39615e67a90e950314ea02744) -* [setName](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1afbfd0ce277fb01a5539d791b371ab0de) -* [setSize](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ad76100b2b7c20def871a1ffdc745e5da) -* [setTitle](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a74456073f4bc7e13d954972991583b58) - -## Public functions - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IDataMonitor::getName(long row) -``` - - - -Retrieves the name associated a given row in the Data Monitor. - - - - - - -**Parameters**: - -* **row**: The row number in the Data Monitor of interest (0-based index). - - -**Returns**: - -The name of the row. - - - -**Parameters**: - -* long **row** - -**Return type**: BSTR - - -### Function setName - -![][public] - -``` -void ModelCenter::IDataMonitor::setName(long row, BSTR name) -``` - - - -Sets the display name of the specified row in the Data Monitor. - - - - - - -**Parameters**: - -* **row**: The row in the Data Monitor of interest (0-based index). -* **name**: The new display name. - - - -**Parameters**: - -* long **row** -* BSTR **name** - -**Return type**: void - - -### Function isRenamed - -![][public] - -``` -boolean ModelCenter::IDataMonitor::isRenamed(long row) -``` - - - -Determines whether the name of a row in the Data Monitor lines up to the ModelCenter variable it represents. - - - - - - -**Parameters**: - -* **row**: The row in the Data Monitor of interest (0-based index). - - -**Returns**: - -true or false - - - -**Parameters**: - -* long **row** - -**Return type**: boolean - - -### Function getLink - -![][public] - -``` -BSTR ModelCenter::IDataMonitor::getLink(long row) -``` - - - -Retrieves the ModelCenter variable associated with a given row in the Data Monitor. Returns a blank string if the specified row doesn't link to a ModelCenter variable. - - - - - - -**Parameters**: - -* **row**: The row number in the Data Monitor of interest (0-based index). - - -**Returns**: - -
- - - -**Parameters**: - -* long **row** - -**Return type**: BSTR - - -### Function setLink - -![][public] - -``` -boolean ModelCenter::IDataMonitor::setLink(long row, BSTR link) -``` - - - -Sets the ModelCenter variable associated with a given row in the Data Monitor. - - - - - - -**Parameters**: - -* **row**: The row in the Data Monitor of interest (0-based index). -* **link**: The ModelCenter variable to associate with a given row in the Data Monitor. - - -**Returns**: - -
- - - -**Parameters**: - -* long **row** -* BSTR **link** - -**Return type**: boolean - - -### Function addItem - -![][public] - -``` -int ModelCenter::IDataMonitor::addItem(BSTR name, BSTR link) -``` - - - -Add an item to the Data Monitor that links to a variable in the model. - - - - - - -**Parameters**: - -* **name**: The name to use for the item in the Data Monitor. -* **link**: The name of the ModelCenter variable this item links to. - - -**Returns**: - -
- - - -**Parameters**: - -* BSTR **name** -* BSTR **link** - -**Return type**: int - - -### Function addUnlinkedItem - -![][public] - -``` -int ModelCenter::IDataMonitor::addUnlinkedItem(BSTR name) -``` - - - -Add an item to the Data Monitor that does not link to a variable within ModelCenter. - - - - - - -**Parameters**: - -* **name**: The name to use for the item in the Data Monitor. - - -**Returns**: - -
- - - -**Parameters**: - -* BSTR **name** - -**Return type**: int - - -### Function removeItem - -![][public] - -``` -void ModelCenter::IDataMonitor::removeItem(long row) -``` - - - -Removes the selected row from the Data Monitor. - - - - - - -**Parameters**: - -* **row**: The row in the Data Monitor of interest (0-based index). - - - -**Parameters**: - -* long **row** - -**Return type**: void - - -### Function removeLink - -![][public] - -``` -void ModelCenter::IDataMonitor::removeLink(long row) -``` - - - -Removes the associated link from the row specified in the Data Monitor. - - - - - - -**Parameters**: - -* **row**: The row in the Data Monitor of interest (0-based index). - - - -**Parameters**: - -* long **row** - -**Return type**: void - - -### Function getDisplayFullNames - -![][public] - -``` -boolean ModelCenter::IDataMonitor::getDisplayFullNames() -``` - - - -Get the status of the "Display Full Names" option. - - - - - - -**Returns**: - -true or false - - - -**Return type**: boolean - - -### Function setDisplayFullNames - -![][public] - -``` -void ModelCenter::IDataMonitor::setDisplayFullNames(boolean) -``` - - - -Sets the "Display Full Names" option. - - - -**Parameters**: - -* boolean - -**Return type**: void - - -### Function getAutoDelete - -![][public] - -``` -boolean ModelCenter::IDataMonitor::getAutoDelete() -``` - - - -Gets the status of the Auto Delete option. - - - - - - -**Returns**: - -true or false - - - -**Return type**: boolean - - -### Function setAutoDelete - -![][public] - -``` -void ModelCenter::IDataMonitor::setAutoDelete(boolean) -``` - - - -Sets the status of the Auto Delete option. - - - -**Parameters**: - -* boolean - -**Return type**: void - - -### Function getDisplayUnits - -![][public] - -``` -boolean ModelCenter::IDataMonitor::getDisplayUnits() -``` - - - -Get the status of the "Display Units" option. - - - - - - -**Returns**: - -true or false - - - -**Return type**: boolean - - -### Function setDisplayUnits - -![][public] - -``` -void ModelCenter::IDataMonitor::setDisplayUnits(boolean) -``` - - - -Sets the "Display Units" option. - - - -**Parameters**: - -* boolean - -**Return type**: void - - -### Function getColWidth - -![][public] - -``` -int ModelCenter::IDataMonitor::getColWidth(long col) -``` - - - -Gets the column width for the specified column. - - - - - - -**Parameters**: - -* **col**: The column number to fetch the width of (0-based index). - - -**Returns**: - -The column width. - - - -**Parameters**: - -* long **col** - -**Return type**: int - - -### Function setColWidth - -![][public] - -``` -void ModelCenter::IDataMonitor::setColWidth(long col, int width) -``` - - - -Sets the width of the specified column. - - - - - - -**Parameters**: - -* **col**: The column in the Data Monitor of interest (0-based index). -* **width**: The new width for the column. - - - -**Parameters**: - -* long **col** -* int **width** - -**Return type**: void - - -### Function isValid - -![][public] - -``` -boolean ModelCenter::IDataMonitor::isValid() -``` - - - -Determines whether all the items in the Data Monitor are valid or not. - - - - - - -**Returns**: - -Yes (TRUE) or no (FALSE). - - - -**Return type**: boolean - - -### Function getTitle - -![][public] - -``` -BSTR ModelCenter::IDataMonitor::getTitle() -``` - - - -Gets the title of the Data Monitor. - - - - - - -**Returns**: - -The title of the Data Monitor. - - - -**Return type**: BSTR - - -### Function setTitle - -![][public] - -``` -void ModelCenter::IDataMonitor::setTitle(BSTR title) -``` - - - -Sets the title of the Data Monitor. - - - - - - -**Parameters**: - -* **title**: The new title of the Data Monitor. - - - -**Parameters**: - -* BSTR **title** - -**Return type**: void - - -### Function getWidth - -![][public] - -``` -int ModelCenter::IDataMonitor::getWidth() -``` - - - -Gets the width of the Data Monitor. - - - - - - -**Returns**: - -The width of the Data Monitor. - - - -**Return type**: int - - -### Function getHeight - -![][public] - -``` -int ModelCenter::IDataMonitor::getHeight() -``` - - - -Get the height of the Data Monitor. - - - - - - -**Returns**: - -The height of the Data Monitor. - - - -**Return type**: int - - -### Function setSize - -![][public] - -``` -void ModelCenter::IDataMonitor::setSize(int width, int height) -``` - - - -Sets the height and width of the Data Monitor. - - - - - - -**Parameters**: - -* **width**: The new width for the Data Monitor. -* **height**: The new height of the Data Monitor. - - - -**Parameters**: - -* int **width** -* int **height** - -**Return type**: void - - -### Function getX - -![][public] - -``` -int ModelCenter::IDataMonitor::getX() -``` - - - -Gets the X position of the Data Monitor. - - - - - - -**Returns**: - -The value of the X position of the Data Monitor. - - - -**Return type**: int - - -### Function getY - -![][public] - -``` -int ModelCenter::IDataMonitor::getY() -``` - - - -Gets the Y position of the Data Monitor. - - - - - - -**Returns**: - -The value of the Y position of the Data Monitor. - - - -**Return type**: int - - -### Function setLocation - -![][public] - -``` -void ModelCenter::IDataMonitor::setLocation(int x, int y) -``` - - - -Sets the x and y location of the Data Monitor in the Analysis View. - - - - - - -**Parameters**: - -* **x**: The new x position. -* **y**: The new y position. - - - -**Parameters**: - -* int **x** -* int **y** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IDataMonitor + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6232) + + + +COM Instance. + +## Members + +* [addItem](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a4b0569ecb495f20688d98060df763895) +* [addUnlinkedItem](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a8b2b470a890a2177bc1028408c7275e6) +* [getAutoDelete](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a163f13ac67226dfe0d816950061cc386) +* [getColWidth](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1aa7c5595c9eabf857b3adc02d30dcbb8e) +* [getDisplayFullNames](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a0cd9a14f007afaa719e20b54439ea98d) +* [getDisplayUnits](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ac11b644fdbd9f5e184a120a3bb6c7eb0) +* [getHeight](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a906ba9f57a9a472e1a70c151a50b1155) +* [getLink](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a9861b3ad530a4efbe4925c89550e8cc5) +* [getName](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a69e3af3092c78b0c19d9e3fb719f9b4b) +* [getTitle](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ae6aab41ece2d9cf2ac4285aa10cf156e) +* [getWidth](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1adb51a1067e48f2e1ab9b79874a2d8a66) +* [getX](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a610ec59f3295fe819e3a1aadd043927b) +* [getY](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a15d2803f54702b2198a2f0dc3f36d80d) +* [isRenamed](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1add033400b2b1694d63f67126639c198f) +* [isValid](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1abc151c7ba70d7f1e6249942a627e2171) +* [removeItem](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a6137208858071bb7fa35bebadcbaea47) +* [removeLink](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ad8044ca189f473cbbf095756dd2668f9) +* [setAutoDelete](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a19e11dabaf88dae88622b82e9e53954a) +* [setColWidth](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ade404d7ea696919bbc331c9027315c0e) +* [setDisplayFullNames](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a8be2f10ef4448bc73d4dc7c57f3350ca) +* [setDisplayUnits](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1aeac431029c07dddd0397914f6fb4d9d1) +* [setLink](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a89561753d60d803cc6427c6af5005484) +* [setLocation](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1abb2aeef39615e67a90e950314ea02744) +* [setName](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1afbfd0ce277fb01a5539d791b371ab0de) +* [setSize](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1ad76100b2b7c20def871a1ffdc745e5da) +* [setTitle](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor_1a74456073f4bc7e13d954972991583b58) + +## Public functions + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IDataMonitor::getName(long row) +``` + + + +Retrieves the name associated a given row in the Data Monitor. + + + + + + +**Parameters**: + +* **row**: The row number in the Data Monitor of interest (0-based index). + + +**Returns**: + +The name of the row. + + + +**Parameters**: + +* long **row** + +**Return type**: BSTR + + +### Function setName + +![][public] + +``` +void ModelCenter::IDataMonitor::setName(long row, BSTR name) +``` + + + +Sets the display name of the specified row in the Data Monitor. + + + + + + +**Parameters**: + +* **row**: The row in the Data Monitor of interest (0-based index). +* **name**: The new display name. + + + +**Parameters**: + +* long **row** +* BSTR **name** + +**Return type**: void + + +### Function isRenamed + +![][public] + +``` +boolean ModelCenter::IDataMonitor::isRenamed(long row) +``` + + + +Determines whether the name of a row in the Data Monitor lines up to the ModelCenter variable it represents. + + + + + + +**Parameters**: + +* **row**: The row in the Data Monitor of interest (0-based index). + + +**Returns**: + +true or false + + + +**Parameters**: + +* long **row** + +**Return type**: boolean + + +### Function getLink + +![][public] + +``` +BSTR ModelCenter::IDataMonitor::getLink(long row) +``` + + + +Retrieves the ModelCenter variable associated with a given row in the Data Monitor. Returns a blank string if the specified row doesn't link to a ModelCenter variable. + + + + + + +**Parameters**: + +* **row**: The row number in the Data Monitor of interest (0-based index). + + +**Returns**: + +
+ + + +**Parameters**: + +* long **row** + +**Return type**: BSTR + + +### Function setLink + +![][public] + +``` +boolean ModelCenter::IDataMonitor::setLink(long row, BSTR link) +``` + + + +Sets the ModelCenter variable associated with a given row in the Data Monitor. + + + + + + +**Parameters**: + +* **row**: The row in the Data Monitor of interest (0-based index). +* **link**: The ModelCenter variable to associate with a given row in the Data Monitor. + + +**Returns**: + +
+ + + +**Parameters**: + +* long **row** +* BSTR **link** + +**Return type**: boolean + + +### Function addItem + +![][public] + +``` +int ModelCenter::IDataMonitor::addItem(BSTR name, BSTR link) +``` + + + +Add an item to the Data Monitor that links to a variable in the model. + + + + + + +**Parameters**: + +* **name**: The name to use for the item in the Data Monitor. +* **link**: The name of the ModelCenter variable this item links to. + + +**Returns**: + +
+ + + +**Parameters**: + +* BSTR **name** +* BSTR **link** + +**Return type**: int + + +### Function addUnlinkedItem + +![][public] + +``` +int ModelCenter::IDataMonitor::addUnlinkedItem(BSTR name) +``` + + + +Add an item to the Data Monitor that does not link to a variable within ModelCenter. + + + + + + +**Parameters**: + +* **name**: The name to use for the item in the Data Monitor. + + +**Returns**: + +
+ + + +**Parameters**: + +* BSTR **name** + +**Return type**: int + + +### Function removeItem + +![][public] + +``` +void ModelCenter::IDataMonitor::removeItem(long row) +``` + + + +Removes the selected row from the Data Monitor. + + + + + + +**Parameters**: + +* **row**: The row in the Data Monitor of interest (0-based index). + + + +**Parameters**: + +* long **row** + +**Return type**: void + + +### Function removeLink + +![][public] + +``` +void ModelCenter::IDataMonitor::removeLink(long row) +``` + + + +Removes the associated link from the row specified in the Data Monitor. + + + + + + +**Parameters**: + +* **row**: The row in the Data Monitor of interest (0-based index). + + + +**Parameters**: + +* long **row** + +**Return type**: void + + +### Function getDisplayFullNames + +![][public] + +``` +boolean ModelCenter::IDataMonitor::getDisplayFullNames() +``` + + + +Get the status of the "Display Full Names" option. + + + + + + +**Returns**: + +true or false + + + +**Return type**: boolean + + +### Function setDisplayFullNames + +![][public] + +``` +void ModelCenter::IDataMonitor::setDisplayFullNames(boolean) +``` + + + +Sets the "Display Full Names" option. + + + +**Parameters**: + +* boolean + +**Return type**: void + + +### Function getAutoDelete + +![][public] + +``` +boolean ModelCenter::IDataMonitor::getAutoDelete() +``` + + + +Gets the status of the Auto Delete option. + + + + + + +**Returns**: + +true or false + + + +**Return type**: boolean + + +### Function setAutoDelete + +![][public] + +``` +void ModelCenter::IDataMonitor::setAutoDelete(boolean) +``` + + + +Sets the status of the Auto Delete option. + + + +**Parameters**: + +* boolean + +**Return type**: void + + +### Function getDisplayUnits + +![][public] + +``` +boolean ModelCenter::IDataMonitor::getDisplayUnits() +``` + + + +Get the status of the "Display Units" option. + + + + + + +**Returns**: + +true or false + + + +**Return type**: boolean + + +### Function setDisplayUnits + +![][public] + +``` +void ModelCenter::IDataMonitor::setDisplayUnits(boolean) +``` + + + +Sets the "Display Units" option. + + + +**Parameters**: + +* boolean + +**Return type**: void + + +### Function getColWidth + +![][public] + +``` +int ModelCenter::IDataMonitor::getColWidth(long col) +``` + + + +Gets the column width for the specified column. + + + + + + +**Parameters**: + +* **col**: The column number to fetch the width of (0-based index). + + +**Returns**: + +The column width. + + + +**Parameters**: + +* long **col** + +**Return type**: int + + +### Function setColWidth + +![][public] + +``` +void ModelCenter::IDataMonitor::setColWidth(long col, int width) +``` + + + +Sets the width of the specified column. + + + + + + +**Parameters**: + +* **col**: The column in the Data Monitor of interest (0-based index). +* **width**: The new width for the column. + + + +**Parameters**: + +* long **col** +* int **width** + +**Return type**: void + + +### Function isValid + +![][public] + +``` +boolean ModelCenter::IDataMonitor::isValid() +``` + + + +Determines whether all the items in the Data Monitor are valid or not. + + + + + + +**Returns**: + +Yes (TRUE) or no (FALSE). + + + +**Return type**: boolean + + +### Function getTitle + +![][public] + +``` +BSTR ModelCenter::IDataMonitor::getTitle() +``` + + + +Gets the title of the Data Monitor. + + + + + + +**Returns**: + +The title of the Data Monitor. + + + +**Return type**: BSTR + + +### Function setTitle + +![][public] + +``` +void ModelCenter::IDataMonitor::setTitle(BSTR title) +``` + + + +Sets the title of the Data Monitor. + + + + + + +**Parameters**: + +* **title**: The new title of the Data Monitor. + + + +**Parameters**: + +* BSTR **title** + +**Return type**: void + + +### Function getWidth + +![][public] + +``` +int ModelCenter::IDataMonitor::getWidth() +``` + + + +Gets the width of the Data Monitor. + + + + + + +**Returns**: + +The width of the Data Monitor. + + + +**Return type**: int + + +### Function getHeight + +![][public] + +``` +int ModelCenter::IDataMonitor::getHeight() +``` + + + +Get the height of the Data Monitor. + + + + + + +**Returns**: + +The height of the Data Monitor. + + + +**Return type**: int + + +### Function setSize + +![][public] + +``` +void ModelCenter::IDataMonitor::setSize(int width, int height) +``` + + + +Sets the height and width of the Data Monitor. + + + + + + +**Parameters**: + +* **width**: The new width for the Data Monitor. +* **height**: The new height of the Data Monitor. + + + +**Parameters**: + +* int **width** +* int **height** + +**Return type**: void + + +### Function getX + +![][public] + +``` +int ModelCenter::IDataMonitor::getX() +``` + + + +Gets the X position of the Data Monitor. + + + + + + +**Returns**: + +The value of the X position of the Data Monitor. + + + +**Return type**: int + + +### Function getY + +![][public] + +``` +int ModelCenter::IDataMonitor::getY() +``` + + + +Gets the Y position of the Data Monitor. + + + + + + +**Returns**: + +The value of the Y position of the Data Monitor. + + + +**Return type**: int + + +### Function setLocation + +![][public] + +``` +void ModelCenter::IDataMonitor::setLocation(int x, int y) +``` + + + +Sets the x and y location of the Data Monitor in the Analysis View. + + + + + + +**Parameters**: + +* **x**: The new x position. +* **y**: The new y position. + + + +**Parameters**: + +* int **x** +* int **y** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IDoubleArray.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IDoubleArray.md index 59ce7f2990..5c0fe80919 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IDoubleArray.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IDoubleArray.md @@ -1,1654 +1,1653 @@ - -# Interface ModelCenter::IDoubleArray - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1714) - - - -An array of double (real) values.
- -**Inherits from**: - -* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) - -## Members - -* [autoSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aca63a47369d69cbbf53532286b64a611) -* [clearLowerBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab93c1d5caa0fb18eb4d41499f5c708b7) -* [clearUpperBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa1657e3679484a86e997a20256eef5b1) -* [dependentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a0201276e7d000c4869e4798cfdb68d8b) -* [dependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a6e0601946499c985be03e00354c8acb3) -* [description](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a59b6ea0f39cadd0ec7b20b16c8d630ea) -* [directDependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe14e74990edda2c656035bbcd8e2af2) -* [directPrecedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3ab4fe76950c76fbdd2e76ea3f4fb08b) -* [enumAliases](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a9e195b698057e2d38fbb9c101ebeb827) -* [enumValues](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1af625775f6fdd957bb0b37ed1c86a3051) -* [format](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad0078a54f0aa1ede8e3d6d78a00a4f7c) -* [fromFormattedStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a21c8a18bd7cb6544d526fbe1c27e72ea) -* [fromString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3faefed33c99ee3ffb10b5e0e21d239a) -* [fromStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad068bdf2a8fb66fea7cfb3a3111fb176) -* [getArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afbdd49bff040a71b2be64a93e6705b21) -* [getDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a83abe70ccf5e8a0a582748d84e3d7956) -* [getFullName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a225331135b6efad1b05c399869975962) -* [getLength](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab0632e518febc3b1549fc35d932fd451) -* [getMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a1a41489453d177315ae18ef464e8907b) -* [getName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe2789906f30f6a082e5d3d79e2b5bbc) -* [getSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a3d171136e0b219dd4e2d0d1b4bb9aa1f) -* [getType](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a59535b93acdadae5c47ebb3f148cc8a7) -* [getValue](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a2e4c0ae7dbfe8869f56ad932ba0b22db) -* [getValueAbsolute](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a2d9a833f72d05827c32edda52d0584f3) -* [hasChanged](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a91e412d2c7f4955e11e24099601fab8f) -* [hasLowerBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a4a319eba200eb23b04f76abf8780c1cd) -* [hasUpperBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a1460ab1d3ab8aeef7679c93c07fc8138) -* [hide](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a009c7abd22ec22abd5367db1a29305ff) -* [invalidate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a032e132c6c6a61f81370942921ab2edf) -* [isInput](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa0a3e17384092dbeb0cef004db873191) -* [isInputToComponent](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a86e51010b5f7765c036af36bd9452622) -* [isInputToModel](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a78d5b37b715d259e29e0de79fa58508d) -* [isValid](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a4d7719052c0b341f91436d3a0da270cc) -* [length](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af118bdf4b120050d6700a7ceae7f5bec) -* [lowerBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a396e13c98a7680bc75354b6bf6b0487a) -* [numDimensions](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a8bf3f208059aad7bc8a73fd4e6529053) -* [OwningComponent](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa2e8150c160c33946dd92d8887b57d1f) -* [precedentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a640715d1e272c8f15d8cc4c2b466d990) -* [precedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a5973cfc6b1e41db214568a7e95979eef) -* [setArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad252c204a64ece94a946dcdd22e569df) -* [setDimensions](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a397d1abf4ecf0a106e84112b5634efac) -* [setLength](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a5e70599413156ef04aa8ddfd03958320) -* [setMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a56d1d2b85ec3b4c43589c25887c1dd95) -* [setSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b7b41ca5463a86aecb2368d73464c0e) -* [setValue](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1acbaaac83aab3ce3951ed1be15ad3f6ca) -* [size](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aeb3ca2a904ddc619edad7828c6c4492f) -* [toFormattedStringAbsoluteEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ac4c96b591adc0b61b3db5eaa90c3b3cd) -* [toFormattedStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aac1d778fd393456a7097eb9f6ac40daa) -* [toString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1af417ef0e71fabce8379be30e4d176355) -* [toStringAbsolute](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1adbd82fbad4622d8c2d91533d536a7ea0) -* [toStringAbsoluteEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab1252981582cec6fd3662321c9c4ce28) -* [toStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ac16f0cbbb0d4c51cb5cc7dfc0c251f88) -* [units](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ae91fd63ce08d3af74fb22132b5626432) -* [upperBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad4a4c720baa19775898e45381b881fcd) -* [validate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1abc755512c485531a61f10d2bc5d691b0) -* [value](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab6fd11161c6f26426d3205c88025a962) -* [value](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aceacfa8c1f90207042abb68d4175679d) - -## Properties - - -### Property hasChanged - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IDoubleArray::hasChanged -``` - - - - - - - -**Return type**: boolean - - -### Property hide - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IDoubleArray::hide -``` - - - - - - - -**Return type**: boolean - - -### Property OwningComponent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IDoubleArray::OwningComponent -``` - - - - - - - -**Return type**: LPDISPATCH - - -### Property size - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IDoubleArray::size -``` - - - - - - - -**Return type**: long - - -### Property numDimensions - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IDoubleArray::numDimensions -``` - - - - - - - -**Return type**: long - - -### Property lowerBound - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -double ModelCenter::IDoubleArray::lowerBound -``` - - - -Lower bound of the array. - - - -**Return type**: double - - -### Property upperBound - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -double ModelCenter::IDoubleArray::upperBound -``` - - - -Upper bound of the array. - - - -**Return type**: double - - -### Property description - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IDoubleArray::description -``` - - - -Description of the array. - - - -**Return type**: BSTR - - -### Property units - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IDoubleArray::units -``` - - - -Units of the array. - - - -**Return type**: BSTR - - -### Property enumAliases - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IDoubleArray::enumAliases -``` - - - -Enumerated aliases of the array. - - - -**Return type**: BSTR - - -### Property enumValues - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IDoubleArray::enumValues -``` - - - -Enumerated values of the array. - - - -**Return type**: BSTR - - -### Property format - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IDoubleArray::format -``` - - - -Format of the variable. - - - -**Return type**: BSTR - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1822) - -``` -VARIANT ModelCenter::IDoubleArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9) -``` - - - -Get the value of an array element. - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index) -* **d2**: Index in the 2nd dimension (0-based index) -* **d3**: Index in the 3rd dimension (0-based index) -* **d4**: Index in the 4th dimension (0-based index) -* **d5**: Index in the 5th dimension (0-based index) -* **d6**: Index in the 6th dimension (0-based index) -* **d7**: Index in the 7th dimension (0-based index) -* **d8**: Index in the 8th dimension (0-based index) -* **d9**: Index in the 9th dimension (0-based index) -* **d10**: Index in the 10th dimension (0-based index) - - -**Returns**: - -The value. - - - -**Return type**: VARIANT - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1838) - -``` -double ModelCenter::IDoubleArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9,[optional] VARIANT d10) -``` - - - -Set the value of an array element. You must set the array size first. - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index) -* **d2**: Index in the 2nd dimension (0-based index) -* **d3**: Index in the 3rd dimension (0-based index) -* **d4**: Index in the 4th dimension (0-based index) -* **d5**: Index in the 5th dimension (0-based index) -* **d6**: Index in the 6th dimension (0-based index) -* **d7**: Index in the 7th dimension (0-based index) -* **d8**: Index in the 8th dimension (0-based index) -* **d9**: Index in the 9th dimension (0-based index) -* **d10**: Index in the 10th dimension (0-based index) -* **newValue**: New value. - - - -**Return type**: double - -## Public functions - - -### Function isValid - -![][public] - -``` -boolean ModelCenter::IDoubleArray::isValid() -``` - - - -Finds out whether or not the array is valid. - - - - - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Return type**: boolean - -**Reimplements**: [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) - - -### Function validate - -![][public] - -``` -void ModelCenter::IDoubleArray::validate() -``` - - - -Causes the array to validate itself. - - - -**Return type**: void - -**Reimplements**: [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IDoubleArray::getName() -``` - - - -Gets the name of the array. - - - - - - -**Returns**: - -The name of the array. - - - -**Return type**: BSTR - -**Reimplements**: [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IDoubleArray::getFullName() -``` - - - -Gets the full ModelCenter path of the array. - - - - - - -**Returns**: - -The full ModelCenter path of the array. - - - -**Return type**: BSTR - -**Reimplements**: [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IDoubleArray::getType() -``` - - - -Gets the type of the array. - - - - - - -**Returns**: - -The type of the array as a string. - - - -**Return type**: BSTR - -**Reimplements**: [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) - - -### Function isInput - -![][public] - -``` -boolean ModelCenter::IDoubleArray::isInput() -``` - - - -Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a78d5b37b715d259e29e0de79fa58508d). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) - - -### Function toString - -![][public] - -``` -BSTR ModelCenter::IDoubleArray::toString() -``` - - - -Converts the array to a string, validating the array if necessary. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. - - - - - - -**Returns**: - -The converted string value of the array. - - - -**Return type**: BSTR - -**Reimplements**: [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) - - -### Function fromString - -![][public] - -``` -void ModelCenter::IDoubleArray::fromString(BSTR value) -``` - - - -Sets the value of the array from a specified string. For 1D arrays, the specification is of the form '1,2,3'.
-For nD arrays, the specification is of the form 'bounds[2,2,2] {1,2,3,4,5,6,7,8}'.
-String arrays may optionally have the elements quoted in the form 'bounds[2,3] {"a", "b,c", "d", "", "e", "f"}' - - - - - - -**Parameters**: - -* **value**: New value. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - -**Reimplements**: [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) - - -### Function toStringAbsolute - -![][public] - -``` -BSTR ModelCenter::IDoubleArray::toStringAbsolute() -``` - - - -Converts the array to a string. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. - - - - - - -**Returns**: - -The converted string value of the array. - - - -**Return type**: BSTR - -**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IDoubleArray::invalidate() -``` - - - -Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. - - - -**Return type**: void - -**Reimplements**: [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) - - -### Function directPrecedents - -![][public] - -``` -LPDISPATCH ModelCenter::IDoubleArray::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) - - -### Function directDependents - -![][public] - -``` -LPDISPATCH ModelCenter::IDoubleArray::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) - - -### Function precedentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IDoubleArray::precedentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) - - -### Function dependentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IDoubleArray::dependentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) - - -### Function precedents - -![][public] - -``` -LPDISPATCH ModelCenter::IDoubleArray::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) - - -### Function dependents - -![][public] - -``` -LPDISPATCH ModelCenter::IDoubleArray::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) - - -### Function isInputToComponent - -![][public] - -``` -boolean ModelCenter::IDoubleArray::isInputToComponent() -``` - - - -Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) - - -### Function isInputToModel - -![][public] - -``` -boolean ModelCenter::IDoubleArray::isInputToModel() -``` - - - -Checks whether or not the variable is an input. A linked input returns false (Output). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) - - -### Function setMetadata - -![][public] - -``` -void ModelCenter::IDoubleArray::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) -``` - - - -Sets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata specifier used to store the data. -* **type**:
-* **value**:
-* **access**:
-* **archive**:
- - - -**Parameters**: - -* BSTR **name** -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** -* VARIANT **value** -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** -* boolean **archive** - -**Return type**: void - -**Reimplements**: [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) - - -### Function getMetadata - -![][public] - -``` -VARIANT ModelCenter::IDoubleArray::getMetadata(BSTR name) -``` - - - -Gets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata key name. - - -**Returns**: - -Metadata value. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -**Reimplements**: [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) - - -### Function toStringEx - -![][public] - -``` -BSTR ModelCenter::IDoubleArray::toStringEx(long index) -``` - - - -Converts the value of an array element to a string, validating the array if necessary. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The value of the element as a string. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - -**Reimplements**: [toStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a37c622ae9f50579f714ce98c0379cd98) - - -### Function fromStringEx - -![][public] - -``` -void ModelCenter::IDoubleArray::fromStringEx(BSTR value, long index) -``` - - - -Sets the value of an array element from a specified string. - - - - - - -**Parameters**: - -* **value**: New value. -* **index**: Index of the array element (0-based index). - - - -**Parameters**: - -* BSTR **value** -* long **index** - -**Return type**: void - -**Reimplements**: [fromStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad23f4082662c464be07251d6d1695a2d) - - -### Function toStringAbsoluteEx - -![][public] - -``` -BSTR ModelCenter::IDoubleArray::toStringAbsoluteEx(long index) -``` - - - -Converts the value of an array element to a string. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The value of the element as a string. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - -**Reimplements**: [toStringAbsoluteEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a2e3041440581aab716c684fe88d2ee87) - - -### Function getLength - -![][public] - -``` -long ModelCenter::IDoubleArray::getLength([optional] VARIANT dim) -``` - - - -Get the length of the n'th dimension of the array. - - - - - - -**Parameters**: - -* **dim**: Dimension of the array to query. This uses a 0 based index, so 0 will give you the first dimension, 1 the second, etc. If omitted, gives the first dimension - - -**Returns**: - -Length(size) of the array. - - - -**Parameters**: - -* _[optional]_ VARIANT **dim** - -**Return type**: long - -**Reimplements**: [getLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) - - -### Function setLength - -![][public] - -``` -void ModelCenter::IDoubleArray::setLength(long length, [optional] VARIANT dim) -``` - - - -Sets the length of the n'th dimension of the array - - - - - - -**Parameters**: - -* **length**: New length of the n'th dimension of the array -* **dim**: The dimension to set. This uses a 0 based index, so 0 will set the first dimension, 1 the second, etc. If omitted, sets the first dimension - - - -**Parameters**: - -* long **length** -* _[optional]_ VARIANT **dim** - -**Return type**: void - -**Reimplements**: [setLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) - - -### Function setDimensions - -![][public] - -``` -void ModelCenter::IDoubleArray::setDimensions(long d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Sets the number of dimensions of an array and the length of each dimension in one call. An array initializes to 0 length. If any dimension of the array has 0 length, the whole array contains no data. You must set the array size before filling in values unless you are using the [setArray()](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad252c204a64ece94a946dcdd22e569df) call. - - - - - - -**Parameters**: - -* **d1**: length of the 1st dimension of the array -* **d2**: length of the 2nd dimension of the array. If omitted, the array is 1 dimensional -* **d3**: length of the 3rd dimension of the array. If omitted, the array is 2 dimensional -* **d4**: length of the 4th dimension of the array. If omitted, the array is 3 dimensional -* **d5**: length of the 5th dimension of the array. If omitted, the array is 4 dimensional -* **d6**: length of the 6th dimension of the array. If omitted, the array is 5 dimensional -* **d7**: length of the 7th dimension of the array. If omitted, the array is 6 dimensional -* **d8**: length of the 8th dimension of the array. If omitted, the array is 7 dimensional -* **d9**: length of the 9th dimension of the array. If omitted, the array is 8 dimensional -* **d10**: length of the 10th dimension of the array. If omitted, the array is 9 dimensional - - - -**Parameters**: - -* long **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: void - -**Reimplements**: [setDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) - - -### Function hasLowerBound - -![][public] - -``` -boolean ModelCenter::IDoubleArray::hasLowerBound() -``` - - - -Finds out whether or not the array has a lower bound. - - - - - - -**Returns**: - -Yes (TRUE) or no (FALSE). - - - -**Return type**: boolean - - -### Function hasUpperBound - -![][public] - -``` -boolean ModelCenter::IDoubleArray::hasUpperBound() -``` - - - -Finds out whether or not the array has an upper bound. - - - - - - -**Returns**: - -Yes (TRUE) or no (FALSE). - - - -**Return type**: boolean - - -### Function getValue - -![][public] - -``` -double ModelCenter::IDoubleArray::getValue(VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Gets the value of an array element. - - - - - - -**Parameters**: - -* **d1**: index in the 1st dimension (0-based index) -* **d2**: index in the 2nd dimension (0-based index) -* **d3**: index in the 3rd dimension (0-based index) -* **d4**: index in the 4th dimension (0-based index) -* **d5**: index in the 5th dimension (0-based index) -* **d6**: index in the 6th dimension (0-based index) -* **d7**: index in the 7th dimension (0-based index) -* **d8**: index in the 8th dimension (0-based index) -* **d9**: index in the 9th dimension (0-based index) -* **d10**: index in the 10th dimension (0-based index) - - -**Returns**: - -The value. - - - -**Parameters**: - -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: double - - -### Function setValue - -![][public] - -``` -void ModelCenter::IDoubleArray::setValue(double value, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Sets the value of an array element. You must set the array size first. - - - - - - -**Parameters**: - -* **value**: New value. -* **d1**: position in the 1st dimension of the array (or full index string) (0-based index) -* **d2**: position in the 2nd dimension of the array (0-based index) -* **d3**: position in the 3rd dimension of the array (0-based index) -* **d4**: position in the 4th dimension of the array (0-based index) -* **d5**: position in the 5th dimension of the array (0-based index) -* **d6**: position in the 6th dimension of the array (0-based index) -* **d7**: position in the 7th dimension of the array (0-based index) -* **d8**: position in the 8th dimension of the array (0-based index) -* **d9**: position in the 9th dimension of the array (0-based index) -* **d10**: position in the 10th dimension of the array (0-based index) - - - -**Parameters**: - -* double **value** -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: void - - -### Function getArray - -![][public] - -``` -VARIANT ModelCenter::IDoubleArray::getArray() -``` - - - -Gets the whole array as a single primitive array object in the language's native array format. This is typically faster than calling individual array elements. - - - - - - -**Returns**: - -The primitive array - - - -**Return type**: VARIANT - - -### Function setArray - -![][public] - -``` -void ModelCenter::IDoubleArray::setArray(VARIANT array) -``` - - - -Sets the whole array at once using a single primitive array object in the language's native array format. This is typically faster than calling individual array elements. The array will take on the size and dimensions of the passed in array. - - - - - - -**Parameters**: - -* **array**: The primitive source array - - - -**Parameters**: - -* VARIANT **array** - -**Return type**: void - - -### Function toFormattedStringEx - -![][public] - -``` -BSTR ModelCenter::IDoubleArray::toFormattedStringEx(long index) -``` - - - -Converts the value to a formatted string. - - - - - - -**Parameters**: - -* **index**: Position in the array (0-based index). - - -**Returns**: - -Formatted string. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - - -### Function fromFormattedStringEx - -![][public] - -``` -void ModelCenter::IDoubleArray::fromFormattedStringEx(BSTR value, long index) -``` - - - -Loads a formatted string. - - - - - - -**Parameters**: - -* **value**: Formatted value to load. -* **index**: Position in the array (0-based index). - - - -**Parameters**: - -* BSTR **value** -* long **index** - -**Return type**: void - - -### Function toFormattedStringAbsoluteEx - -![][public] - -``` -BSTR ModelCenter::IDoubleArray::toFormattedStringAbsoluteEx(long index) -``` - - - -Converts the value to an absolute formatted string. - - - - - - -**Parameters**: - -* **index**: Position in the array (0-based index). - - -**Returns**: - -An absolute formatted string. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - - -### Function clearUpperBound - -![][public] - -``` -void ModelCenter::IDoubleArray::clearUpperBound() -``` - - - -Clears the upper bound property of the array if it has previously been set. - - - -**Return type**: void - - -### Function clearLowerBound - -![][public] - -``` -void ModelCenter::IDoubleArray::clearLowerBound() -``` - - - -Clears the lower bound property of the array if it has previously been set. - - - -**Return type**: void - - -### Function getValueAbsolute - -![][public] - -``` -double ModelCenter::IDoubleArray::getValueAbsolute(VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Gets the value of an array element without validating. - - - - - - -**Parameters**: - -* **d1**: index in the 1st dimension (0-based index) -* **d2**: index in the 2nd dimension (0-based index) -* **d3**: index in the 3rd dimension (0-based index) -* **d4**: index in the 4th dimension (0-based index) -* **d5**: index in the 5th dimension (0-based index) -* **d6**: index in the 6th dimension (0-based index) -* **d7**: index in the 7th dimension (0-based index) -* **d8**: index in the 8th dimension (0-based index) -* **d9**: index in the 9th dimension (0-based index) -* **d10**: index in the 10th dimension (0-based index) - - -**Returns**: - -The value. - - - -**Parameters**: - -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: double - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IDoubleArray + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1714) + + + +An array of double (real) values.
+ +**Inherits from**: + +* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) + +## Members + +* [autoSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aca63a47369d69cbbf53532286b64a611) +* [clearLowerBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab93c1d5caa0fb18eb4d41499f5c708b7) +* [clearUpperBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa1657e3679484a86e997a20256eef5b1) +* [dependentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a0201276e7d000c4869e4798cfdb68d8b) +* [dependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a6e0601946499c985be03e00354c8acb3) +* [description](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a59b6ea0f39cadd0ec7b20b16c8d630ea) +* [directDependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe14e74990edda2c656035bbcd8e2af2) +* [directPrecedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3ab4fe76950c76fbdd2e76ea3f4fb08b) +* [enumAliases](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a9e195b698057e2d38fbb9c101ebeb827) +* [enumValues](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1af625775f6fdd957bb0b37ed1c86a3051) +* [format](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad0078a54f0aa1ede8e3d6d78a00a4f7c) +* [fromFormattedStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a21c8a18bd7cb6544d526fbe1c27e72ea) +* [fromString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3faefed33c99ee3ffb10b5e0e21d239a) +* [fromStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad068bdf2a8fb66fea7cfb3a3111fb176) +* [getArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afbdd49bff040a71b2be64a93e6705b21) +* [getDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a83abe70ccf5e8a0a582748d84e3d7956) +* [getFullName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a225331135b6efad1b05c399869975962) +* [getLength](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab0632e518febc3b1549fc35d932fd451) +* [getMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a1a41489453d177315ae18ef464e8907b) +* [getName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe2789906f30f6a082e5d3d79e2b5bbc) +* [getSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a3d171136e0b219dd4e2d0d1b4bb9aa1f) +* [getType](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a59535b93acdadae5c47ebb3f148cc8a7) +* [getValue](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a2e4c0ae7dbfe8869f56ad932ba0b22db) +* [getValueAbsolute](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a2d9a833f72d05827c32edda52d0584f3) +* [hasChanged](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a91e412d2c7f4955e11e24099601fab8f) +* [hasLowerBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a4a319eba200eb23b04f76abf8780c1cd) +* [hasUpperBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a1460ab1d3ab8aeef7679c93c07fc8138) +* [hide](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a009c7abd22ec22abd5367db1a29305ff) +* [invalidate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a032e132c6c6a61f81370942921ab2edf) +* [isInput](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa0a3e17384092dbeb0cef004db873191) +* [isInputToComponent](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a86e51010b5f7765c036af36bd9452622) +* [isInputToModel](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a78d5b37b715d259e29e0de79fa58508d) +* [isValid](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a4d7719052c0b341f91436d3a0da270cc) +* [length](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af118bdf4b120050d6700a7ceae7f5bec) +* [lowerBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a396e13c98a7680bc75354b6bf6b0487a) +* [numDimensions](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a8bf3f208059aad7bc8a73fd4e6529053) +* [OwningComponent](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa2e8150c160c33946dd92d8887b57d1f) +* [precedentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a640715d1e272c8f15d8cc4c2b466d990) +* [precedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a5973cfc6b1e41db214568a7e95979eef) +* [setArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad252c204a64ece94a946dcdd22e569df) +* [setDimensions](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a397d1abf4ecf0a106e84112b5634efac) +* [setLength](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a5e70599413156ef04aa8ddfd03958320) +* [setMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a56d1d2b85ec3b4c43589c25887c1dd95) +* [setSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b7b41ca5463a86aecb2368d73464c0e) +* [setValue](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1acbaaac83aab3ce3951ed1be15ad3f6ca) +* [size](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aeb3ca2a904ddc619edad7828c6c4492f) +* [toFormattedStringAbsoluteEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ac4c96b591adc0b61b3db5eaa90c3b3cd) +* [toFormattedStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aac1d778fd393456a7097eb9f6ac40daa) +* [toString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1af417ef0e71fabce8379be30e4d176355) +* [toStringAbsolute](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1adbd82fbad4622d8c2d91533d536a7ea0) +* [toStringAbsoluteEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab1252981582cec6fd3662321c9c4ce28) +* [toStringEx](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ac16f0cbbb0d4c51cb5cc7dfc0c251f88) +* [units](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ae91fd63ce08d3af74fb22132b5626432) +* [upperBound](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad4a4c720baa19775898e45381b881fcd) +* [validate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1abc755512c485531a61f10d2bc5d691b0) +* [value](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ab6fd11161c6f26426d3205c88025a962) +* [value](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aceacfa8c1f90207042abb68d4175679d) + +## Properties + + +### Property hasChanged + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IDoubleArray::hasChanged +``` + + + + + + + +**Return type**: boolean + + +### Property hide + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IDoubleArray::hide +``` + + + + + + + +**Return type**: boolean + + +### Property OwningComponent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IDoubleArray::OwningComponent +``` + + + + + + + +**Return type**: LPDISPATCH + + +### Property size + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IDoubleArray::size +``` + + + + + + + +**Return type**: long + + +### Property numDimensions + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IDoubleArray::numDimensions +``` + + + + + + + +**Return type**: long + + +### Property lowerBound + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +double ModelCenter::IDoubleArray::lowerBound +``` + + + +Lower bound of the array. + + + +**Return type**: double + + +### Property upperBound + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +double ModelCenter::IDoubleArray::upperBound +``` + + + +Upper bound of the array. + + + +**Return type**: double + + +### Property description + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IDoubleArray::description +``` + + + +Description of the array. + + + +**Return type**: BSTR + + +### Property units + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IDoubleArray::units +``` + + + +Units of the array. + + + +**Return type**: BSTR + + +### Property enumAliases + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IDoubleArray::enumAliases +``` + + + +Enumerated aliases of the array. + + + +**Return type**: BSTR + + +### Property enumValues + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IDoubleArray::enumValues +``` + + + +Enumerated values of the array. + + + +**Return type**: BSTR + + +### Property format + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IDoubleArray::format +``` + + + +Format of the variable. + + + +**Return type**: BSTR + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1822) + +``` +VARIANT ModelCenter::IDoubleArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9) +``` + + + +Get the value of an array element. + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index) +* **d2**: Index in the 2nd dimension (0-based index) +* **d3**: Index in the 3rd dimension (0-based index) +* **d4**: Index in the 4th dimension (0-based index) +* **d5**: Index in the 5th dimension (0-based index) +* **d6**: Index in the 6th dimension (0-based index) +* **d7**: Index in the 7th dimension (0-based index) +* **d8**: Index in the 8th dimension (0-based index) +* **d9**: Index in the 9th dimension (0-based index) +* **d10**: Index in the 10th dimension (0-based index) + + +**Returns**: + +The value. + + + +**Return type**: VARIANT + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1838) + +``` +double ModelCenter::IDoubleArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9,[optional] VARIANT d10) +``` + + + +Set the value of an array element. You must set the array size first. + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index) +* **d2**: Index in the 2nd dimension (0-based index) +* **d3**: Index in the 3rd dimension (0-based index) +* **d4**: Index in the 4th dimension (0-based index) +* **d5**: Index in the 5th dimension (0-based index) +* **d6**: Index in the 6th dimension (0-based index) +* **d7**: Index in the 7th dimension (0-based index) +* **d8**: Index in the 8th dimension (0-based index) +* **d9**: Index in the 9th dimension (0-based index) +* **d10**: Index in the 10th dimension (0-based index) +* **newValue**: New value. + + + +**Return type**: double + +## Public functions + + +### Function isValid + +![][public] + +``` +boolean ModelCenter::IDoubleArray::isValid() +``` + + + +Finds out whether or not the array is valid. + + + + + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Return type**: boolean + +**Reimplements**: [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) + + +### Function validate + +![][public] + +``` +void ModelCenter::IDoubleArray::validate() +``` + + + +Causes the array to validate itself. + + + +**Return type**: void + +**Reimplements**: [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IDoubleArray::getName() +``` + + + +Gets the name of the array. + + + + + + +**Returns**: + +The name of the array. + + + +**Return type**: BSTR + +**Reimplements**: [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IDoubleArray::getFullName() +``` + + + +Gets the full ModelCenter path of the array. + + + + + + +**Returns**: + +The full ModelCenter path of the array. + + + +**Return type**: BSTR + +**Reimplements**: [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IDoubleArray::getType() +``` + + + +Gets the type of the array. + + + + + + +**Returns**: + +The type of the array as a string. + + + +**Return type**: BSTR + +**Reimplements**: [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) + + +### Function isInput + +![][public] + +``` +boolean ModelCenter::IDoubleArray::isInput() +``` + + + +Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a78d5b37b715d259e29e0de79fa58508d). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) + + +### Function toString + +![][public] + +``` +BSTR ModelCenter::IDoubleArray::toString() +``` + + + +Converts the array to a string, validating the array if necessary. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. + + + + + + +**Returns**: + +The converted string value of the array. + + + +**Return type**: BSTR + +**Reimplements**: [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) + + +### Function fromString + +![][public] + +``` +void ModelCenter::IDoubleArray::fromString(BSTR value) +``` + + + +Sets the value of the array from a specified string. For 1D arrays, the specification is of the form '1,2,3'.
+For nD arrays, the specification is of the form 'bounds[2,2,2] {1,2,3,4,5,6,7,8}'.
+String arrays may optionally have the elements quoted in the form 'bounds[2,3] {"a", "b,c", "d", "", "e", "f"}' + + + + + + +**Parameters**: + +* **value**: New value. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + +**Reimplements**: [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) + + +### Function toStringAbsolute + +![][public] + +``` +BSTR ModelCenter::IDoubleArray::toStringAbsolute() +``` + + + +Converts the array to a string. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. + + + + + + +**Returns**: + +The converted string value of the array. + + + +**Return type**: BSTR + +**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IDoubleArray::invalidate() +``` + + + +Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. + + + +**Return type**: void + +**Reimplements**: [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) + + +### Function directPrecedents + +![][public] + +``` +LPDISPATCH ModelCenter::IDoubleArray::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) + + +### Function directDependents + +![][public] + +``` +LPDISPATCH ModelCenter::IDoubleArray::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) + + +### Function precedentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IDoubleArray::precedentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) + + +### Function dependentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IDoubleArray::dependentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) + + +### Function precedents + +![][public] + +``` +LPDISPATCH ModelCenter::IDoubleArray::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) + + +### Function dependents + +![][public] + +``` +LPDISPATCH ModelCenter::IDoubleArray::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) + + +### Function isInputToComponent + +![][public] + +``` +boolean ModelCenter::IDoubleArray::isInputToComponent() +``` + + + +Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) + + +### Function isInputToModel + +![][public] + +``` +boolean ModelCenter::IDoubleArray::isInputToModel() +``` + + + +Checks whether or not the variable is an input. A linked input returns false (Output). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) + + +### Function setMetadata + +![][public] + +``` +void ModelCenter::IDoubleArray::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) +``` + + + +Sets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata specifier used to store the data. +* **type**:
+* **value**:
+* **access**:
+* **archive**:
+ + + +**Parameters**: + +* BSTR **name** +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** +* VARIANT **value** +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** +* boolean **archive** + +**Return type**: void + +**Reimplements**: [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) + + +### Function getMetadata + +![][public] + +``` +VARIANT ModelCenter::IDoubleArray::getMetadata(BSTR name) +``` + + + +Gets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata key name. + + +**Returns**: + +Metadata value. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +**Reimplements**: [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) + + +### Function toStringEx + +![][public] + +``` +BSTR ModelCenter::IDoubleArray::toStringEx(long index) +``` + + + +Converts the value of an array element to a string, validating the array if necessary. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The value of the element as a string. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + +**Reimplements**: [toStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a37c622ae9f50579f714ce98c0379cd98) + + +### Function fromStringEx + +![][public] + +``` +void ModelCenter::IDoubleArray::fromStringEx(BSTR value, long index) +``` + + + +Sets the value of an array element from a specified string. + + + + + + +**Parameters**: + +* **value**: New value. +* **index**: Index of the array element (0-based index). + + + +**Parameters**: + +* BSTR **value** +* long **index** + +**Return type**: void + +**Reimplements**: [fromStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad23f4082662c464be07251d6d1695a2d) + + +### Function toStringAbsoluteEx + +![][public] + +``` +BSTR ModelCenter::IDoubleArray::toStringAbsoluteEx(long index) +``` + + + +Converts the value of an array element to a string. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The value of the element as a string. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + +**Reimplements**: [toStringAbsoluteEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a2e3041440581aab716c684fe88d2ee87) + + +### Function getLength + +![][public] + +``` +long ModelCenter::IDoubleArray::getLength([optional] VARIANT dim) +``` + + + +Get the length of the n'th dimension of the array. + + + + + + +**Parameters**: + +* **dim**: Dimension of the array to query. This uses a 0 based index, so 0 will give you the first dimension, 1 the second, etc. If omitted, gives the first dimension + + +**Returns**: + +Length(size) of the array. + + + +**Parameters**: + +* _[optional]_ VARIANT **dim** + +**Return type**: long + +**Reimplements**: [getLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) + + +### Function setLength + +![][public] + +``` +void ModelCenter::IDoubleArray::setLength(long length, [optional] VARIANT dim) +``` + + + +Sets the length of the n'th dimension of the array + + + + + + +**Parameters**: + +* **length**: New length of the n'th dimension of the array +* **dim**: The dimension to set. This uses a 0 based index, so 0 will set the first dimension, 1 the second, etc. If omitted, sets the first dimension + + + +**Parameters**: + +* long **length** +* _[optional]_ VARIANT **dim** + +**Return type**: void + +**Reimplements**: [setLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) + + +### Function setDimensions + +![][public] + +``` +void ModelCenter::IDoubleArray::setDimensions(long d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Sets the number of dimensions of an array and the length of each dimension in one call. An array initializes to 0 length. If any dimension of the array has 0 length, the whole array contains no data. You must set the array size before filling in values unless you are using the [setArray()](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1ad252c204a64ece94a946dcdd22e569df) call. + + + + + + +**Parameters**: + +* **d1**: length of the 1st dimension of the array +* **d2**: length of the 2nd dimension of the array. If omitted, the array is 1 dimensional +* **d3**: length of the 3rd dimension of the array. If omitted, the array is 2 dimensional +* **d4**: length of the 4th dimension of the array. If omitted, the array is 3 dimensional +* **d5**: length of the 5th dimension of the array. If omitted, the array is 4 dimensional +* **d6**: length of the 6th dimension of the array. If omitted, the array is 5 dimensional +* **d7**: length of the 7th dimension of the array. If omitted, the array is 6 dimensional +* **d8**: length of the 8th dimension of the array. If omitted, the array is 7 dimensional +* **d9**: length of the 9th dimension of the array. If omitted, the array is 8 dimensional +* **d10**: length of the 10th dimension of the array. If omitted, the array is 9 dimensional + + + +**Parameters**: + +* long **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: void + +**Reimplements**: [setDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) + + +### Function hasLowerBound + +![][public] + +``` +boolean ModelCenter::IDoubleArray::hasLowerBound() +``` + + + +Finds out whether or not the array has a lower bound. + + + + + + +**Returns**: + +Yes (TRUE) or no (FALSE). + + + +**Return type**: boolean + + +### Function hasUpperBound + +![][public] + +``` +boolean ModelCenter::IDoubleArray::hasUpperBound() +``` + + + +Finds out whether or not the array has an upper bound. + + + + + + +**Returns**: + +Yes (TRUE) or no (FALSE). + + + +**Return type**: boolean + + +### Function getValue + +![][public] + +``` +double ModelCenter::IDoubleArray::getValue(VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Gets the value of an array element. + + + + + + +**Parameters**: + +* **d1**: index in the 1st dimension (0-based index) +* **d2**: index in the 2nd dimension (0-based index) +* **d3**: index in the 3rd dimension (0-based index) +* **d4**: index in the 4th dimension (0-based index) +* **d5**: index in the 5th dimension (0-based index) +* **d6**: index in the 6th dimension (0-based index) +* **d7**: index in the 7th dimension (0-based index) +* **d8**: index in the 8th dimension (0-based index) +* **d9**: index in the 9th dimension (0-based index) +* **d10**: index in the 10th dimension (0-based index) + + +**Returns**: + +The value. + + + +**Parameters**: + +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: double + + +### Function setValue + +![][public] + +``` +void ModelCenter::IDoubleArray::setValue(double value, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Sets the value of an array element. You must set the array size first. + + + + + + +**Parameters**: + +* **value**: New value. +* **d1**: position in the 1st dimension of the array (or full index string) (0-based index) +* **d2**: position in the 2nd dimension of the array (0-based index) +* **d3**: position in the 3rd dimension of the array (0-based index) +* **d4**: position in the 4th dimension of the array (0-based index) +* **d5**: position in the 5th dimension of the array (0-based index) +* **d6**: position in the 6th dimension of the array (0-based index) +* **d7**: position in the 7th dimension of the array (0-based index) +* **d8**: position in the 8th dimension of the array (0-based index) +* **d9**: position in the 9th dimension of the array (0-based index) +* **d10**: position in the 10th dimension of the array (0-based index) + + + +**Parameters**: + +* double **value** +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: void + + +### Function getArray + +![][public] + +``` +VARIANT ModelCenter::IDoubleArray::getArray() +``` + + + +Gets the whole array as a single primitive array object in the language's native array format. This is typically faster than calling individual array elements. + + + + + + +**Returns**: + +The primitive array + + + +**Return type**: VARIANT + + +### Function setArray + +![][public] + +``` +void ModelCenter::IDoubleArray::setArray(VARIANT array) +``` + + + +Sets the whole array at once using a single primitive array object in the language's native array format. This is typically faster than calling individual array elements. The array will take on the size and dimensions of the passed in array. + + + + + + +**Parameters**: + +* **array**: The primitive source array + + + +**Parameters**: + +* VARIANT **array** + +**Return type**: void + + +### Function toFormattedStringEx + +![][public] + +``` +BSTR ModelCenter::IDoubleArray::toFormattedStringEx(long index) +``` + + + +Converts the value to a formatted string. + + + + + + +**Parameters**: + +* **index**: Position in the array (0-based index). + + +**Returns**: + +Formatted string. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + + +### Function fromFormattedStringEx + +![][public] + +``` +void ModelCenter::IDoubleArray::fromFormattedStringEx(BSTR value, long index) +``` + + + +Loads a formatted string. + + + + + + +**Parameters**: + +* **value**: Formatted value to load. +* **index**: Position in the array (0-based index). + + + +**Parameters**: + +* BSTR **value** +* long **index** + +**Return type**: void + + +### Function toFormattedStringAbsoluteEx + +![][public] + +``` +BSTR ModelCenter::IDoubleArray::toFormattedStringAbsoluteEx(long index) +``` + + + +Converts the value to an absolute formatted string. + + + + + + +**Parameters**: + +* **index**: Position in the array (0-based index). + + +**Returns**: + +An absolute formatted string. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + + +### Function clearUpperBound + +![][public] + +``` +void ModelCenter::IDoubleArray::clearUpperBound() +``` + + + +Clears the upper bound property of the array if it has previously been set. + + + +**Return type**: void + + +### Function clearLowerBound + +![][public] + +``` +void ModelCenter::IDoubleArray::clearLowerBound() +``` + + + +Clears the lower bound property of the array if it has previously been set. + + + +**Return type**: void + + +### Function getValueAbsolute + +![][public] + +``` +double ModelCenter::IDoubleArray::getValueAbsolute(VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Gets the value of an array element without validating. + + + + + + +**Parameters**: + +* **d1**: index in the 1st dimension (0-based index) +* **d2**: index in the 2nd dimension (0-based index) +* **d3**: index in the 3rd dimension (0-based index) +* **d4**: index in the 4th dimension (0-based index) +* **d5**: index in the 5th dimension (0-based index) +* **d6**: index in the 6th dimension (0-based index) +* **d7**: index in the 7th dimension (0-based index) +* **d8**: index in the 8th dimension (0-based index) +* **d9**: index in the 9th dimension (0-based index) +* **d10**: index in the 10th dimension (0-based index) + + +**Returns**: + +The value. + + + +**Parameters**: + +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: double + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IDoubleVariable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IDoubleVariable.md index a730c7ea42..aeb08f05c8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IDoubleVariable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IDoubleVariable.md @@ -1,1124 +1,1123 @@ - -# Interface ModelCenter::IDoubleVariable - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1977) - - - -COM Instance - -**Inherits from**: - -* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) - -## Members - -* [clearLowerBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a72ee20ae45907f6f6738dbba0ea63655) -* [clearUpperBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1aa8846eb2c93d138bf7b6c31d78f0dc56) -* [dependentLinks](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a385019a97e3ddbae4351fd6dd591a49c) -* [dependents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a04becbe1d34e232e21208333c0700e3c) -* [description](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a491df2e849d05621978fe706bb48de85) -* [directDependents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a6178082dc3de5e1f6665f4faebcb8c36) -* [directPrecedents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a7a14b5ef10935109b178062205b91b7a) -* [enumAliases](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a531c146537c198a1c71e5c5826757b01) -* [enumValues](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a0c6cd245f4c6bacc15398f88522a2992) -* [format](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a6181c6c0985068e31fdb725d719ddb35) -* [fromFormattedString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac054c3628e2d617a1972dc195cacec60) -* [fromString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1128d6c344adde4e9f9d95b0c19f87b9) -* [getFullName](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a00a7eca52d31c8f86e049dc1896d2434) -* [getMetadata](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a40ecee96822db8b700fe1a814b2ab3b1) -* [getName](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a10978bbb428eadf01141d2ceb2373c7a) -* [getType](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a974708d2da959d48ee301088918719fd) -* [hasChanged](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a547bbc74c5db046b8d125cfbc3a6ab57) -* [hasLowerBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a18723d07a18cb720d07bebee26f35d2f) -* [hasUpperBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1aa78deb300d4f268523777fcabe898ce5) -* [hide](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac8bae6ed29215d02364f98a876f2ccfa) -* [invalidate](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a9abf6ea522bbff16d7c2266202b5bdae) -* [isInput](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a162bb6a2a0c8cf5a2f3ee15daaaf85c2) -* [isInputToComponent](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a18112e5a20ca1711e97f8a5514995a49) -* [isInputToModel](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a34bbd8b682a39cbe120f972f0be7b1cd) -* [isValid](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1b873587774671d25664c294323beae8) -* [lowerBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a8d74ea79cd0203c477fa96e2410ba176) -* [OwningComponent](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ad15c38a3b89a2fa2be6e2f6b88268fd2) -* [precedentLinks](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a8bf056e8b989223191b2e8c7595c0753) -* [precedents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac65d0d53de6aee17106700d60161e9cf) -* [setInitialValue](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a34b3939cccf3f8862301863629b63434) -* [setMetadata](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a499a962844cae63886b79779e39db700) -* [toFormattedString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1fb28d4b74c3d0121725f15773f7d1bb) -* [toFormattedStringAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac4e47bfae3990e33c748b44580244be3) -* [toString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a59f1d75b8e24323ea9bf523159f04f69) -* [toStringAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a89797e61eedee333bd67b55b653ec21f) -* [units](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ad5b4b178eafbe9ebf4e55b3f5e158622) -* [upperBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a7585c786507e272216ec790ce278fd10) -* [validate](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1abddc8770d26e37ac9319be5b90bc6e3e) -* [value](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1aa7a7d4145814425b6ea93e831854d84c) -* [valueAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a364aa148101fa8ea9ddc2d624f96fcf5) - -## Properties - - -### Property hasChanged - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IDoubleVariable::hasChanged -``` - - - - - - - -**Return type**: boolean - - -### Property hide - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IDoubleVariable::hide -``` - - - - - - - -**Return type**: boolean - - -### Property OwningComponent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IDoubleVariable::OwningComponent -``` - - - - - - - -**Return type**: LPDISPATCH - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -double ModelCenter::IDoubleVariable::value -``` - - - -Value of the variable. - - - -**Return type**: double - - -### Property valueAbsolute - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -double ModelCenter::IDoubleVariable::valueAbsolute -``` - - - -The value of the variable. (Fetched without attempting to validate) - - - -**Return type**: double - - -### Property lowerBound - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -double ModelCenter::IDoubleVariable::lowerBound -``` - - - -Lower bound of the variable. - - - -**Return type**: double - - -### Property upperBound - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -double ModelCenter::IDoubleVariable::upperBound -``` - - - -Upper bound of the variable. - - - -**Return type**: double - - -### Property units - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IDoubleVariable::units -``` - - - -Units of the variable. - - - -**Return type**: BSTR - - -### Property description - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IDoubleVariable::description -``` - - - -Description of the variable. - - - -**Return type**: BSTR - - -### Property enumValues - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IDoubleVariable::enumValues -``` - - - -Enumerated values of the variable. - - - -**Return type**: BSTR - - -### Property enumAliases - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IDoubleVariable::enumAliases -``` - - - -Enumerated aliases of the variable. - - - -**Return type**: BSTR - - -### Property format - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IDoubleVariable::format -``` - - - -Format of the variable. - - - -**Return type**: BSTR - -## Public functions - - -### Function isValid - -![][public] - -``` -boolean ModelCenter::IDoubleVariable::isValid() -``` - - - -Returns whether or not the variable is valid. - - - - - - -**Returns**: - -True if variable is valid. False if the variable is not valid. - - - -**Return type**: boolean - -**Reimplements**: [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) - - -### Function validate - -![][public] - -``` -void ModelCenter::IDoubleVariable::validate() -``` - - - -Validates the variable by running the component if needed. - - - -**Return type**: void - -**Reimplements**: [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IDoubleVariable::getName() -``` - - - -Gets the name of the variable. - - - - - - -**Returns**: - -The name of the variable. - - - -**Return type**: BSTR - -**Reimplements**: [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IDoubleVariable::getFullName() -``` - - - -Gets the full ModelCenter path of the variable. - - - - - - -**Returns**: - -The full ModelCenter path of the variable. - - - -**Return type**: BSTR - -**Reimplements**: [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IDoubleVariable::getType() -``` - - - -Gets the type of the variable. - - - - - - -**Returns**: - -The type of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) - - -### Function isInput - -![][public] - -``` -boolean ModelCenter::IDoubleVariable::isInput() -``` - - - -Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a34bbd8b682a39cbe120f972f0be7b1cd). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) - - -### Function toString - -![][public] - -``` -BSTR ModelCenter::IDoubleVariable::toString() -``` - - - -Converts the variable value to a string, validating the variable if necessary. - - - - - - -**Returns**: - -The value of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) - - -### Function fromString - -![][public] - -``` -void ModelCenter::IDoubleVariable::fromString(BSTR value) -``` - - - -Sets the value of the variable from the specified string. - - - - - - -**Parameters**: - -* **value**: New value. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - -**Reimplements**: [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) - - -### Function toStringAbsolute - -![][public] - -``` -BSTR ModelCenter::IDoubleVariable::toStringAbsolute() -``` - - - -Converts the value of the variable to a string. - - - - - - -**Returns**: - -The value of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IDoubleVariable::invalidate() -``` - - - -Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. - - - -**Return type**: void - -**Reimplements**: [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) - - -### Function directPrecedents - -![][public] - -``` -LPDISPATCH ModelCenter::IDoubleVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) - - -### Function directDependents - -![][public] - -``` -LPDISPATCH ModelCenter::IDoubleVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) - - -### Function precedentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IDoubleVariable::precedentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) - - -### Function dependentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IDoubleVariable::dependentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) - - -### Function precedents - -![][public] - -``` -LPDISPATCH ModelCenter::IDoubleVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) - - -### Function dependents - -![][public] - -``` -LPDISPATCH ModelCenter::IDoubleVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) - - -### Function isInputToComponent - -![][public] - -``` -boolean ModelCenter::IDoubleVariable::isInputToComponent() -``` - - - -Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) - - -### Function isInputToModel - -![][public] - -``` -boolean ModelCenter::IDoubleVariable::isInputToModel() -``` - - - -Checks whether or not the variable is an input. A linked input returns false (Output). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) - - -### Function setMetadata - -![][public] - -``` -void ModelCenter::IDoubleVariable::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) -``` - - - -Sets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata specifier used to store the data. -* **type**:
-* **value**:
-* **access**:
-* **archive**:
- - - -**Parameters**: - -* BSTR **name** -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** -* VARIANT **value** -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** -* boolean **archive** - -**Return type**: void - -**Reimplements**: [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) - - -### Function getMetadata - -![][public] - -``` -VARIANT ModelCenter::IDoubleVariable::getMetadata(BSTR name) -``` - - - -Gets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata key name. - - -**Returns**: - -Metadata value. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -**Reimplements**: [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) - - -### Function setInitialValue - -![][public] - -``` -void ModelCenter::IDoubleVariable::setInitialValue(double value) -``` - - - -Sets the initial value of the variable. - - - - - - -**Parameters**: - -* **value**: The initial value. - - - -**Parameters**: - -* double **value** - -**Return type**: void - - -### Function hasLowerBound - -![][public] - -``` -boolean ModelCenter::IDoubleVariable::hasLowerBound() -``` - - - -Finds out whether or not the variable has an lower bound. - - - - - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Return type**: boolean - - -### Function hasUpperBound - -![][public] - -``` -boolean ModelCenter::IDoubleVariable::hasUpperBound() -``` - - - -Finds out whether or not the variable has an upper bound. - - - - - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Return type**: boolean - - -### Function toFormattedString - -![][public] - -``` -BSTR ModelCenter::IDoubleVariable::toFormattedString() -``` - - - -Converts the value to a formatted string, validating the variable if necessary. - - - - - - -**Returns**: - -A formatted string. - - - -**Return type**: BSTR - - -### Function fromFormattedString - -![][public] - -``` -void ModelCenter::IDoubleVariable::fromFormattedString(BSTR value) -``` - - - -Sets the value from a formatted string. - - - - - - -**Parameters**: - -* **value**: Formatted value to load. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - - -### Function toFormattedStringAbsolute - -![][public] - -``` -BSTR ModelCenter::IDoubleVariable::toFormattedStringAbsolute() -``` - - - -Converts the value to an absolute formatted string. - - - - - - -**Returns**: - -An absolute formatted string. - - - -**Return type**: BSTR - - -### Function clearUpperBound - -![][public] - -``` -void ModelCenter::IDoubleVariable::clearUpperBound() -``` - - - -Clears the upper bound property of the variable if it has previously been set. - - - -**Return type**: void - - -### Function clearLowerBound - -![][public] - -``` -void ModelCenter::IDoubleVariable::clearLowerBound() -``` - - - -Clears the lower bound property of the variable if it has previously been set. - - - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IDoubleVariable + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1977) + + + +COM Instance + +**Inherits from**: + +* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) + +## Members + +* [clearLowerBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a72ee20ae45907f6f6738dbba0ea63655) +* [clearUpperBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1aa8846eb2c93d138bf7b6c31d78f0dc56) +* [dependentLinks](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a385019a97e3ddbae4351fd6dd591a49c) +* [dependents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a04becbe1d34e232e21208333c0700e3c) +* [description](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a491df2e849d05621978fe706bb48de85) +* [directDependents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a6178082dc3de5e1f6665f4faebcb8c36) +* [directPrecedents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a7a14b5ef10935109b178062205b91b7a) +* [enumAliases](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a531c146537c198a1c71e5c5826757b01) +* [enumValues](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a0c6cd245f4c6bacc15398f88522a2992) +* [format](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a6181c6c0985068e31fdb725d719ddb35) +* [fromFormattedString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac054c3628e2d617a1972dc195cacec60) +* [fromString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1128d6c344adde4e9f9d95b0c19f87b9) +* [getFullName](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a00a7eca52d31c8f86e049dc1896d2434) +* [getMetadata](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a40ecee96822db8b700fe1a814b2ab3b1) +* [getName](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a10978bbb428eadf01141d2ceb2373c7a) +* [getType](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a974708d2da959d48ee301088918719fd) +* [hasChanged](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a547bbc74c5db046b8d125cfbc3a6ab57) +* [hasLowerBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a18723d07a18cb720d07bebee26f35d2f) +* [hasUpperBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1aa78deb300d4f268523777fcabe898ce5) +* [hide](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac8bae6ed29215d02364f98a876f2ccfa) +* [invalidate](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a9abf6ea522bbff16d7c2266202b5bdae) +* [isInput](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a162bb6a2a0c8cf5a2f3ee15daaaf85c2) +* [isInputToComponent](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a18112e5a20ca1711e97f8a5514995a49) +* [isInputToModel](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a34bbd8b682a39cbe120f972f0be7b1cd) +* [isValid](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1b873587774671d25664c294323beae8) +* [lowerBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a8d74ea79cd0203c477fa96e2410ba176) +* [OwningComponent](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ad15c38a3b89a2fa2be6e2f6b88268fd2) +* [precedentLinks](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a8bf056e8b989223191b2e8c7595c0753) +* [precedents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac65d0d53de6aee17106700d60161e9cf) +* [setInitialValue](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a34b3939cccf3f8862301863629b63434) +* [setMetadata](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a499a962844cae63886b79779e39db700) +* [toFormattedString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1fb28d4b74c3d0121725f15773f7d1bb) +* [toFormattedStringAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac4e47bfae3990e33c748b44580244be3) +* [toString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a59f1d75b8e24323ea9bf523159f04f69) +* [toStringAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a89797e61eedee333bd67b55b653ec21f) +* [units](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ad5b4b178eafbe9ebf4e55b3f5e158622) +* [upperBound](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a7585c786507e272216ec790ce278fd10) +* [validate](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1abddc8770d26e37ac9319be5b90bc6e3e) +* [value](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1aa7a7d4145814425b6ea93e831854d84c) +* [valueAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a364aa148101fa8ea9ddc2d624f96fcf5) + +## Properties + + +### Property hasChanged + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IDoubleVariable::hasChanged +``` + + + + + + + +**Return type**: boolean + + +### Property hide + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IDoubleVariable::hide +``` + + + + + + + +**Return type**: boolean + + +### Property OwningComponent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IDoubleVariable::OwningComponent +``` + + + + + + + +**Return type**: LPDISPATCH + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +double ModelCenter::IDoubleVariable::value +``` + + + +Value of the variable. + + + +**Return type**: double + + +### Property valueAbsolute + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +double ModelCenter::IDoubleVariable::valueAbsolute +``` + + + +The value of the variable. (Fetched without attempting to validate) + + + +**Return type**: double + + +### Property lowerBound + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +double ModelCenter::IDoubleVariable::lowerBound +``` + + + +Lower bound of the variable. + + + +**Return type**: double + + +### Property upperBound + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +double ModelCenter::IDoubleVariable::upperBound +``` + + + +Upper bound of the variable. + + + +**Return type**: double + + +### Property units + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IDoubleVariable::units +``` + + + +Units of the variable. + + + +**Return type**: BSTR + + +### Property description + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IDoubleVariable::description +``` + + + +Description of the variable. + + + +**Return type**: BSTR + + +### Property enumValues + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IDoubleVariable::enumValues +``` + + + +Enumerated values of the variable. + + + +**Return type**: BSTR + + +### Property enumAliases + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IDoubleVariable::enumAliases +``` + + + +Enumerated aliases of the variable. + + + +**Return type**: BSTR + + +### Property format + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IDoubleVariable::format +``` + + + +Format of the variable. + + + +**Return type**: BSTR + +## Public functions + + +### Function isValid + +![][public] + +``` +boolean ModelCenter::IDoubleVariable::isValid() +``` + + + +Returns whether or not the variable is valid. + + + + + + +**Returns**: + +True if variable is valid. False if the variable is not valid. + + + +**Return type**: boolean + +**Reimplements**: [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) + + +### Function validate + +![][public] + +``` +void ModelCenter::IDoubleVariable::validate() +``` + + + +Validates the variable by running the component if needed. + + + +**Return type**: void + +**Reimplements**: [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IDoubleVariable::getName() +``` + + + +Gets the name of the variable. + + + + + + +**Returns**: + +The name of the variable. + + + +**Return type**: BSTR + +**Reimplements**: [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IDoubleVariable::getFullName() +``` + + + +Gets the full ModelCenter path of the variable. + + + + + + +**Returns**: + +The full ModelCenter path of the variable. + + + +**Return type**: BSTR + +**Reimplements**: [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IDoubleVariable::getType() +``` + + + +Gets the type of the variable. + + + + + + +**Returns**: + +The type of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) + + +### Function isInput + +![][public] + +``` +boolean ModelCenter::IDoubleVariable::isInput() +``` + + + +Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a34bbd8b682a39cbe120f972f0be7b1cd). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) + + +### Function toString + +![][public] + +``` +BSTR ModelCenter::IDoubleVariable::toString() +``` + + + +Converts the variable value to a string, validating the variable if necessary. + + + + + + +**Returns**: + +The value of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) + + +### Function fromString + +![][public] + +``` +void ModelCenter::IDoubleVariable::fromString(BSTR value) +``` + + + +Sets the value of the variable from the specified string. + + + + + + +**Parameters**: + +* **value**: New value. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + +**Reimplements**: [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) + + +### Function toStringAbsolute + +![][public] + +``` +BSTR ModelCenter::IDoubleVariable::toStringAbsolute() +``` + + + +Converts the value of the variable to a string. + + + + + + +**Returns**: + +The value of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IDoubleVariable::invalidate() +``` + + + +Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. + + + +**Return type**: void + +**Reimplements**: [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) + + +### Function directPrecedents + +![][public] + +``` +LPDISPATCH ModelCenter::IDoubleVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) + + +### Function directDependents + +![][public] + +``` +LPDISPATCH ModelCenter::IDoubleVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) + + +### Function precedentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IDoubleVariable::precedentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) + + +### Function dependentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IDoubleVariable::dependentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) + + +### Function precedents + +![][public] + +``` +LPDISPATCH ModelCenter::IDoubleVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) + + +### Function dependents + +![][public] + +``` +LPDISPATCH ModelCenter::IDoubleVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) + + +### Function isInputToComponent + +![][public] + +``` +boolean ModelCenter::IDoubleVariable::isInputToComponent() +``` + + + +Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) + + +### Function isInputToModel + +![][public] + +``` +boolean ModelCenter::IDoubleVariable::isInputToModel() +``` + + + +Checks whether or not the variable is an input. A linked input returns false (Output). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) + + +### Function setMetadata + +![][public] + +``` +void ModelCenter::IDoubleVariable::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) +``` + + + +Sets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata specifier used to store the data. +* **type**:
+* **value**:
+* **access**:
+* **archive**:
+ + + +**Parameters**: + +* BSTR **name** +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** +* VARIANT **value** +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** +* boolean **archive** + +**Return type**: void + +**Reimplements**: [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) + + +### Function getMetadata + +![][public] + +``` +VARIANT ModelCenter::IDoubleVariable::getMetadata(BSTR name) +``` + + + +Gets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata key name. + + +**Returns**: + +Metadata value. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +**Reimplements**: [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) + + +### Function setInitialValue + +![][public] + +``` +void ModelCenter::IDoubleVariable::setInitialValue(double value) +``` + + + +Sets the initial value of the variable. + + + + + + +**Parameters**: + +* **value**: The initial value. + + + +**Parameters**: + +* double **value** + +**Return type**: void + + +### Function hasLowerBound + +![][public] + +``` +boolean ModelCenter::IDoubleVariable::hasLowerBound() +``` + + + +Finds out whether or not the variable has an lower bound. + + + + + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Return type**: boolean + + +### Function hasUpperBound + +![][public] + +``` +boolean ModelCenter::IDoubleVariable::hasUpperBound() +``` + + + +Finds out whether or not the variable has an upper bound. + + + + + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Return type**: boolean + + +### Function toFormattedString + +![][public] + +``` +BSTR ModelCenter::IDoubleVariable::toFormattedString() +``` + + + +Converts the value to a formatted string, validating the variable if necessary. + + + + + + +**Returns**: + +A formatted string. + + + +**Return type**: BSTR + + +### Function fromFormattedString + +![][public] + +``` +void ModelCenter::IDoubleVariable::fromFormattedString(BSTR value) +``` + + + +Sets the value from a formatted string. + + + + + + +**Parameters**: + +* **value**: Formatted value to load. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + + +### Function toFormattedStringAbsolute + +![][public] + +``` +BSTR ModelCenter::IDoubleVariable::toFormattedStringAbsolute() +``` + + + +Converts the value to an absolute formatted string. + + + + + + +**Returns**: + +An absolute formatted string. + + + +**Return type**: BSTR + + +### Function clearUpperBound + +![][public] + +``` +void ModelCenter::IDoubleVariable::clearUpperBound() +``` + + + +Clears the upper bound property of the variable if it has previously been set. + + + +**Return type**: void + + +### Function clearLowerBound + +![][public] + +``` +void ModelCenter::IDoubleVariable::clearLowerBound() +``` + + + +Clears the lower bound property of the variable if it has previously been set. + + + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IFeature.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IFeature.md index a58fa4525b..defba7504f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IFeature.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IFeature.md @@ -1,38 +1,37 @@ - -# Interface ModelCenter::IFeature - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 2634) - - - -COM Instance. - -## Members - -* [checkin](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature_1a8cb220ceb67de96c199d761396bff884) - -## Public functions - - -### Function checkin - -![][public] - -``` -void ModelCenter::IFeature::checkin() -``` - - - -Checks in the feature associated with an object (asserts if no feature is currently checked out) - - - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IFeature + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 2634) + + + +COM Instance. + +## Members + +* [checkin](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature_1a8cb220ceb67de96c199d761396bff884) + +## Public functions + + +### Function checkin + +![][public] + +``` +void ModelCenter::IFeature::checkin() +``` + + + +Checks in the feature associated with an object (asserts if no feature is currently checked out) + + + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IFileArray.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IFileArray.md index 7ad172f961..3eb8223a96 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IFileArray.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IFileArray.md @@ -1,1506 +1,1505 @@ - -# Interface ModelCenter::IFileArray - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 2658) - - - -COM Instance. - -**Inherits from**: - -* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) - -## Members - -* [autoSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aca63a47369d69cbbf53532286b64a611) -* [dependentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a90373b06919789f06f52dd22a0339847) -* [dependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1af16a20eacc6734b343762565ec8b20d6) -* [description](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a8be2e0c977d8808648829d523c841d36) -* [directDependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab61572acbd0617f5c51b04b2ae4bbdba) -* [directPrecedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9f84f73f3b65f16fa507678c53c67527) -* [fileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ac8e13d4f87d1c0b784c5ebafd030fa57) -* [fileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a12eb5e82033d54430ee309a0ca2ad254) -* [fromFile](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a83b3e976d1267ab9bb6e59be7bd741d1) -* [fromString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab107312b8a5b1e8e96ae2a3678ef9897) -* [fromStringEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aa104ba67a0164c27a33017aabd29d83d) -* [getDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a83abe70ccf5e8a0a582748d84e3d7956) -* [getFileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1abea033ef41f0f2ad087b24387772e09b) -* [getFullName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7aada275954e2fff6bdea69b8a96bd0c) -* [getLength](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1acb6d739a4e50bcbbda5a5cf053ae21db) -* [getMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ae315b5cc3acb88a2edabaa8eea7a6690) -* [getName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a3f04f85ebe4f50a88c7cc3a61ae597f6) -* [getSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a3d171136e0b219dd4e2d0d1b4bb9aa1f) -* [getType](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a6614c3d1ae621d218762e8ed8ec58222) -* [hasChanged](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ae8928b3be9d425c01df1a6bc1052eeaa) -* [hide](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ace9ef38b4495497cd17fc358d675cf58) -* [invalidate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7599948212f77bb66f8ef42fc98e53ce) -* [isBinary](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a66fab48ff61be8f9c8e21bf0c9f96f45) -* [isInput](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9e45ea90908321e84979e5b8d2f50357) -* [isInputToComponent](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a29e9bceef09e96ad83ce6c0618eb17dd) -* [isInputToModel](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1accf93e4a9fe2c9eb205ccdf1704f3f9e) -* [isValid](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a1d3371b70abb06b2eff5d1ada8aa114f) -* [length](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af118bdf4b120050d6700a7ceae7f5bec) -* [numDimensions](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a757e103b1c6f7e5921adf31b7b1049ca) -* [OwningComponent](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aa0d97988f42416ca68f47e1fecfe6e73) -* [precedentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a998c2f1327219560aacd3d65d2c178b6) -* [precedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1abf61619be1e057cf2c42189456169041) -* [saveWithModel](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a2ce9625b3829cc7569fee6949e227dfe) -* [setDimensions](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a791424f1645b40c0b9b9d509effb1df8) -* [setFileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab92bd8b81525ab620509e01219d733fe) -* [setLength](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a66119cc8d733c8a2d6a8101569768662) -* [setMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a46a06089e51539cdb69a6404db042d28) -* [setSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b7b41ca5463a86aecb2368d73464c0e) -* [size](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aed6f1989cc53493063439e96852be675) -* [toFile](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a21c5941a7054482e4f7fd13e55db2738) -* [toFileAbsolute](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a118321f9f4f870bd9ec196813546b6f3) -* [toString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7ba909789490822b7ab12891075a9e56) -* [toStringAbsolute](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ac8f43fca8b974b224bd64a78bd3bdda3) -* [toStringAbsoluteEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a15dfd2825b183a80b93d849ce3429ca3) -* [toStringEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1afac8b4ceedd459ad68bed98ae18ea6a8) -* [validate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a506a66d66cb52b49d7385351bf0cfa46) -* [value](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a5b7408868a080c3d2b0b6812dc13a536) -* [value](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1af89ea57b9feb5597f3e190af1c8b5bf9) - -## Properties - - -### Property hasChanged - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IFileArray::hasChanged -``` - - - - - - - -**Return type**: boolean - - -### Property hide - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IFileArray::hide -``` - - - - - - - -**Return type**: boolean - - -### Property OwningComponent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IFileArray::OwningComponent -``` - - - - - - - -**Return type**: LPDISPATCH - - -### Property size - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IFileArray::size -``` - - - - - - - -**Return type**: long - - -### Property numDimensions - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IFileArray::numDimensions -``` - - - - - - - -**Return type**: long - - -### Property isBinary - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IFileArray::isBinary -``` - - - -Whether or not the file is binary. - - - -**Return type**: boolean - - -### Property description - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IFileArray::description -``` - - - -Description of the array. - - - -**Return type**: BSTR - - -### Property saveWithModel - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IFileArray::saveWithModel -``` - - - -Flag to indicate whether the file content to be saved with the Model file. - - - -**Return type**: boolean - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 2751) - -``` -VARIANT ModelCenter::IFileArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9) -``` - - - -Get the value of an array element. - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - -**Returns**: - -The value. - - - -**Return type**: VARIANT - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 2767) - -``` -BSTR ModelCenter::IFileArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9,[optional] VARIANT d10) -``` - - - -Set the value of an array element. - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). -* **newValue**: The new value. - - - -**Return type**: BSTR - - -### Property fileExtension - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 2826) - -``` -VARIANT ModelCenter::IFileArray::fileExtension( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9) -``` - - - -Gets the file extension of the variable. Used when opening the file in ModelCenter. - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - -**Returns**: - -The file extension. - - - -**Return type**: VARIANT - - -### Property fileExtension - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 2842) - -``` -BSTR ModelCenter::IFileArray::fileExtension( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9,[optional] VARIANT d10) -``` - - - -Sets the file extension of the variable. Used when opening the file in ModelCenter. - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). -* **newValue**: The file extension. - - - -**Return type**: BSTR - -## Public functions - - -### Function isValid - -![][public] - -``` -boolean ModelCenter::IFileArray::isValid() -``` - - - -Finds out whether or not the array is valid. - - - - - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Return type**: boolean - -**Reimplements**: [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) - - -### Function validate - -![][public] - -``` -void ModelCenter::IFileArray::validate() -``` - - - -Causes the array to validate itself. - - - -**Return type**: void - -**Reimplements**: [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IFileArray::getName() -``` - - - -Gets the name of the array. - - - - - - -**Returns**: - -The name of the array. - - - -**Return type**: BSTR - -**Reimplements**: [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IFileArray::getFullName() -``` - - - -Gets the full ModelCenter path of the array. - - - - - - -**Returns**: - -The full ModelCenter path of the array. - - - -**Return type**: BSTR - -**Reimplements**: [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IFileArray::getType() -``` - - - -Gets the type of the array. - - - - - - -**Returns**: - -The type of the array as a string. - - - -**Return type**: BSTR - -**Reimplements**: [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) - - -### Function isInput - -![][public] - -``` -boolean ModelCenter::IFileArray::isInput() -``` - - - -Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1accf93e4a9fe2c9eb205ccdf1704f3f9e). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) - - -### Function toString - -![][public] - -``` -BSTR ModelCenter::IFileArray::toString() -``` - - - -Converts the array to a string, validating the array if necessary. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. - - - - - - -**Returns**: - -The converted string value of the array. - - - -**Return type**: BSTR - -**Reimplements**: [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) - - -### Function fromString - -![][public] - -``` -void ModelCenter::IFileArray::fromString(BSTR value) -``` - - - -Sets the value of the array from a specified string. For 1D arrays, the specification is of the form '1,2,3'.
-For nD arrays, the specification is of the form 'bounds[2,2,2] {1,2,3,4,5,6,7,8}'.
-String arrays may optionally have the elements quoted in the form 'bounds[2,3] {"a", "b,c", "d", "", "e", "f"}' - - - - - - -**Parameters**: - -* **value**: New value. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - -**Reimplements**: [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) - - -### Function toStringAbsolute - -![][public] - -``` -BSTR ModelCenter::IFileArray::toStringAbsolute() -``` - - - -Converts the array to a string. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. - - - - - - -**Returns**: - -The converted string value of the array. - - - -**Return type**: BSTR - -**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IFileArray::invalidate() -``` - - - -Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. - - - -**Return type**: void - -**Reimplements**: [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) - - -### Function directPrecedents - -![][public] - -``` -LPDISPATCH ModelCenter::IFileArray::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) - - -### Function directDependents - -![][public] - -``` -LPDISPATCH ModelCenter::IFileArray::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) - - -### Function precedentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IFileArray::precedentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) - - -### Function dependentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IFileArray::dependentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) - - -### Function precedents - -![][public] - -``` -LPDISPATCH ModelCenter::IFileArray::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) - - -### Function dependents - -![][public] - -``` -LPDISPATCH ModelCenter::IFileArray::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) - - -### Function isInputToComponent - -![][public] - -``` -boolean ModelCenter::IFileArray::isInputToComponent() -``` - - - -Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) - - -### Function isInputToModel - -![][public] - -``` -boolean ModelCenter::IFileArray::isInputToModel() -``` - - - -Checks whether or not the variable is an input. A linked input returns false (Output). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) - - -### Function setMetadata - -![][public] - -``` -void ModelCenter::IFileArray::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) -``` - - - -Sets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata specifier used to store the data. -* **type**:
-* **value**:
-* **access**:
-* **archive**:
- - - -**Parameters**: - -* BSTR **name** -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** -* VARIANT **value** -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** -* boolean **archive** - -**Return type**: void - -**Reimplements**: [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) - - -### Function getMetadata - -![][public] - -``` -VARIANT ModelCenter::IFileArray::getMetadata(BSTR name) -``` - - - -Gets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata key name. - - -**Returns**: - -Metadata value. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -**Reimplements**: [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) - - -### Function toStringEx - -![][public] - -``` -BSTR ModelCenter::IFileArray::toStringEx(long index) -``` - - - -Converts the value of an array element to a string, validating the array if necessary. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The value of the element as a string. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - -**Reimplements**: [toStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a37c622ae9f50579f714ce98c0379cd98) - - -### Function fromStringEx - -![][public] - -``` -void ModelCenter::IFileArray::fromStringEx(BSTR value, long index) -``` - - - -Sets the value of an array element from a specified string. - - - - - - -**Parameters**: - -* **value**: New value. -* **index**: Index of the array element (0-based index). - - - -**Parameters**: - -* BSTR **value** -* long **index** - -**Return type**: void - -**Reimplements**: [fromStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad23f4082662c464be07251d6d1695a2d) - - -### Function toStringAbsoluteEx - -![][public] - -``` -BSTR ModelCenter::IFileArray::toStringAbsoluteEx(long index) -``` - - - -Converts the value of an array element to a string. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The value of the element as a string. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - -**Reimplements**: [toStringAbsoluteEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a2e3041440581aab716c684fe88d2ee87) - - -### Function getLength - -![][public] - -``` -long ModelCenter::IFileArray::getLength([optional] VARIANT dim) -``` - - - -Get the length of the n'th dimension of the array. - - - - - - -**Parameters**: - -* **dim**: Dimension of the array to query. This uses a 0 based index, so 0 will give you the first dimension, 1 the second, etc. If omitted, gives the first dimension - - -**Returns**: - -Length(size) of the array. - - - -**Parameters**: - -* _[optional]_ VARIANT **dim** - -**Return type**: long - -**Reimplements**: [getLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) - - -### Function setLength - -![][public] - -``` -void ModelCenter::IFileArray::setLength(long length, [optional] VARIANT dim) -``` - - - -Sets the length of the n'th dimension of the array - - - - - - -**Parameters**: - -* **length**: New length of the n'th dimension of the array -* **dim**: The dimension to set. This uses a 0 based index, so 0 will set the first dimension, 1 the second, etc. If omitted, sets the first dimension - - - -**Parameters**: - -* long **length** -* _[optional]_ VARIANT **dim** - -**Return type**: void - -**Reimplements**: [setLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) - - -### Function setDimensions - -![][public] - -``` -void ModelCenter::IFileArray::setDimensions(long d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Sets the number of dimensions of an array and the length of each dimension in one call. An array initializes to 0 length. If any dimension of the array has 0 length, the whole array contains no data. You must set the array size before filling in values unless you are using the setArray() call. - - - - - - -**Parameters**: - -* **d1**: length of the 1st dimension of the array -* **d2**: length of the 2nd dimension of the array. If omitted, the array is 1 dimensional -* **d3**: length of the 3rd dimension of the array. If omitted, the array is 2 dimensional -* **d4**: length of the 4th dimension of the array. If omitted, the array is 3 dimensional -* **d5**: length of the 5th dimension of the array. If omitted, the array is 4 dimensional -* **d6**: length of the 6th dimension of the array. If omitted, the array is 5 dimensional -* **d7**: length of the 7th dimension of the array. If omitted, the array is 6 dimensional -* **d8**: length of the 8th dimension of the array. If omitted, the array is 7 dimensional -* **d9**: length of the 9th dimension of the array. If omitted, the array is 8 dimensional -* **d10**: length of the 10th dimension of the array. If omitted, the array is 9 dimensional - - - -**Parameters**: - -* long **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: void - -**Reimplements**: [setDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) - - -### Function getFileExtension - -![][public] - -``` -BSTR ModelCenter::IFileArray::getFileExtension(VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Gets the extension used for the file (used to associate the file with an application). - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - -**Returns**: - -The file extension. - - - -**Parameters**: - -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: BSTR - - -### Function setFileExtension - -![][public] - -``` -void ModelCenter::IFileArray::setFileExtension(BSTR value, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Sets the desired file extension for the file. - - - - - - -**Parameters**: - -* **value**: The file extension. -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - - -**Parameters**: - -* BSTR **value** -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: void - - -### Function toFile - -![][public] - -``` -void ModelCenter::IFileArray::toFile(BSTR fileName, VARIANT encoding, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Writes out contents to a file. - - - - - - -**Parameters**: - -* **fileName**: The file to write. -* **encoding**: File encoding to be used (ascii, utf-8, binary). -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - - -**Parameters**: - -* BSTR **fileName** -* VARIANT **encoding** -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: void - - -### Function fromFile - -![][public] - -``` -void ModelCenter::IFileArray::fromFile(BSTR fileName, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Reads data from a file. - - - - - - -**Parameters**: - -* **fileName**: The file to load. -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - - -**Parameters**: - -* BSTR **fileName** -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: void - - -### Function toFileAbsolute - -![][public] - -``` -void ModelCenter::IFileArray::toFileAbsolute(BSTR fileName, VARIANT encoding, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Writes out contents to a file without validating the variable. - - - - - - -**Parameters**: - -* **fileName**: The file to write. -* **encoding**: File encoding to be used (ascii, utf-8, binary). -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - - -**Parameters**: - -* BSTR **fileName** -* VARIANT **encoding** -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IFileArray + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 2658) + + + +COM Instance. + +**Inherits from**: + +* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) + +## Members + +* [autoSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aca63a47369d69cbbf53532286b64a611) +* [dependentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a90373b06919789f06f52dd22a0339847) +* [dependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1af16a20eacc6734b343762565ec8b20d6) +* [description](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a8be2e0c977d8808648829d523c841d36) +* [directDependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab61572acbd0617f5c51b04b2ae4bbdba) +* [directPrecedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9f84f73f3b65f16fa507678c53c67527) +* [fileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ac8e13d4f87d1c0b784c5ebafd030fa57) +* [fileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a12eb5e82033d54430ee309a0ca2ad254) +* [fromFile](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a83b3e976d1267ab9bb6e59be7bd741d1) +* [fromString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab107312b8a5b1e8e96ae2a3678ef9897) +* [fromStringEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aa104ba67a0164c27a33017aabd29d83d) +* [getDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a83abe70ccf5e8a0a582748d84e3d7956) +* [getFileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1abea033ef41f0f2ad087b24387772e09b) +* [getFullName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7aada275954e2fff6bdea69b8a96bd0c) +* [getLength](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1acb6d739a4e50bcbbda5a5cf053ae21db) +* [getMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ae315b5cc3acb88a2edabaa8eea7a6690) +* [getName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a3f04f85ebe4f50a88c7cc3a61ae597f6) +* [getSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a3d171136e0b219dd4e2d0d1b4bb9aa1f) +* [getType](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a6614c3d1ae621d218762e8ed8ec58222) +* [hasChanged](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ae8928b3be9d425c01df1a6bc1052eeaa) +* [hide](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ace9ef38b4495497cd17fc358d675cf58) +* [invalidate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7599948212f77bb66f8ef42fc98e53ce) +* [isBinary](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a66fab48ff61be8f9c8e21bf0c9f96f45) +* [isInput](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9e45ea90908321e84979e5b8d2f50357) +* [isInputToComponent](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a29e9bceef09e96ad83ce6c0618eb17dd) +* [isInputToModel](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1accf93e4a9fe2c9eb205ccdf1704f3f9e) +* [isValid](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a1d3371b70abb06b2eff5d1ada8aa114f) +* [length](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af118bdf4b120050d6700a7ceae7f5bec) +* [numDimensions](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a757e103b1c6f7e5921adf31b7b1049ca) +* [OwningComponent](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aa0d97988f42416ca68f47e1fecfe6e73) +* [precedentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a998c2f1327219560aacd3d65d2c178b6) +* [precedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1abf61619be1e057cf2c42189456169041) +* [saveWithModel](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a2ce9625b3829cc7569fee6949e227dfe) +* [setDimensions](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a791424f1645b40c0b9b9d509effb1df8) +* [setFileExtension](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab92bd8b81525ab620509e01219d733fe) +* [setLength](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a66119cc8d733c8a2d6a8101569768662) +* [setMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a46a06089e51539cdb69a6404db042d28) +* [setSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b7b41ca5463a86aecb2368d73464c0e) +* [size](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1aed6f1989cc53493063439e96852be675) +* [toFile](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a21c5941a7054482e4f7fd13e55db2738) +* [toFileAbsolute](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a118321f9f4f870bd9ec196813546b6f3) +* [toString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7ba909789490822b7ab12891075a9e56) +* [toStringAbsolute](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ac8f43fca8b974b224bd64a78bd3bdda3) +* [toStringAbsoluteEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a15dfd2825b183a80b93d849ce3429ca3) +* [toStringEx](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1afac8b4ceedd459ad68bed98ae18ea6a8) +* [validate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a506a66d66cb52b49d7385351bf0cfa46) +* [value](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a5b7408868a080c3d2b0b6812dc13a536) +* [value](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1af89ea57b9feb5597f3e190af1c8b5bf9) + +## Properties + + +### Property hasChanged + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IFileArray::hasChanged +``` + + + + + + + +**Return type**: boolean + + +### Property hide + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IFileArray::hide +``` + + + + + + + +**Return type**: boolean + + +### Property OwningComponent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IFileArray::OwningComponent +``` + + + + + + + +**Return type**: LPDISPATCH + + +### Property size + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IFileArray::size +``` + + + + + + + +**Return type**: long + + +### Property numDimensions + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IFileArray::numDimensions +``` + + + + + + + +**Return type**: long + + +### Property isBinary + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IFileArray::isBinary +``` + + + +Whether or not the file is binary. + + + +**Return type**: boolean + + +### Property description + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IFileArray::description +``` + + + +Description of the array. + + + +**Return type**: BSTR + + +### Property saveWithModel + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IFileArray::saveWithModel +``` + + + +Flag to indicate whether the file content to be saved with the Model file. + + + +**Return type**: boolean + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 2751) + +``` +VARIANT ModelCenter::IFileArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9) +``` + + + +Get the value of an array element. + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + +**Returns**: + +The value. + + + +**Return type**: VARIANT + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 2767) + +``` +BSTR ModelCenter::IFileArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9,[optional] VARIANT d10) +``` + + + +Set the value of an array element. + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). +* **newValue**: The new value. + + + +**Return type**: BSTR + + +### Property fileExtension + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 2826) + +``` +VARIANT ModelCenter::IFileArray::fileExtension( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9) +``` + + + +Gets the file extension of the variable. Used when opening the file in ModelCenter. + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + +**Returns**: + +The file extension. + + + +**Return type**: VARIANT + + +### Property fileExtension + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 2842) + +``` +BSTR ModelCenter::IFileArray::fileExtension( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9,[optional] VARIANT d10) +``` + + + +Sets the file extension of the variable. Used when opening the file in ModelCenter. + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). +* **newValue**: The file extension. + + + +**Return type**: BSTR + +## Public functions + + +### Function isValid + +![][public] + +``` +boolean ModelCenter::IFileArray::isValid() +``` + + + +Finds out whether or not the array is valid. + + + + + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Return type**: boolean + +**Reimplements**: [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) + + +### Function validate + +![][public] + +``` +void ModelCenter::IFileArray::validate() +``` + + + +Causes the array to validate itself. + + + +**Return type**: void + +**Reimplements**: [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IFileArray::getName() +``` + + + +Gets the name of the array. + + + + + + +**Returns**: + +The name of the array. + + + +**Return type**: BSTR + +**Reimplements**: [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IFileArray::getFullName() +``` + + + +Gets the full ModelCenter path of the array. + + + + + + +**Returns**: + +The full ModelCenter path of the array. + + + +**Return type**: BSTR + +**Reimplements**: [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IFileArray::getType() +``` + + + +Gets the type of the array. + + + + + + +**Returns**: + +The type of the array as a string. + + + +**Return type**: BSTR + +**Reimplements**: [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) + + +### Function isInput + +![][public] + +``` +boolean ModelCenter::IFileArray::isInput() +``` + + + +Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1accf93e4a9fe2c9eb205ccdf1704f3f9e). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) + + +### Function toString + +![][public] + +``` +BSTR ModelCenter::IFileArray::toString() +``` + + + +Converts the array to a string, validating the array if necessary. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. + + + + + + +**Returns**: + +The converted string value of the array. + + + +**Return type**: BSTR + +**Reimplements**: [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) + + +### Function fromString + +![][public] + +``` +void ModelCenter::IFileArray::fromString(BSTR value) +``` + + + +Sets the value of the array from a specified string. For 1D arrays, the specification is of the form '1,2,3'.
+For nD arrays, the specification is of the form 'bounds[2,2,2] {1,2,3,4,5,6,7,8}'.
+String arrays may optionally have the elements quoted in the form 'bounds[2,3] {"a", "b,c", "d", "", "e", "f"}' + + + + + + +**Parameters**: + +* **value**: New value. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + +**Reimplements**: [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) + + +### Function toStringAbsolute + +![][public] + +``` +BSTR ModelCenter::IFileArray::toStringAbsolute() +``` + + + +Converts the array to a string. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. + + + + + + +**Returns**: + +The converted string value of the array. + + + +**Return type**: BSTR + +**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IFileArray::invalidate() +``` + + + +Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. + + + +**Return type**: void + +**Reimplements**: [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) + + +### Function directPrecedents + +![][public] + +``` +LPDISPATCH ModelCenter::IFileArray::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) + + +### Function directDependents + +![][public] + +``` +LPDISPATCH ModelCenter::IFileArray::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) + + +### Function precedentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IFileArray::precedentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) + + +### Function dependentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IFileArray::dependentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) + + +### Function precedents + +![][public] + +``` +LPDISPATCH ModelCenter::IFileArray::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) + + +### Function dependents + +![][public] + +``` +LPDISPATCH ModelCenter::IFileArray::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) + + +### Function isInputToComponent + +![][public] + +``` +boolean ModelCenter::IFileArray::isInputToComponent() +``` + + + +Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) + + +### Function isInputToModel + +![][public] + +``` +boolean ModelCenter::IFileArray::isInputToModel() +``` + + + +Checks whether or not the variable is an input. A linked input returns false (Output). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) + + +### Function setMetadata + +![][public] + +``` +void ModelCenter::IFileArray::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) +``` + + + +Sets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata specifier used to store the data. +* **type**:
+* **value**:
+* **access**:
+* **archive**:
+ + + +**Parameters**: + +* BSTR **name** +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** +* VARIANT **value** +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** +* boolean **archive** + +**Return type**: void + +**Reimplements**: [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) + + +### Function getMetadata + +![][public] + +``` +VARIANT ModelCenter::IFileArray::getMetadata(BSTR name) +``` + + + +Gets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata key name. + + +**Returns**: + +Metadata value. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +**Reimplements**: [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) + + +### Function toStringEx + +![][public] + +``` +BSTR ModelCenter::IFileArray::toStringEx(long index) +``` + + + +Converts the value of an array element to a string, validating the array if necessary. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The value of the element as a string. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + +**Reimplements**: [toStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a37c622ae9f50579f714ce98c0379cd98) + + +### Function fromStringEx + +![][public] + +``` +void ModelCenter::IFileArray::fromStringEx(BSTR value, long index) +``` + + + +Sets the value of an array element from a specified string. + + + + + + +**Parameters**: + +* **value**: New value. +* **index**: Index of the array element (0-based index). + + + +**Parameters**: + +* BSTR **value** +* long **index** + +**Return type**: void + +**Reimplements**: [fromStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad23f4082662c464be07251d6d1695a2d) + + +### Function toStringAbsoluteEx + +![][public] + +``` +BSTR ModelCenter::IFileArray::toStringAbsoluteEx(long index) +``` + + + +Converts the value of an array element to a string. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The value of the element as a string. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + +**Reimplements**: [toStringAbsoluteEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a2e3041440581aab716c684fe88d2ee87) + + +### Function getLength + +![][public] + +``` +long ModelCenter::IFileArray::getLength([optional] VARIANT dim) +``` + + + +Get the length of the n'th dimension of the array. + + + + + + +**Parameters**: + +* **dim**: Dimension of the array to query. This uses a 0 based index, so 0 will give you the first dimension, 1 the second, etc. If omitted, gives the first dimension + + +**Returns**: + +Length(size) of the array. + + + +**Parameters**: + +* _[optional]_ VARIANT **dim** + +**Return type**: long + +**Reimplements**: [getLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) + + +### Function setLength + +![][public] + +``` +void ModelCenter::IFileArray::setLength(long length, [optional] VARIANT dim) +``` + + + +Sets the length of the n'th dimension of the array + + + + + + +**Parameters**: + +* **length**: New length of the n'th dimension of the array +* **dim**: The dimension to set. This uses a 0 based index, so 0 will set the first dimension, 1 the second, etc. If omitted, sets the first dimension + + + +**Parameters**: + +* long **length** +* _[optional]_ VARIANT **dim** + +**Return type**: void + +**Reimplements**: [setLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) + + +### Function setDimensions + +![][public] + +``` +void ModelCenter::IFileArray::setDimensions(long d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Sets the number of dimensions of an array and the length of each dimension in one call. An array initializes to 0 length. If any dimension of the array has 0 length, the whole array contains no data. You must set the array size before filling in values unless you are using the setArray() call. + + + + + + +**Parameters**: + +* **d1**: length of the 1st dimension of the array +* **d2**: length of the 2nd dimension of the array. If omitted, the array is 1 dimensional +* **d3**: length of the 3rd dimension of the array. If omitted, the array is 2 dimensional +* **d4**: length of the 4th dimension of the array. If omitted, the array is 3 dimensional +* **d5**: length of the 5th dimension of the array. If omitted, the array is 4 dimensional +* **d6**: length of the 6th dimension of the array. If omitted, the array is 5 dimensional +* **d7**: length of the 7th dimension of the array. If omitted, the array is 6 dimensional +* **d8**: length of the 8th dimension of the array. If omitted, the array is 7 dimensional +* **d9**: length of the 9th dimension of the array. If omitted, the array is 8 dimensional +* **d10**: length of the 10th dimension of the array. If omitted, the array is 9 dimensional + + + +**Parameters**: + +* long **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: void + +**Reimplements**: [setDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) + + +### Function getFileExtension + +![][public] + +``` +BSTR ModelCenter::IFileArray::getFileExtension(VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Gets the extension used for the file (used to associate the file with an application). + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + +**Returns**: + +The file extension. + + + +**Parameters**: + +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: BSTR + + +### Function setFileExtension + +![][public] + +``` +void ModelCenter::IFileArray::setFileExtension(BSTR value, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Sets the desired file extension for the file. + + + + + + +**Parameters**: + +* **value**: The file extension. +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + + +**Parameters**: + +* BSTR **value** +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: void + + +### Function toFile + +![][public] + +``` +void ModelCenter::IFileArray::toFile(BSTR fileName, VARIANT encoding, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Writes out contents to a file. + + + + + + +**Parameters**: + +* **fileName**: The file to write. +* **encoding**: File encoding to be used (ascii, utf-8, binary). +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + + +**Parameters**: + +* BSTR **fileName** +* VARIANT **encoding** +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: void + + +### Function fromFile + +![][public] + +``` +void ModelCenter::IFileArray::fromFile(BSTR fileName, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Reads data from a file. + + + + + + +**Parameters**: + +* **fileName**: The file to load. +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + + +**Parameters**: + +* BSTR **fileName** +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: void + + +### Function toFileAbsolute + +![][public] + +``` +void ModelCenter::IFileArray::toFileAbsolute(BSTR fileName, VARIANT encoding, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Writes out contents to a file without validating the variable. + + + + + + +**Parameters**: + +* **fileName**: The file to write. +* **encoding**: File encoding to be used (ascii, utf-8, binary). +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + + +**Parameters**: + +* BSTR **fileName** +* VARIANT **encoding** +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IFileSystemInfo.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IFileSystemInfo.md index da65123baf..9f594ba89d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IFileSystemInfo.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IFileSystemInfo.md @@ -1,184 +1,183 @@ - -# Interface ModelCenter::IFileSystemInfo - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6626) - - - -Represents an object in a structured file system. Can represent a local file, a network file, or anything else. - -## Members - -* [baseName](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a0f840f7244ed0a52fa4d7c2a19a08264) -* [exists](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a5f79e2722103398d5f02e9fbb3c08c8b) -* [isValid](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a7df18a18470a00422781d711e56a20be) -* [isWritable](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a349473cf74146c2b8c824e0c47c899e5) -* [pin](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1afc052eba4f15b6f7a62b0b0cee7b8e4e) -* [url](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1addbccbd60da206c6fb480eb4fe05e967) - -## Properties - - -### Property isValid - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IFileSystemInfo::isValid -``` - - - -Indicates whether the object is valid. - - - -**Return type**: boolean - - -### Property exists - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IFileSystemInfo::exists -``` - - - -Indicates whether the object exists. - - - - - -NOTE: other operations may fail or return default values if the object does not exist, so be sure to check this first if you have any doubt! - - - -**Return type**: boolean - - -### Property isWritable - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IFileSystemInfo::isWritable -``` - - - -Indicates whether the object is writable (true) or read-only (false). - - - -**Return type**: boolean - - -### Property baseName - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IFileSystemInfo::baseName -``` - - - -Get the base filename, regardless of whether this is a version, file, or otherwise. This is the name of the file as it would appear on a local disk. - - - - - -For example, if this is readme.txt, version 2, this function will return "readme.txt". - - - -**Return type**: BSTR - - -### Property url - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IFileSystemInfo::url -``` - - - -Get the full URL of the object as a string. - - - -**Return type**: BSTR - -## Public functions - - -### Function pin - -![][public] - -``` -LPDISPATCH ModelCenter::IFileSystemInfo::pin(boolean forWrite, [optional] VARIANT forceCopy) -``` - - - -Pin this file in the cache. - - - - - -NOTE: There is no guarantee that the resource will actually be cached if it is accessible through a local or (on Windows) UNC path unless you set the optional 'forceCopy' parameter to 'true'. There is a large performance advantage to not having to copy the file into the cache, especially for large files or slow network drives. However, certain functions will not work on an uncached local file, such as revertChanges() (see below). If you know you want to be able to flush and/or revert changes as you work, you should specify 'forceCopy' = 'true'. - - - - - -NOTE: Pinning a file with 'forceCopy' = 'true' after calling [pin()](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1afc052eba4f15b6f7a62b0b0cee7b8e4e) on the same file with 'forceCopy' = 'false' _may_ result in an error. - - - - - - -**Parameters**: - -* **forWrite**: Indicates whether this file should be pinned for write; if it doesn't exist, it may be created -* **Indicates**: whether to force creating a copy of the file in the cache, even if the file would otherwise be directly accessed through a local path.
- - -**Returns**: - -IDispatch* to an [ICachePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin) object - - - -**Parameters**: - -* boolean **forWrite** -* _[optional]_ VARIANT **forceCopy** - -**Return type**: LPDISPATCH - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IFileSystemInfo + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6626) + + + +Represents an object in a structured file system. Can represent a local file, a network file, or anything else. + +## Members + +* [baseName](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a0f840f7244ed0a52fa4d7c2a19a08264) +* [exists](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a5f79e2722103398d5f02e9fbb3c08c8b) +* [isValid](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a7df18a18470a00422781d711e56a20be) +* [isWritable](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1a349473cf74146c2b8c824e0c47c899e5) +* [pin](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1afc052eba4f15b6f7a62b0b0cee7b8e4e) +* [url](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1addbccbd60da206c6fb480eb4fe05e967) + +## Properties + + +### Property isValid + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IFileSystemInfo::isValid +``` + + + +Indicates whether the object is valid. + + + +**Return type**: boolean + + +### Property exists + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IFileSystemInfo::exists +``` + + + +Indicates whether the object exists. + + + + + +NOTE: other operations may fail or return default values if the object does not exist, so be sure to check this first if you have any doubt! + + + +**Return type**: boolean + + +### Property isWritable + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IFileSystemInfo::isWritable +``` + + + +Indicates whether the object is writable (true) or read-only (false). + + + +**Return type**: boolean + + +### Property baseName + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IFileSystemInfo::baseName +``` + + + +Get the base filename, regardless of whether this is a version, file, or otherwise. This is the name of the file as it would appear on a local disk. + + + + + +For example, if this is readme.txt, version 2, this function will return "readme.txt". + + + +**Return type**: BSTR + + +### Property url + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IFileSystemInfo::url +``` + + + +Get the full URL of the object as a string. + + + +**Return type**: BSTR + +## Public functions + + +### Function pin + +![][public] + +``` +LPDISPATCH ModelCenter::IFileSystemInfo::pin(boolean forWrite, [optional] VARIANT forceCopy) +``` + + + +Pin this file in the cache. + + + + + +NOTE: There is no guarantee that the resource will actually be cached if it is accessible through a local or (on Windows) UNC path unless you set the optional 'forceCopy' parameter to 'true'. There is a large performance advantage to not having to copy the file into the cache, especially for large files or slow network drives. However, certain functions will not work on an uncached local file, such as revertChanges() (see below). If you know you want to be able to flush and/or revert changes as you work, you should specify 'forceCopy' = 'true'. + + + + + +NOTE: Pinning a file with 'forceCopy' = 'true' after calling [pin()](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo_1afc052eba4f15b6f7a62b0b0cee7b8e4e) on the same file with 'forceCopy' = 'false' _may_ result in an error. + + + + + + +**Parameters**: + +* **forWrite**: Indicates whether this file should be pinned for write; if it doesn't exist, it may be created +* **Indicates**: whether to force creating a copy of the file in the cache, even if the file would otherwise be directly accessed through a local path.
+ + +**Returns**: + +IDispatch* to an [ICachePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin) object + + + +**Parameters**: + +* boolean **forWrite** +* _[optional]_ VARIANT **forceCopy** + +**Return type**: LPDISPATCH + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IFileVariable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IFileVariable.md index cf415039a6..780020a142 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IFileVariable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IFileVariable.md @@ -1,1048 +1,1047 @@ - -# Interface ModelCenter::IFileVariable - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 2933) - - - -COM Instance - -**Inherits from**: - -* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) - -## Members - -* [dependentLinks](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a46a1da5e2a3f39c2e413b520ec33407f) -* [dependents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac63897b5927f1ad28965384718c0de6b) -* [description](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac0f28c2d059dc02d18d3dd8eaba19f31) -* [directDependents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a9347c073e1dc6ca62f1b3c7cd6fbec71) -* [directPrecedents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aea8561351c3ff1e003d463616682a838) -* [directTransfer](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a248392894f6cd7f2662f29c3f110d7af) -* [fileExtension](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ad161b90c198e19be1132a9e5592e9416) -* [fromFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a9ca208f1854ac22bb31e38119e2e2af5) -* [fromString](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac7654e743af45785904858d2c581058d) -* [getFullName](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a5b0b8db5aec4ebfbd8e7918568c71b70) -* [getMetadata](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a730717369f8ddb8fccfcb3405c56afe3) -* [getName](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1adbaa029c76034043ccdf2bf84bbd0e7f) -* [getType](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aec7c7bb8f9e43d411c457d7b091e5378) -* [hasChanged](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa81da335ee85ebf5f806be0b1bc1f39c) -* [hide](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a6c602247c4c00069af837d7dcbfb3862) -* [invalidate](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2beb5e20db0843a92acf8d0cc961e3af) -* [isBinary](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2d900fe8d944b0dceaea355cf64ba5a8) -* [isInput](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a92363045c1f3285c5c1127ad149c0250) -* [isInputToComponent](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a8ca654408734e709fddeb945e81a5d29) -* [isInputToModel](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a7bd0dbfb0063987f2484dce0cd61c8d1) -* [isValid](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2d8ceabbeb9640dffb9f6a9e654bbd79) -* [OwningComponent](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a75e79199eccdfb4f00ce0d27f2f1c593) -* [precedentLinks](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a4bc52bbf01e5d0a0f95e67e03cce4547) -* [precedents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a8db95046419c83467475175b216efe84) -* [readFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a93be7b40a50c1d8b612037a105f8fd5f) -* [saveWithModel](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a4ad8feb4200950e76e3ea66afcee286b) -* [setMetadata](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ad532913f25d0b0d02cc2c27105e7ecc8) -* [toFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa3da8eb730cd02ed21080272cc41deb5) -* [toFileAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a45afd477c357c9c3002a4046c1eefd32) -* [toString](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ae28a776965df5807d9ce8b2e0d995867) -* [toStringAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a0dda099769e13bdd8c5c076fc7d9378a) -* [validate](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa3fdf5883f1849f93bf87256b9100d0b) -* [value](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a44a74adf54ce33e5e11d52ff561b37ad) -* [writeFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac5ccf89eeca381ed315bbc4080c5df6b) -* [writeFileAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ae4220f9f0731a8078169bab709fb9198) - -## Properties - - -### Property hasChanged - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IFileVariable::hasChanged -``` - - - - - - - -**Return type**: boolean - - -### Property hide - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IFileVariable::hide -``` - - - - - - - -**Return type**: boolean - - -### Property OwningComponent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IFileVariable::OwningComponent -``` - - - - - - - -**Return type**: LPDISPATCH - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IFileVariable::value -``` - - - -Value of the variable. - - - -**Return type**: BSTR - - -### Property isBinary - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IFileVariable::isBinary -``` - - - -Whether or not the file is binary. - - - -**Return type**: boolean - - -### Property fileExtension - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IFileVariable::fileExtension -``` - - - -File extension of the variable. Used when opening the file in [ModelCenter](namespaceModelCenter.md#namespaceModelCenter). - - - -**Return type**: BSTR - - -### Property description - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IFileVariable::description -``` - - - -The description of the variable. - - - -**Return type**: BSTR - - -### Property saveWithModel - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IFileVariable::saveWithModel -``` - - - -Flag to indicate whether the file content to be saved with the Model file. - - - -**Return type**: boolean - - -### Property directTransfer - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IFileVariable::directTransfer -``` - - - -Flag to indicate whether direct file transfer is used for incoming link. - - - -**Return type**: boolean - -## Public functions - - -### Function isValid - -![][public] - -``` -boolean ModelCenter::IFileVariable::isValid() -``` - - - -Returns whether or not the variable is valid. - - - - - - -**Returns**: - -True if variable is valid. False if the variable is not valid. - - - -**Return type**: boolean - -**Reimplements**: [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) - - -### Function validate - -![][public] - -``` -void ModelCenter::IFileVariable::validate() -``` - - - -Validates the variable by running the component if needed. - - - -**Return type**: void - -**Reimplements**: [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IFileVariable::getName() -``` - - - -Gets the name of the variable. - - - - - - -**Returns**: - -The name of the variable. - - - -**Return type**: BSTR - -**Reimplements**: [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IFileVariable::getFullName() -``` - - - -Gets the full ModelCenter path of the variable. - - - - - - -**Returns**: - -The full ModelCenter path of the variable. - - - -**Return type**: BSTR - -**Reimplements**: [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IFileVariable::getType() -``` - - - -Gets the type of the variable. - - - - - - -**Returns**: - -The type of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) - - -### Function isInput - -![][public] - -``` -boolean ModelCenter::IFileVariable::isInput() -``` - - - -Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a7bd0dbfb0063987f2484dce0cd61c8d1). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) - - -### Function toString - -![][public] - -``` -BSTR ModelCenter::IFileVariable::toString() -``` - - - -Converts the variable value to a string, validating the variable if necessary. - - - - - - -**Returns**: - -The value of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) - - -### Function fromString - -![][public] - -``` -void ModelCenter::IFileVariable::fromString(BSTR value) -``` - - - -Sets the value of the variable from the specified string. - - - - - - -**Parameters**: - -* **value**: New value. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - -**Reimplements**: [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) - - -### Function toStringAbsolute - -![][public] - -``` -BSTR ModelCenter::IFileVariable::toStringAbsolute() -``` - - - -Converts the value of the variable to a string. - - - - - - -**Returns**: - -The value of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IFileVariable::invalidate() -``` - - - -Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. - - - -**Return type**: void - -**Reimplements**: [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) - - -### Function directPrecedents - -![][public] - -``` -LPDISPATCH ModelCenter::IFileVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) - - -### Function directDependents - -![][public] - -``` -LPDISPATCH ModelCenter::IFileVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) - - -### Function precedentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IFileVariable::precedentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) - - -### Function dependentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IFileVariable::dependentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) - - -### Function precedents - -![][public] - -``` -LPDISPATCH ModelCenter::IFileVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) - - -### Function dependents - -![][public] - -``` -LPDISPATCH ModelCenter::IFileVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) - - -### Function isInputToComponent - -![][public] - -``` -boolean ModelCenter::IFileVariable::isInputToComponent() -``` - - - -Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) - - -### Function isInputToModel - -![][public] - -``` -boolean ModelCenter::IFileVariable::isInputToModel() -``` - - - -Checks whether or not the variable is an input. A linked input returns false (Output). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) - - -### Function setMetadata - -![][public] - -``` -void ModelCenter::IFileVariable::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) -``` - - - -Sets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata specifier used to store the data. -* **type**:
-* **value**:
-* **access**:
-* **archive**:
- - - -**Parameters**: - -* BSTR **name** -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** -* VARIANT **value** -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** -* boolean **archive** - -**Return type**: void - -**Reimplements**: [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) - - -### Function getMetadata - -![][public] - -``` -VARIANT ModelCenter::IFileVariable::getMetadata(BSTR name) -``` - - - -Gets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata key name. - - -**Returns**: - -Metadata value. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -**Reimplements**: [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) - - -### Function toFile - -![][public] - -``` -void ModelCenter::IFileVariable::toFile(BSTR fileName, [optional] VARIANT encoding) -``` - - - -Writes the value of the variable to a file. - - - - - - -**Parameters**: - -* **fileName**: Path of the file. -* **encoding**: File encoding to be used (ascii, utf-8, binary). - - - -**Parameters**: - -* BSTR **fileName** -* _[optional]_ VARIANT **encoding** - -**Return type**: void - - -### Function fromFile - -![][public] - -``` -void ModelCenter::IFileVariable::fromFile(BSTR fileName) -``` - - - -Sets the value of the variable from a specified file. - - - - - - -**Parameters**: - -* **fileName**: Path of the file. - - - -**Parameters**: - -* BSTR **fileName** - -**Return type**: void - - -### Function writeFile - -![][public] - -``` -void ModelCenter::IFileVariable::writeFile(BSTR fileName) -``` - - - -Writes the value of the variable to a file. - - - - - - -**Parameters**: - -* **fileName**: Path of the file. - - - -**Parameters**: - -* BSTR **fileName** - -**Return type**: void - - -### Function readFile - -![][public] - -``` -void ModelCenter::IFileVariable::readFile(BSTR fileName) -``` - - - -Sets the value of the variable from a specified file. - - - - - - -**Parameters**: - -* **fileName**: Path of the file. - - - -**Parameters**: - -* BSTR **fileName** - -**Return type**: void - - -### Function toFileAbsolute - -![][public] - -``` -void ModelCenter::IFileVariable::toFileAbsolute(BSTR fileName, [optional] VARIANT encoding) -``` - - - -Writes the absolute value of the variable to a file. Optional parameter to specify the encoding as ASCII, UTF-8 or binary. If no encoding is specified, will default to ASCII for text files and binary for binary files. Will throw an exception if binary encoding is used on a text file or if ascii or utf-8 encoding is used on a binary file. - - - - - - -**Parameters**: - -* **fileName**: Path of the file. -* **encoding**: The desired encoding of the file. Can be: 'ascii', 'utf-8', or 'binary'. - - - -**Parameters**: - -* BSTR **fileName** -* _[optional]_ VARIANT **encoding** - -**Return type**: void - - -### Function writeFileAbsolute - -![][public] - -``` -void ModelCenter::IFileVariable::writeFileAbsolute(BSTR fileName) -``` - - - -Writes the absolute value of the variable to a file. - - - - - - -**Parameters**: - -* **fileName**: Path of the file. - - - -**Parameters**: - -* BSTR **fileName** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IFileVariable + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 2933) + + + +COM Instance + +**Inherits from**: + +* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) + +## Members + +* [dependentLinks](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a46a1da5e2a3f39c2e413b520ec33407f) +* [dependents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac63897b5927f1ad28965384718c0de6b) +* [description](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac0f28c2d059dc02d18d3dd8eaba19f31) +* [directDependents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a9347c073e1dc6ca62f1b3c7cd6fbec71) +* [directPrecedents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aea8561351c3ff1e003d463616682a838) +* [directTransfer](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a248392894f6cd7f2662f29c3f110d7af) +* [fileExtension](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ad161b90c198e19be1132a9e5592e9416) +* [fromFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a9ca208f1854ac22bb31e38119e2e2af5) +* [fromString](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac7654e743af45785904858d2c581058d) +* [getFullName](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a5b0b8db5aec4ebfbd8e7918568c71b70) +* [getMetadata](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a730717369f8ddb8fccfcb3405c56afe3) +* [getName](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1adbaa029c76034043ccdf2bf84bbd0e7f) +* [getType](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aec7c7bb8f9e43d411c457d7b091e5378) +* [hasChanged](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa81da335ee85ebf5f806be0b1bc1f39c) +* [hide](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a6c602247c4c00069af837d7dcbfb3862) +* [invalidate](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2beb5e20db0843a92acf8d0cc961e3af) +* [isBinary](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2d900fe8d944b0dceaea355cf64ba5a8) +* [isInput](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a92363045c1f3285c5c1127ad149c0250) +* [isInputToComponent](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a8ca654408734e709fddeb945e81a5d29) +* [isInputToModel](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a7bd0dbfb0063987f2484dce0cd61c8d1) +* [isValid](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2d8ceabbeb9640dffb9f6a9e654bbd79) +* [OwningComponent](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a75e79199eccdfb4f00ce0d27f2f1c593) +* [precedentLinks](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a4bc52bbf01e5d0a0f95e67e03cce4547) +* [precedents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a8db95046419c83467475175b216efe84) +* [readFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a93be7b40a50c1d8b612037a105f8fd5f) +* [saveWithModel](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a4ad8feb4200950e76e3ea66afcee286b) +* [setMetadata](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ad532913f25d0b0d02cc2c27105e7ecc8) +* [toFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa3da8eb730cd02ed21080272cc41deb5) +* [toFileAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a45afd477c357c9c3002a4046c1eefd32) +* [toString](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ae28a776965df5807d9ce8b2e0d995867) +* [toStringAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a0dda099769e13bdd8c5c076fc7d9378a) +* [validate](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa3fdf5883f1849f93bf87256b9100d0b) +* [value](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a44a74adf54ce33e5e11d52ff561b37ad) +* [writeFile](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac5ccf89eeca381ed315bbc4080c5df6b) +* [writeFileAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ae4220f9f0731a8078169bab709fb9198) + +## Properties + + +### Property hasChanged + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IFileVariable::hasChanged +``` + + + + + + + +**Return type**: boolean + + +### Property hide + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IFileVariable::hide +``` + + + + + + + +**Return type**: boolean + + +### Property OwningComponent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IFileVariable::OwningComponent +``` + + + + + + + +**Return type**: LPDISPATCH + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IFileVariable::value +``` + + + +Value of the variable. + + + +**Return type**: BSTR + + +### Property isBinary + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IFileVariable::isBinary +``` + + + +Whether or not the file is binary. + + + +**Return type**: boolean + + +### Property fileExtension + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IFileVariable::fileExtension +``` + + + +File extension of the variable. Used when opening the file in [ModelCenter](namespaceModelCenter.md#namespaceModelCenter). + + + +**Return type**: BSTR + + +### Property description + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IFileVariable::description +``` + + + +The description of the variable. + + + +**Return type**: BSTR + + +### Property saveWithModel + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IFileVariable::saveWithModel +``` + + + +Flag to indicate whether the file content to be saved with the Model file. + + + +**Return type**: boolean + + +### Property directTransfer + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IFileVariable::directTransfer +``` + + + +Flag to indicate whether direct file transfer is used for incoming link. + + + +**Return type**: boolean + +## Public functions + + +### Function isValid + +![][public] + +``` +boolean ModelCenter::IFileVariable::isValid() +``` + + + +Returns whether or not the variable is valid. + + + + + + +**Returns**: + +True if variable is valid. False if the variable is not valid. + + + +**Return type**: boolean + +**Reimplements**: [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) + + +### Function validate + +![][public] + +``` +void ModelCenter::IFileVariable::validate() +``` + + + +Validates the variable by running the component if needed. + + + +**Return type**: void + +**Reimplements**: [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IFileVariable::getName() +``` + + + +Gets the name of the variable. + + + + + + +**Returns**: + +The name of the variable. + + + +**Return type**: BSTR + +**Reimplements**: [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IFileVariable::getFullName() +``` + + + +Gets the full ModelCenter path of the variable. + + + + + + +**Returns**: + +The full ModelCenter path of the variable. + + + +**Return type**: BSTR + +**Reimplements**: [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IFileVariable::getType() +``` + + + +Gets the type of the variable. + + + + + + +**Returns**: + +The type of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) + + +### Function isInput + +![][public] + +``` +boolean ModelCenter::IFileVariable::isInput() +``` + + + +Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a7bd0dbfb0063987f2484dce0cd61c8d1). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) + + +### Function toString + +![][public] + +``` +BSTR ModelCenter::IFileVariable::toString() +``` + + + +Converts the variable value to a string, validating the variable if necessary. + + + + + + +**Returns**: + +The value of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) + + +### Function fromString + +![][public] + +``` +void ModelCenter::IFileVariable::fromString(BSTR value) +``` + + + +Sets the value of the variable from the specified string. + + + + + + +**Parameters**: + +* **value**: New value. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + +**Reimplements**: [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) + + +### Function toStringAbsolute + +![][public] + +``` +BSTR ModelCenter::IFileVariable::toStringAbsolute() +``` + + + +Converts the value of the variable to a string. + + + + + + +**Returns**: + +The value of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IFileVariable::invalidate() +``` + + + +Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. + + + +**Return type**: void + +**Reimplements**: [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) + + +### Function directPrecedents + +![][public] + +``` +LPDISPATCH ModelCenter::IFileVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) + + +### Function directDependents + +![][public] + +``` +LPDISPATCH ModelCenter::IFileVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) + + +### Function precedentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IFileVariable::precedentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) + + +### Function dependentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IFileVariable::dependentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) + + +### Function precedents + +![][public] + +``` +LPDISPATCH ModelCenter::IFileVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) + + +### Function dependents + +![][public] + +``` +LPDISPATCH ModelCenter::IFileVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) + + +### Function isInputToComponent + +![][public] + +``` +boolean ModelCenter::IFileVariable::isInputToComponent() +``` + + + +Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) + + +### Function isInputToModel + +![][public] + +``` +boolean ModelCenter::IFileVariable::isInputToModel() +``` + + + +Checks whether or not the variable is an input. A linked input returns false (Output). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) + + +### Function setMetadata + +![][public] + +``` +void ModelCenter::IFileVariable::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) +``` + + + +Sets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata specifier used to store the data. +* **type**:
+* **value**:
+* **access**:
+* **archive**:
+ + + +**Parameters**: + +* BSTR **name** +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** +* VARIANT **value** +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** +* boolean **archive** + +**Return type**: void + +**Reimplements**: [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) + + +### Function getMetadata + +![][public] + +``` +VARIANT ModelCenter::IFileVariable::getMetadata(BSTR name) +``` + + + +Gets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata key name. + + +**Returns**: + +Metadata value. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +**Reimplements**: [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) + + +### Function toFile + +![][public] + +``` +void ModelCenter::IFileVariable::toFile(BSTR fileName, [optional] VARIANT encoding) +``` + + + +Writes the value of the variable to a file. + + + + + + +**Parameters**: + +* **fileName**: Path of the file. +* **encoding**: File encoding to be used (ascii, utf-8, binary). + + + +**Parameters**: + +* BSTR **fileName** +* _[optional]_ VARIANT **encoding** + +**Return type**: void + + +### Function fromFile + +![][public] + +``` +void ModelCenter::IFileVariable::fromFile(BSTR fileName) +``` + + + +Sets the value of the variable from a specified file. + + + + + + +**Parameters**: + +* **fileName**: Path of the file. + + + +**Parameters**: + +* BSTR **fileName** + +**Return type**: void + + +### Function writeFile + +![][public] + +``` +void ModelCenter::IFileVariable::writeFile(BSTR fileName) +``` + + + +Writes the value of the variable to a file. + + + + + + +**Parameters**: + +* **fileName**: Path of the file. + + + +**Parameters**: + +* BSTR **fileName** + +**Return type**: void + + +### Function readFile + +![][public] + +``` +void ModelCenter::IFileVariable::readFile(BSTR fileName) +``` + + + +Sets the value of the variable from a specified file. + + + + + + +**Parameters**: + +* **fileName**: Path of the file. + + + +**Parameters**: + +* BSTR **fileName** + +**Return type**: void + + +### Function toFileAbsolute + +![][public] + +``` +void ModelCenter::IFileVariable::toFileAbsolute(BSTR fileName, [optional] VARIANT encoding) +``` + + + +Writes the absolute value of the variable to a file. Optional parameter to specify the encoding as ASCII, UTF-8 or binary. If no encoding is specified, will default to ASCII for text files and binary for binary files. Will throw an exception if binary encoding is used on a text file or if ascii or utf-8 encoding is used on a binary file. + + + + + + +**Parameters**: + +* **fileName**: Path of the file. +* **encoding**: The desired encoding of the file. Can be: 'ascii', 'utf-8', or 'binary'. + + + +**Parameters**: + +* BSTR **fileName** +* _[optional]_ VARIANT **encoding** + +**Return type**: void + + +### Function writeFileAbsolute + +![][public] + +``` +void ModelCenter::IFileVariable::writeFileAbsolute(BSTR fileName) +``` + + + +Writes the absolute value of the variable to a file. + + + + + + +**Parameters**: + +* **fileName**: Path of the file. + + + +**Parameters**: + +* BSTR **fileName** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IGeometryVariable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IGeometryVariable.md index 9451543d7e..7a18369bfa 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IGeometryVariable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IGeometryVariable.md @@ -1,809 +1,808 @@ - -# Interface ModelCenter::IGeometryVariable - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3056) - - - -COM Instance - -**Inherits from**: - -* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) - -## Members - -* [dependentLinks](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a50e3d7ea1d97cd799c29901c2b563208) -* [dependents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ab110babf06372919f705e71b64cc733f) -* [description](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ad6ac49ae6d10a8aef6927eaad49e55f1) -* [directDependents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a06be08cd5896250dc5b31ec3d90b79e6) -* [directPrecedents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a8294d8120195193f3a5fba86abcded57) -* [fromString](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a710bd007c2d1df9c861a33a397c7a9d7) -* [getFullName](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a0b0e9f581b1b038395dacb2700d82ce4) -* [getMetadata](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a9fa5015afd1b3cdd651ce2a0e093a6f6) -* [getName](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a2ab57d435f315c7afc7bed802b57d9d0) -* [getType](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a09f10acb36a75c48c2cce4f1925acb55) -* [hasChanged](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a14bb947193a4e5e629d104cadd3159be) -* [hide](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a1ed81bb22242904529b71361e954445a) -* [invalidate](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ac80cc84f95b559145c98a82367649d89) -* [isInput](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a8c9a1d489060c768242c74b57e85aec2) -* [isInputToComponent](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a3223f3e2305da64ecb24530ed3e1652f) -* [isInputToModel](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a324e6df2e0d789abb14a6ab9bbabb119) -* [isValid](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a01fe29466d2371dd25e6d9a473de32c7) -* [OwningComponent](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a9c9a3532f6f0ce9a907824f5e055e89f) -* [precedentLinks](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a42168bcdab0805055df8432194d5654c) -* [precedents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a6d516295359de158c45bf2a5c0378af0) -* [setInitialValue](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a61c5bac06b87725ae41b9a17f90b886b) -* [setMetadata](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a3c257357cc786dc18d4187d14b030813) -* [toString](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a0bda0cd0ea97014dc4be4ee2af69e55c) -* [toStringAbsolute](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a711f2c70a30362b587b39f5cd3775f71) -* [validate](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a62715d2cd23f7a7daafe7568d1a6e32d) -* [value](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ae013f10c0800acb5229f245f10d687f3) - -## Properties - - -### Property hasChanged - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IGeometryVariable::hasChanged -``` - - - - - - - -**Return type**: boolean - - -### Property hide - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IGeometryVariable::hide -``` - - - - - - - -**Return type**: boolean - - -### Property OwningComponent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IGeometryVariable::OwningComponent -``` - - - - - - - -**Return type**: LPDISPATCH - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IGeometryVariable::value -``` - - - -Value of the variable. - - - -**Return type**: BSTR - - -### Property description - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IGeometryVariable::description -``` - - - -Description of the variable. - - - -**Return type**: BSTR - -## Public functions - - -### Function isValid - -![][public] - -``` -boolean ModelCenter::IGeometryVariable::isValid() -``` - - - -Returns whether or not the variable is valid. - - - - - - -**Returns**: - -True if variable is valid. False if the variable is not valid. - - - -**Return type**: boolean - -**Reimplements**: [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) - - -### Function validate - -![][public] - -``` -void ModelCenter::IGeometryVariable::validate() -``` - - - -Validates the variable by running the component if needed. - - - -**Return type**: void - -**Reimplements**: [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IGeometryVariable::getName() -``` - - - -Gets the name of the variable. - - - - - - -**Returns**: - -The name of the variable. - - - -**Return type**: BSTR - -**Reimplements**: [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IGeometryVariable::getFullName() -``` - - - -Gets the full ModelCenter path of the variable. - - - - - - -**Returns**: - -The full ModelCenter path of the variable. - - - -**Return type**: BSTR - -**Reimplements**: [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IGeometryVariable::getType() -``` - - - -Gets the type of the variable. - - - - - - -**Returns**: - -The type of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) - - -### Function isInput - -![][public] - -``` -boolean ModelCenter::IGeometryVariable::isInput() -``` - - - -Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a324e6df2e0d789abb14a6ab9bbabb119). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) - - -### Function toString - -![][public] - -``` -BSTR ModelCenter::IGeometryVariable::toString() -``` - - - -Converts the variable value to a string, validating the variable if necessary. - - - - - - -**Returns**: - -The value of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) - - -### Function fromString - -![][public] - -``` -void ModelCenter::IGeometryVariable::fromString(BSTR value) -``` - - - -Sets the value of the variable from the specified string. - - - - - - -**Parameters**: - -* **value**: New value. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - -**Reimplements**: [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) - - -### Function toStringAbsolute - -![][public] - -``` -BSTR ModelCenter::IGeometryVariable::toStringAbsolute() -``` - - - -Converts the value of the variable to a string. - - - - - - -**Returns**: - -The value of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IGeometryVariable::invalidate() -``` - - - -Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. - - - -**Return type**: void - -**Reimplements**: [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) - - -### Function directPrecedents - -![][public] - -``` -LPDISPATCH ModelCenter::IGeometryVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) - - -### Function directDependents - -![][public] - -``` -LPDISPATCH ModelCenter::IGeometryVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) - - -### Function precedentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IGeometryVariable::precedentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) - - -### Function dependentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IGeometryVariable::dependentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) - - -### Function precedents - -![][public] - -``` -LPDISPATCH ModelCenter::IGeometryVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) - - -### Function dependents - -![][public] - -``` -LPDISPATCH ModelCenter::IGeometryVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) - - -### Function isInputToComponent - -![][public] - -``` -boolean ModelCenter::IGeometryVariable::isInputToComponent() -``` - - - -Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) - - -### Function isInputToModel - -![][public] - -``` -boolean ModelCenter::IGeometryVariable::isInputToModel() -``` - - - -Checks whether or not the variable is an input. A linked input returns false (Output). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) - - -### Function setMetadata - -![][public] - -``` -void ModelCenter::IGeometryVariable::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) -``` - - - -Sets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata specifier used to store the data. -* **type**:
-* **value**:
-* **access**:
-* **archive**:
- - - -**Parameters**: - -* BSTR **name** -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** -* VARIANT **value** -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** -* boolean **archive** - -**Return type**: void - -**Reimplements**: [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) - - -### Function getMetadata - -![][public] - -``` -VARIANT ModelCenter::IGeometryVariable::getMetadata(BSTR name) -``` - - - -Gets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata key name. - - -**Returns**: - -Metadata value. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -**Reimplements**: [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) - - -### Function setInitialValue - -![][public] - -``` -void ModelCenter::IGeometryVariable::setInitialValue(BSTR value) -``` - - - -Sets the initial value of the variable. - - - - - - -**Parameters**: - -* **value**: Initial value. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IGeometryVariable + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3056) + + + +COM Instance + +**Inherits from**: + +* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) + +## Members + +* [dependentLinks](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a50e3d7ea1d97cd799c29901c2b563208) +* [dependents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ab110babf06372919f705e71b64cc733f) +* [description](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ad6ac49ae6d10a8aef6927eaad49e55f1) +* [directDependents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a06be08cd5896250dc5b31ec3d90b79e6) +* [directPrecedents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a8294d8120195193f3a5fba86abcded57) +* [fromString](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a710bd007c2d1df9c861a33a397c7a9d7) +* [getFullName](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a0b0e9f581b1b038395dacb2700d82ce4) +* [getMetadata](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a9fa5015afd1b3cdd651ce2a0e093a6f6) +* [getName](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a2ab57d435f315c7afc7bed802b57d9d0) +* [getType](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a09f10acb36a75c48c2cce4f1925acb55) +* [hasChanged](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a14bb947193a4e5e629d104cadd3159be) +* [hide](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a1ed81bb22242904529b71361e954445a) +* [invalidate](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ac80cc84f95b559145c98a82367649d89) +* [isInput](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a8c9a1d489060c768242c74b57e85aec2) +* [isInputToComponent](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a3223f3e2305da64ecb24530ed3e1652f) +* [isInputToModel](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a324e6df2e0d789abb14a6ab9bbabb119) +* [isValid](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a01fe29466d2371dd25e6d9a473de32c7) +* [OwningComponent](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a9c9a3532f6f0ce9a907824f5e055e89f) +* [precedentLinks](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a42168bcdab0805055df8432194d5654c) +* [precedents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a6d516295359de158c45bf2a5c0378af0) +* [setInitialValue](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a61c5bac06b87725ae41b9a17f90b886b) +* [setMetadata](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a3c257357cc786dc18d4187d14b030813) +* [toString](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a0bda0cd0ea97014dc4be4ee2af69e55c) +* [toStringAbsolute](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a711f2c70a30362b587b39f5cd3775f71) +* [validate](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a62715d2cd23f7a7daafe7568d1a6e32d) +* [value](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ae013f10c0800acb5229f245f10d687f3) + +## Properties + + +### Property hasChanged + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IGeometryVariable::hasChanged +``` + + + + + + + +**Return type**: boolean + + +### Property hide + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IGeometryVariable::hide +``` + + + + + + + +**Return type**: boolean + + +### Property OwningComponent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IGeometryVariable::OwningComponent +``` + + + + + + + +**Return type**: LPDISPATCH + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IGeometryVariable::value +``` + + + +Value of the variable. + + + +**Return type**: BSTR + + +### Property description + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IGeometryVariable::description +``` + + + +Description of the variable. + + + +**Return type**: BSTR + +## Public functions + + +### Function isValid + +![][public] + +``` +boolean ModelCenter::IGeometryVariable::isValid() +``` + + + +Returns whether or not the variable is valid. + + + + + + +**Returns**: + +True if variable is valid. False if the variable is not valid. + + + +**Return type**: boolean + +**Reimplements**: [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) + + +### Function validate + +![][public] + +``` +void ModelCenter::IGeometryVariable::validate() +``` + + + +Validates the variable by running the component if needed. + + + +**Return type**: void + +**Reimplements**: [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IGeometryVariable::getName() +``` + + + +Gets the name of the variable. + + + + + + +**Returns**: + +The name of the variable. + + + +**Return type**: BSTR + +**Reimplements**: [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IGeometryVariable::getFullName() +``` + + + +Gets the full ModelCenter path of the variable. + + + + + + +**Returns**: + +The full ModelCenter path of the variable. + + + +**Return type**: BSTR + +**Reimplements**: [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IGeometryVariable::getType() +``` + + + +Gets the type of the variable. + + + + + + +**Returns**: + +The type of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) + + +### Function isInput + +![][public] + +``` +boolean ModelCenter::IGeometryVariable::isInput() +``` + + + +Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a324e6df2e0d789abb14a6ab9bbabb119). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) + + +### Function toString + +![][public] + +``` +BSTR ModelCenter::IGeometryVariable::toString() +``` + + + +Converts the variable value to a string, validating the variable if necessary. + + + + + + +**Returns**: + +The value of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) + + +### Function fromString + +![][public] + +``` +void ModelCenter::IGeometryVariable::fromString(BSTR value) +``` + + + +Sets the value of the variable from the specified string. + + + + + + +**Parameters**: + +* **value**: New value. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + +**Reimplements**: [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) + + +### Function toStringAbsolute + +![][public] + +``` +BSTR ModelCenter::IGeometryVariable::toStringAbsolute() +``` + + + +Converts the value of the variable to a string. + + + + + + +**Returns**: + +The value of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IGeometryVariable::invalidate() +``` + + + +Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. + + + +**Return type**: void + +**Reimplements**: [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) + + +### Function directPrecedents + +![][public] + +``` +LPDISPATCH ModelCenter::IGeometryVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) + + +### Function directDependents + +![][public] + +``` +LPDISPATCH ModelCenter::IGeometryVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) + + +### Function precedentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IGeometryVariable::precedentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) + + +### Function dependentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IGeometryVariable::dependentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) + + +### Function precedents + +![][public] + +``` +LPDISPATCH ModelCenter::IGeometryVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) + + +### Function dependents + +![][public] + +``` +LPDISPATCH ModelCenter::IGeometryVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) + + +### Function isInputToComponent + +![][public] + +``` +boolean ModelCenter::IGeometryVariable::isInputToComponent() +``` + + + +Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) + + +### Function isInputToModel + +![][public] + +``` +boolean ModelCenter::IGeometryVariable::isInputToModel() +``` + + + +Checks whether or not the variable is an input. A linked input returns false (Output). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) + + +### Function setMetadata + +![][public] + +``` +void ModelCenter::IGeometryVariable::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) +``` + + + +Sets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata specifier used to store the data. +* **type**:
+* **value**:
+* **access**:
+* **archive**:
+ + + +**Parameters**: + +* BSTR **name** +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** +* VARIANT **value** +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** +* boolean **archive** + +**Return type**: void + +**Reimplements**: [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) + + +### Function getMetadata + +![][public] + +``` +VARIANT ModelCenter::IGeometryVariable::getMetadata(BSTR name) +``` + + + +Gets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata key name. + + +**Returns**: + +Metadata value. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +**Reimplements**: [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) + + +### Function setInitialValue + +![][public] + +``` +void ModelCenter::IGeometryVariable::setInitialValue(BSTR value) +``` + + + +Sets the initial value of the variable. + + + + + + +**Parameters**: + +* **value**: Initial value. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IGlobalParameters.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IGlobalParameters.md index f0de03dc3c..0c7a6dce31 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IGlobalParameters.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IGlobalParameters.md @@ -1,172 +1,171 @@ - -# Interface ModelCenter::IGlobalParameters - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6424) - - - -A set of name/value pairs that can be used for programmatic purposes. Values are not stored with Model files. They can optionally be passed up to external servers, such as MCRE server. - -## Members - -* [\_item](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1a63a265a486f6a3a5df9cde8b65217d5f) -* [count](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1a53be79855251a6bd40bd71f35c4f6d8d) -* [item](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1a1fdee032bf053c5f99b0291bf04dcaec) -* [Remove](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1ae838217b346390c972f8173e9a55361c) -* [setExportToRemoteComponents](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1ad479e08f0fcaf6313a005c4fb3c80235) - -## Properties - - -### Property count - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IGlobalParameters::count -``` - - - -The count of the name/value pairs. - - - -**Return type**: long - - -### Property item - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6451) - -``` -VARIANT ModelCenter::IGlobalParameters::item -``` - - - -Receives the value of a particular parameter. - - - - - - -**Parameters**: - -* **index**: The name of the name/value pair to retrieve. - - -**Returns**: - -The value of the parameter. - -Receives the value of a particular parameter. - - - - - - -**Parameters**: - -* **index**: The name of the name/value pair to retrieve. -* **newValue**: The variable to hold the value of the parameter. - - - -**Return type**: VARIANT - - -### Property \_item - -![][private] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6460) - -``` -VARIANT ModelCenter::IGlobalParameters::_item -``` - - - - - - - -**Return type**: VARIANT - -## Public functions - - -### Function setExportToRemoteComponents - -![][public] - -``` -void ModelCenter::IGlobalParameters::setExportToRemoteComponents(VARIANT index, boolean bexport) -``` - - - -Sets whether this name/value pair is passed to external servers when a component is run on that server. - - - - - - -**Parameters**: - -* **index**: The name of the variable. -* **bexport**: If true, this name/value pair will be sent. - - - -**Parameters**: - -* VARIANT **index** -* boolean **bexport** - -**Return type**: void - - -### Function Remove - -![][public] - -``` -void ModelCenter::IGlobalParameters::Remove(VARIANT index) -``` - - - -Removes a named parameter. - - - - - - -**Parameters**: - -* **index**: The name of the parameter to remove. - - - -**Parameters**: - -* VARIANT **index** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IGlobalParameters + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6424) + + + +A set of name/value pairs that can be used for programmatic purposes. Values are not stored with Model files. They can optionally be passed up to external servers, such as MCRE server. + +## Members + +* [\_item](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1a63a265a486f6a3a5df9cde8b65217d5f) +* [count](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1a53be79855251a6bd40bd71f35c4f6d8d) +* [item](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1a1fdee032bf053c5f99b0291bf04dcaec) +* [Remove](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1ae838217b346390c972f8173e9a55361c) +* [setExportToRemoteComponents](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters_1ad479e08f0fcaf6313a005c4fb3c80235) + +## Properties + + +### Property count + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IGlobalParameters::count +``` + + + +The count of the name/value pairs. + + + +**Return type**: long + + +### Property item + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6451) + +``` +VARIANT ModelCenter::IGlobalParameters::item +``` + + + +Receives the value of a particular parameter. + + + + + + +**Parameters**: + +* **index**: The name of the name/value pair to retrieve. + + +**Returns**: + +The value of the parameter. + +Receives the value of a particular parameter. + + + + + + +**Parameters**: + +* **index**: The name of the name/value pair to retrieve. +* **newValue**: The variable to hold the value of the parameter. + + + +**Return type**: VARIANT + + +### Property \_item + +![][private] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6460) + +``` +VARIANT ModelCenter::IGlobalParameters::_item +``` + + + + + + + +**Return type**: VARIANT + +## Public functions + + +### Function setExportToRemoteComponents + +![][public] + +``` +void ModelCenter::IGlobalParameters::setExportToRemoteComponents(VARIANT index, boolean bexport) +``` + + + +Sets whether this name/value pair is passed to external servers when a component is run on that server. + + + + + + +**Parameters**: + +* **index**: The name of the variable. +* **bexport**: If true, this name/value pair will be sent. + + + +**Parameters**: + +* VARIANT **index** +* boolean **bexport** + +**Return type**: void + + +### Function Remove + +![][public] + +``` +void ModelCenter::IGlobalParameters::Remove(VARIANT index) +``` + + + +Removes a named parameter. + + + + + + +**Parameters**: + +* **index**: The name of the parameter to remove. + + + +**Parameters**: + +* VARIANT **index** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IGroup.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IGroup.md index d9dcf3bb08..ba57803451 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IGroup.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IGroup.md @@ -1,154 +1,153 @@ - -# Interface ModelCenter::IGroup - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3126) - - - -COM Instance. - -## Members - -* [getFullName](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1ab1dc7ab3547d2631e64f683968bd0989) -* [getName](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1ae9bccfbc2ecd401d1f1403594c0ff513) -* [Groups](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1afab9254fdafc011806a8834430af982f) -* [iconID](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1ab263da951c24595b88adc5b86fe93540) -* [Variables](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1a6e92dee614068ff99c03164e7305119a) - -## Properties - - -### Property Variables - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IGroup::Variables -``` - - - -Pointer to the variables in the Group. - - - - - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Return type**: VARIANT - - -### Property Groups - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IGroup::Groups -``` - - - -Pointer to the Groups in the Group. - - - - - - -**Returns**: - -IDispatch* to an [IGroups](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups) object. - - - -**Return type**: VARIANT - - -### Property iconID - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -int ModelCenter::IGroup::iconID -``` - - - -The ID number of the icon to use for the Group. - - - -**Return type**: int - -## Public functions - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IGroup::getName() -``` - - - -Gets the name of the Group. - - - - - - -**Returns**: - -The name of the Group. - - - -**Return type**: BSTR - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IGroup::getFullName() -``` - - - -Gets the full ModelCenter path of the Group. - - - - - - -**Returns**: - -The full ModelCenter path of the Group. - - - -**Return type**: BSTR - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IGroup + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3126) + + + +COM Instance. + +## Members + +* [getFullName](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1ab1dc7ab3547d2631e64f683968bd0989) +* [getName](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1ae9bccfbc2ecd401d1f1403594c0ff513) +* [Groups](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1afab9254fdafc011806a8834430af982f) +* [iconID](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1ab263da951c24595b88adc5b86fe93540) +* [Variables](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup_1a6e92dee614068ff99c03164e7305119a) + +## Properties + + +### Property Variables + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IGroup::Variables +``` + + + +Pointer to the variables in the Group. + + + + + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Return type**: VARIANT + + +### Property Groups + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IGroup::Groups +``` + + + +Pointer to the Groups in the Group. + + + + + + +**Returns**: + +IDispatch* to an [IGroups](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups) object. + + + +**Return type**: VARIANT + + +### Property iconID + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +int ModelCenter::IGroup::iconID +``` + + + +The ID number of the icon to use for the Group. + + + +**Return type**: int + +## Public functions + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IGroup::getName() +``` + + + +Gets the name of the Group. + + + + + + +**Returns**: + +The name of the Group. + + + +**Return type**: BSTR + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IGroup::getFullName() +``` + + + +Gets the full ModelCenter path of the Group. + + + + + + +**Returns**: + +The full ModelCenter path of the Group. + + + +**Return type**: BSTR + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IGroups.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IGroups.md index f58db6389e..365ad6c313 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IGroups.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IGroups.md @@ -1,78 +1,77 @@ - -# Interface ModelCenter::IGroups - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3171) - - - -COM Instance. - -## Members - -* [Count](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups_1a3bbbf56f26f76f5f051ea065aaf00234) -* [Item](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups_1a4a71e44eeb916bcdc8bee4ab891b237d) - -## Properties - - -### Property Count - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IGroups::Count -``` - - - -Number of Groups. - - - -**Return type**: VARIANT - -## Public functions - - -### Function Item - -![][public] - -``` -VARIANT ModelCenter::IGroups::Item(VARIANT id) -``` - - - -Gets a pointer to the specified Group. - - - - - - -**Parameters**: - -* **id**: ID of the specified Group. It can be a name or an index (0-based index). - - -**Returns**: - -IDispatch* to an [IGroup](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup) object. - - - -**Parameters**: - -* VARIANT **id** - -**Return type**: VARIANT - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IGroups + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3171) + + + +COM Instance. + +## Members + +* [Count](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups_1a3bbbf56f26f76f5f051ea065aaf00234) +* [Item](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups_1a4a71e44eeb916bcdc8bee4ab891b237d) + +## Properties + + +### Property Count + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IGroups::Count +``` + + + +Number of Groups. + + + +**Return type**: VARIANT + +## Public functions + + +### Function Item + +![][public] + +``` +VARIANT ModelCenter::IGroups::Item(VARIANT id) +``` + + + +Gets a pointer to the specified Group. + + + + + + +**Parameters**: + +* **id**: ID of the specified Group. It can be a name or an index (0-based index). + + +**Returns**: + +IDispatch* to an [IGroup](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup) object. + + + +**Parameters**: + +* VARIANT **id** + +**Return type**: VARIANT + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IIfComponent.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IIfComponent.md index acee4b0f98..46af12e10b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IIfComponent.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IIfComponent.md @@ -1,764 +1,763 @@ - -# Interface ModelCenter::IIfComponent - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1293) - - - -COM Instance. - -**Inherits from**: - -* [ModelCenter::IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) - -## Members - -* [AssociatedFiles](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1afeeaebcaeafab038e2cc613078182c6e) -* [downloadValues](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a610d24ca2e023e09194b29c3115c6d84) -* [exclusive](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae32fcb5e2bd27ce4317da67ea515d40f) -* [getBranchCondition](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a0a01eb7fd3513f7754534c229ef4da08) -* [getBranchName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1acd033bea89f3ba1ec760d9ad2c47d0ed) -* [getFullName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a5766e80ec09baf80e3ad7c28e4dd3bd4) -* [getMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a2bd6e585619f4cd76426932b62dcf60a) -* [getName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a97c817507e162f9422b2f73ab5c8cef1) -* [getNumBranches](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a667215e89aa8d7b6ff584ce7c2a9e566) -* [getPositionX](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a205b99507e64a1ad621ee6aeb6cd6d0c) -* [getPositionY](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6cddb9b21c6b3b60a23f2a28d60ea17a) -* [getSource](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae4cad8560e705e807f793a2dade750e2) -* [getType](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a9cbf40ea5229f4240bdb241e8d88329c) -* [getVariable](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1af46fd2a7e5dda89d73e347b2fff75d16) -* [Groups](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a491cb2ba622f73c3338ebbbe92e9da3d) -* [IndexInParent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a5c8b1a2d576bbdc2ea74f70b499889e0) -* [invalidate](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a78101d039853db9e2d989edef97f226b) -* [invokeMethod](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a583b809498c69beadd39c1e21e2cebab) -* [ParentAssembly](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae19efd7aa8ec8a537e3de7234b41ebde) -* [reconnect](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a67e294fa372905721460635514adcd35) -* [rename](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae64ae2e0082f2379391e6a49d5e57192) -* [renameBranch](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1afddf16459949f862d3329e2d6eb79bb2) -* [run](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a7891e5012feff9e7bbdec3bde6adb8e6) -* [runLastBranchByDefault](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6b9474faac3cad28e1a5d156438141a0) -* [setBranchCondition](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1af539f83e9e44adfccbff2968cfdb3f39) -* [setMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a41eb816b08e0e89739822ba87e5416c6) -* [show](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a344fe33286c0d548dfb35b472cfcc1d6) -* [userData](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6590d1a787dc12285407656bfc22cbd7) -* [Variables](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a377c50131d329f7fe0e1508bafff61dc) - -## Properties - - -### Property Variables - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IIfComponent::Variables -``` - - - - - - - -**Return type**: VARIANT - - -### Property Groups - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IIfComponent::Groups -``` - - - - - - - -**Return type**: VARIANT - - -### Property userData - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IIfComponent::userData -``` - - - - - - - -**Return type**: VARIANT - - -### Property AssociatedFiles - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IIfComponent::AssociatedFiles -``` - - - - - - - -**Return type**: VARIANT - - -### Property IndexInParent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -int ModelCenter::IIfComponent::IndexInParent -``` - - - - - - - -**Return type**: int - - -### Property ParentAssembly - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IIfComponent::ParentAssembly -``` - - - - - - - -**Return type**: LPDISPATCH - - -### Property exclusive - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IIfComponent::exclusive -``` - - - -The If exclusive mode. - - - - - - -**Returns**: - -Yes (TRUE) or no (FALSE). - - - -**Return type**: boolean - - -### Property runLastBranchByDefault - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IIfComponent::runLastBranchByDefault -``` - - - -The "has default" flag. - - - - - - -**Returns**: - -YES (TRUE) or no (FALSE). - - - -**Return type**: boolean - -## Public functions - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IIfComponent::getName() -``` - - - -Gets the name of the Component. - - - - - - -**Returns**: - -The name of the Component. - - - -**Return type**: BSTR - -**Reimplements**: [getName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a19763f04596904ff5cab2f4f72f6f501) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IIfComponent::getFullName() -``` - - - -Gets the full [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) path of the Component. - - - - - - -**Returns**: - -the full ModelCenter path of the Component. - - - -**Return type**: BSTR - -**Reimplements**: [getFullName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9309a89032b2d7d28baf279a3b76b5e8) - - -### Function run - -![][public] - -``` -void ModelCenter::IIfComponent::run() -``` - - - -Runs the Component. - - - -**Return type**: void - -**Reimplements**: [run](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1adf60ad0c84852250f14d27cfa689d8d0) - - -### Function getSource - -![][public] - -``` -BSTR ModelCenter::IIfComponent::getSource() -``` - - - -Gets the source of the Component. - - - - - - -**Returns**: - -The source of the Component. - - - -**Return type**: BSTR - -**Reimplements**: [getSource](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a7ee6752f95f3bdfbe83132a3a7794cb2) - - -### Function invokeMethod - -![][public] - -``` -void ModelCenter::IIfComponent::invokeMethod(BSTR method) -``` - - - -Invokes one of the Component's methods. - - - - - - -**Parameters**: - -* **method**: The name of the method to invoke. - - - -**Parameters**: - -* BSTR **method** - -**Return type**: void - -**Reimplements**: [invokeMethod](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afaddb2c21be03b26716594af883a51ee) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IIfComponent::invalidate() -``` - - - -Invalidates the Component and all of its variables. - - - -**Return type**: void - -**Reimplements**: [invalidate](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a73c230184c72f5abcb7d3af5f91c9d1e) - - -### Function reconnect - -![][public] - -``` -void ModelCenter::IIfComponent::reconnect() -``` - - - -Reconnect a Component. - - - -**Return type**: void - -**Reimplements**: [reconnect](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a44d641cc9d4a797f88e56495c466479c) - - -### Function downloadValues - -![][public] - -``` -void ModelCenter::IIfComponent::downloadValues() -``` - - - -Downloads the component's variable values from [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) Remote Execution, if it's a MCRE component. - - - -**Return type**: void - -**Reimplements**: [downloadValues](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a761c665246557b5b4201873a722d6fed) - - -### Function getVariable - -![][public] - -``` -LPDISPATCH ModelCenter::IIfComponent::getVariable(BSTR name) -``` - - - -Gets the Variable by the specified name. - - - - - - -**Parameters**: - -* **name**: The name of the variable to retrieve in dotted notation relative to the Component. - - -**Returns**: - -IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: LPDISPATCH - -**Reimplements**: [getVariable](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afb270ae53383589c63f87b4e3385f128) - - -### Function getPositionX - -![][public] - -``` -int ModelCenter::IIfComponent::getPositionX() -``` - - - -Gets the X position of the component in the Analysis View. - - - - - - -**Returns**: - -The X position. - - - -**Return type**: int - -**Reimplements**: [getPositionX](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a0c3e0c952584ba25801114e01010eab0) - - -### Function getPositionY - -![][public] - -``` -int ModelCenter::IIfComponent::getPositionY() -``` - - - -Gets the Y position of the component in the Analysis View. - - - - - - -**Returns**: - -The Y position. - - - -**Return type**: int - -**Reimplements**: [getPositionY](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1ad3da2b98a973112ea897cf3b146f0276) - - -### Function rename - -![][public] - -``` -void ModelCenter::IIfComponent::rename(BSTR name) -``` - - - -Renames the current Component. - - - - - - -**Parameters**: - -* **name**: New name of the Component. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: void - -**Reimplements**: [rename](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9cae71e48e01e94d48c0353d3db4d90c) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IIfComponent::getType() -``` - - - -Gets the type of the component. Valid types include: -* Component - -* Assembly - -* Sequence - -* If - -* Parallel - -* Empty - -* ForEach - - - - - - - - -**Returns**: - -The type of the component. - - - -**Return type**: BSTR - -**Reimplements**: [getType](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a04395c5a8d6ceff26ae08e6c001bdd45) - - -### Function show - -![][public] - -``` -void ModelCenter::IIfComponent::show() -``` - - - -Show the GUI form associated with the component, if any. - - - -**Return type**: void - -**Reimplements**: [show](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aa35c0fb45f677b3c2daf475e53107773) - - -### Function getNumBranches - -![][public] - -``` -int ModelCenter::IIfComponent::getNumBranches() -``` - - - -Gets the number of branches. - - - - - - -**Returns**: - -The number of branches. - - - -**Return type**: int - - -### Function getBranchCondition - -![][public] - -``` -BSTR ModelCenter::IIfComponent::getBranchCondition(int index) -``` - - - -Gets the branch condition. - - - - - - -**Parameters**: - -* **index**: Index of the branch. - - -**Returns**: - -The branch condition. - - - -**Parameters**: - -* int **index** - -**Return type**: BSTR - - -### Function setBranchCondition - -![][public] - -``` -void ModelCenter::IIfComponent::setBranchCondition(int index, BSTR condition) -``` - - - -Sets the branch condition. - - - - - - -**Parameters**: - -* **index**: Index of the branch. -* **condition**: The new condition. - - - -**Parameters**: - -* int **index** -* BSTR **condition** - -**Return type**: void - - -### Function getBranchName - -![][public] - -``` -BSTR ModelCenter::IIfComponent::getBranchName(int index) -``` - - - -Returns the name of the branch. - - - - - - -**Parameters**: - -* **index**: Index of the branch. - - -**Returns**: - -The name of the branch. - - - -**Parameters**: - -* int **index** - -**Return type**: BSTR - - -### Function renameBranch - -![][public] - -``` -void ModelCenter::IIfComponent::renameBranch(int index, BSTR name) -``` - - - -Renames the branch to the given name. - - - - - - -**Parameters**: - -* **index**: Index of the branch. -* **name**: New name of the branch. - - - -**Parameters**: - -* int **index** -* BSTR **name** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IIfComponent + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1293) + + + +COM Instance. + +**Inherits from**: + +* [ModelCenter::IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) + +## Members + +* [AssociatedFiles](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1afeeaebcaeafab038e2cc613078182c6e) +* [downloadValues](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a610d24ca2e023e09194b29c3115c6d84) +* [exclusive](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae32fcb5e2bd27ce4317da67ea515d40f) +* [getBranchCondition](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a0a01eb7fd3513f7754534c229ef4da08) +* [getBranchName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1acd033bea89f3ba1ec760d9ad2c47d0ed) +* [getFullName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a5766e80ec09baf80e3ad7c28e4dd3bd4) +* [getMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a2bd6e585619f4cd76426932b62dcf60a) +* [getName](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a97c817507e162f9422b2f73ab5c8cef1) +* [getNumBranches](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a667215e89aa8d7b6ff584ce7c2a9e566) +* [getPositionX](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a205b99507e64a1ad621ee6aeb6cd6d0c) +* [getPositionY](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6cddb9b21c6b3b60a23f2a28d60ea17a) +* [getSource](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae4cad8560e705e807f793a2dade750e2) +* [getType](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a9cbf40ea5229f4240bdb241e8d88329c) +* [getVariable](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1af46fd2a7e5dda89d73e347b2fff75d16) +* [Groups](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a491cb2ba622f73c3338ebbbe92e9da3d) +* [IndexInParent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a5c8b1a2d576bbdc2ea74f70b499889e0) +* [invalidate](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a78101d039853db9e2d989edef97f226b) +* [invokeMethod](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a583b809498c69beadd39c1e21e2cebab) +* [ParentAssembly](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae19efd7aa8ec8a537e3de7234b41ebde) +* [reconnect](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a67e294fa372905721460635514adcd35) +* [rename](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1ae64ae2e0082f2379391e6a49d5e57192) +* [renameBranch](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1afddf16459949f862d3329e2d6eb79bb2) +* [run](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a7891e5012feff9e7bbdec3bde6adb8e6) +* [runLastBranchByDefault](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6b9474faac3cad28e1a5d156438141a0) +* [setBranchCondition](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1af539f83e9e44adfccbff2968cfdb3f39) +* [setMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a41eb816b08e0e89739822ba87e5416c6) +* [show](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a344fe33286c0d548dfb35b472cfcc1d6) +* [userData](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a6590d1a787dc12285407656bfc22cbd7) +* [Variables](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent_1a377c50131d329f7fe0e1508bafff61dc) + +## Properties + + +### Property Variables + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IIfComponent::Variables +``` + + + + + + + +**Return type**: VARIANT + + +### Property Groups + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IIfComponent::Groups +``` + + + + + + + +**Return type**: VARIANT + + +### Property userData + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IIfComponent::userData +``` + + + + + + + +**Return type**: VARIANT + + +### Property AssociatedFiles + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IIfComponent::AssociatedFiles +``` + + + + + + + +**Return type**: VARIANT + + +### Property IndexInParent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +int ModelCenter::IIfComponent::IndexInParent +``` + + + + + + + +**Return type**: int + + +### Property ParentAssembly + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IIfComponent::ParentAssembly +``` + + + + + + + +**Return type**: LPDISPATCH + + +### Property exclusive + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IIfComponent::exclusive +``` + + + +The If exclusive mode. + + + + + + +**Returns**: + +Yes (TRUE) or no (FALSE). + + + +**Return type**: boolean + + +### Property runLastBranchByDefault + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IIfComponent::runLastBranchByDefault +``` + + + +The "has default" flag. + + + + + + +**Returns**: + +YES (TRUE) or no (FALSE). + + + +**Return type**: boolean + +## Public functions + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IIfComponent::getName() +``` + + + +Gets the name of the Component. + + + + + + +**Returns**: + +The name of the Component. + + + +**Return type**: BSTR + +**Reimplements**: [getName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a19763f04596904ff5cab2f4f72f6f501) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IIfComponent::getFullName() +``` + + + +Gets the full [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) path of the Component. + + + + + + +**Returns**: + +the full ModelCenter path of the Component. + + + +**Return type**: BSTR + +**Reimplements**: [getFullName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9309a89032b2d7d28baf279a3b76b5e8) + + +### Function run + +![][public] + +``` +void ModelCenter::IIfComponent::run() +``` + + + +Runs the Component. + + + +**Return type**: void + +**Reimplements**: [run](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1adf60ad0c84852250f14d27cfa689d8d0) + + +### Function getSource + +![][public] + +``` +BSTR ModelCenter::IIfComponent::getSource() +``` + + + +Gets the source of the Component. + + + + + + +**Returns**: + +The source of the Component. + + + +**Return type**: BSTR + +**Reimplements**: [getSource](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a7ee6752f95f3bdfbe83132a3a7794cb2) + + +### Function invokeMethod + +![][public] + +``` +void ModelCenter::IIfComponent::invokeMethod(BSTR method) +``` + + + +Invokes one of the Component's methods. + + + + + + +**Parameters**: + +* **method**: The name of the method to invoke. + + + +**Parameters**: + +* BSTR **method** + +**Return type**: void + +**Reimplements**: [invokeMethod](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afaddb2c21be03b26716594af883a51ee) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IIfComponent::invalidate() +``` + + + +Invalidates the Component and all of its variables. + + + +**Return type**: void + +**Reimplements**: [invalidate](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a73c230184c72f5abcb7d3af5f91c9d1e) + + +### Function reconnect + +![][public] + +``` +void ModelCenter::IIfComponent::reconnect() +``` + + + +Reconnect a Component. + + + +**Return type**: void + +**Reimplements**: [reconnect](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a44d641cc9d4a797f88e56495c466479c) + + +### Function downloadValues + +![][public] + +``` +void ModelCenter::IIfComponent::downloadValues() +``` + + + +Downloads the component's variable values from [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) Remote Execution, if it's a MCRE component. + + + +**Return type**: void + +**Reimplements**: [downloadValues](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a761c665246557b5b4201873a722d6fed) + + +### Function getVariable + +![][public] + +``` +LPDISPATCH ModelCenter::IIfComponent::getVariable(BSTR name) +``` + + + +Gets the Variable by the specified name. + + + + + + +**Parameters**: + +* **name**: The name of the variable to retrieve in dotted notation relative to the Component. + + +**Returns**: + +IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: LPDISPATCH + +**Reimplements**: [getVariable](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afb270ae53383589c63f87b4e3385f128) + + +### Function getPositionX + +![][public] + +``` +int ModelCenter::IIfComponent::getPositionX() +``` + + + +Gets the X position of the component in the Analysis View. + + + + + + +**Returns**: + +The X position. + + + +**Return type**: int + +**Reimplements**: [getPositionX](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a0c3e0c952584ba25801114e01010eab0) + + +### Function getPositionY + +![][public] + +``` +int ModelCenter::IIfComponent::getPositionY() +``` + + + +Gets the Y position of the component in the Analysis View. + + + + + + +**Returns**: + +The Y position. + + + +**Return type**: int + +**Reimplements**: [getPositionY](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1ad3da2b98a973112ea897cf3b146f0276) + + +### Function rename + +![][public] + +``` +void ModelCenter::IIfComponent::rename(BSTR name) +``` + + + +Renames the current Component. + + + + + + +**Parameters**: + +* **name**: New name of the Component. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: void + +**Reimplements**: [rename](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9cae71e48e01e94d48c0353d3db4d90c) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IIfComponent::getType() +``` + + + +Gets the type of the component. Valid types include: +* Component + +* Assembly + +* Sequence + +* If + +* Parallel + +* Empty + +* ForEach + + + + + + + + +**Returns**: + +The type of the component. + + + +**Return type**: BSTR + +**Reimplements**: [getType](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a04395c5a8d6ceff26ae08e6c001bdd45) + + +### Function show + +![][public] + +``` +void ModelCenter::IIfComponent::show() +``` + + + +Show the GUI form associated with the component, if any. + + + +**Return type**: void + +**Reimplements**: [show](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aa35c0fb45f677b3c2daf475e53107773) + + +### Function getNumBranches + +![][public] + +``` +int ModelCenter::IIfComponent::getNumBranches() +``` + + + +Gets the number of branches. + + + + + + +**Returns**: + +The number of branches. + + + +**Return type**: int + + +### Function getBranchCondition + +![][public] + +``` +BSTR ModelCenter::IIfComponent::getBranchCondition(int index) +``` + + + +Gets the branch condition. + + + + + + +**Parameters**: + +* **index**: Index of the branch. + + +**Returns**: + +The branch condition. + + + +**Parameters**: + +* int **index** + +**Return type**: BSTR + + +### Function setBranchCondition + +![][public] + +``` +void ModelCenter::IIfComponent::setBranchCondition(int index, BSTR condition) +``` + + + +Sets the branch condition. + + + + + + +**Parameters**: + +* **index**: Index of the branch. +* **condition**: The new condition. + + + +**Parameters**: + +* int **index** +* BSTR **condition** + +**Return type**: void + + +### Function getBranchName + +![][public] + +``` +BSTR ModelCenter::IIfComponent::getBranchName(int index) +``` + + + +Returns the name of the branch. + + + + + + +**Parameters**: + +* **index**: Index of the branch. + + +**Returns**: + +The name of the branch. + + + +**Parameters**: + +* int **index** + +**Return type**: BSTR + + +### Function renameBranch + +![][public] + +``` +void ModelCenter::IIfComponent::renameBranch(int index, BSTR name) +``` + + + +Renames the branch to the given name. + + + + + + +**Parameters**: + +* **index**: Index of the branch. +* **name**: New name of the branch. + + + +**Parameters**: + +* int **index** +* BSTR **name** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IIntegerArray.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IIntegerArray.md index 29c7193584..168c9d51a7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IIntegerArray.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IIntegerArray.md @@ -1,1654 +1,1653 @@ - -# Interface ModelCenter::IIntegerArray - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3201) - - - -COM Instance - -**Inherits from**: - -* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) - -## Members - -* [autoSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aca63a47369d69cbbf53532286b64a611) -* [clearLowerBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ab51bcc939e91ef1da288c78be99a7fcc) -* [clearUpperBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1aa3f1505493e089a8717c092e37927600) -* [dependentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a399b9b49ca3133d2a49923637f19609a) -* [dependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af6712999aa6e50091a95dd66db088661) -* [description](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a9933e6b9d3328cf70f35075b8556e8ab) -* [directDependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a44b3a3cc73cd46ea7661e776b20b4ded) -* [directPrecedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae3879cd50b0512f2b5660765393bd24e) -* [enumAliases](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ade7b31cc762cc412e399fff92260fb99) -* [enumValues](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5d823185c095e0c48f696a8ec27a78cb) -* [format](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ad328109c650cbcc2ca8cf08b688de6af) -* [fromFormattedStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a9a6ac88dcfe81e7651c7cc5d15e4bf59) -* [fromString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af3d5cd8601c1227d439b7b3f74cc2d16) -* [fromStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a26f9cfd27774a2233ae2cb232cc8fec9) -* [getArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5e233233ced66879ff8aa58832981a7d) -* [getDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a83abe70ccf5e8a0a582748d84e3d7956) -* [getFullName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a8c74276fefc00a8b85a576e1d1b58053) -* [getLength](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a8167ef387b9cc11bc76e9a0e0694a833) -* [getMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a76933c6f159d52907c0b9f6ba3d13136) -* [getName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a79fdcc3e290b4b0df816f69d8a8d5f9d) -* [getSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a3d171136e0b219dd4e2d0d1b4bb9aa1f) -* [getType](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a05e311dcfb051f0df6afc99dd01d6773) -* [getValue](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1addb4d3f364f0f952a6341b52616bb0cd) -* [getValueAbsolute](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a7c1be797998fc344c26e23ce85d9057d) -* [hasChanged](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a117efbea02cce1afa842341cf3e70bae) -* [hasLowerBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a37a15ea329f97b885f57b2660f8cf519) -* [hasUpperBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a4b31b367d82c30fef71bd2412482c25f) -* [hide](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5f571b35a242ad8260a3380f75ec5acf) -* [invalidate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a521514c594a1ab4e30669305585530b7) -* [isInput](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a3752394336c9689384efac1005422431) -* [isInputToComponent](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a2a19aa7ca1e4c4fb862016aede378c05) -* [isInputToModel](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a41c321c0260174a4c118e309fbd13085) -* [isValid](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ab3d891c3978182e073923a56b4dbe89b) -* [length](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af118bdf4b120050d6700a7ceae7f5bec) -* [lowerBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ad38b7c1cfa620446572595dba1b607f6) -* [numDimensions](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a7b259767761bcb4f84893a2f8baaa139) -* [OwningComponent](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a9d3e429a72048e669d3e37f814294828) -* [precedentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ac71c9a184e57f627b336438de0b7a238) -* [precedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a01bd8fce84abbb243a9f7e3c771c185c) -* [setArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a89811fdbf06146c4bf0b14ea099df689) -* [setDimensions](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a1010ee85bb6325b98fab48f96b582103) -* [setLength](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a91d122341cefcb887c3871d43ea34524) -* [setMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae69f586d5f6a7cf93728f99a47b841cf) -* [setSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b7b41ca5463a86aecb2368d73464c0e) -* [setValue](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a18caa8754a18f914632f71675d6821dd) -* [size](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a49fc48bf1f28f403f2b96b92fb8e5819) -* [toFormattedStringAbsoluteEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a7a0ff2e8e1875ee5465deadb6496b81c) -* [toFormattedStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a895cc520f94cb105b922380b105f448d) -* [toString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a83e5e9905df758b37c901bae5e87430e) -* [toStringAbsolute](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5bc139ce096dbc917734386869a3be78) -* [toStringAbsoluteEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5794b0c172b46da36d761bf31046db07) -* [toStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae3d6633e9533a68590025dee14298912) -* [units](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1afe8daf819657e592587af96079b0a0a9) -* [upperBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a1a062cc1750c92e8db32de2b53d83e9a) -* [validate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a84ab133f5b1147d475fb8e2c4275b32b) -* [value](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1aa7b9346ccbe5c4088c45e09ffb8b7d02) -* [value](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a2b4b654f1094bfd632e383909ea37bad) - -## Properties - - -### Property hasChanged - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IIntegerArray::hasChanged -``` - - - - - - - -**Return type**: boolean - - -### Property hide - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IIntegerArray::hide -``` - - - - - - - -**Return type**: boolean - - -### Property OwningComponent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IIntegerArray::OwningComponent -``` - - - - - - - -**Return type**: LPDISPATCH - - -### Property size - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IIntegerArray::size -``` - - - - - - - -**Return type**: long - - -### Property numDimensions - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IIntegerArray::numDimensions -``` - - - - - - - -**Return type**: long - - -### Property lowerBound - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IIntegerArray::lowerBound -``` - - - -Lower bound of the array. - - - -**Return type**: long - - -### Property upperBound - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IIntegerArray::upperBound -``` - - - -Upper bound of the array. - - - -**Return type**: long - - -### Property description - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IIntegerArray::description -``` - - - -Description of the array. - - - -**Return type**: BSTR - - -### Property units - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IIntegerArray::units -``` - - - -Units of the array. - - - -**Return type**: BSTR - - -### Property enumAliases - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IIntegerArray::enumAliases -``` - - - -Enumerated aliases of the array. - - - -**Return type**: BSTR - - -### Property enumValues - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IIntegerArray::enumValues -``` - - - -Enumerated values of the array. - - - -**Return type**: BSTR - - -### Property format - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IIntegerArray::format -``` - - - -Format of the variable. - - - -**Return type**: BSTR - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3309) - -``` -VARIANT ModelCenter::IIntegerArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9) -``` - - - -Get the value of an array element. - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - -**Returns**: - -The value. - - - -**Return type**: VARIANT - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3325) - -``` -long ModelCenter::IIntegerArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9,[optional] VARIANT d10) -``` - - - -Sets the value of an array element. - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). -* **newValue**: New value. - - - -**Return type**: long - -## Public functions - - -### Function isValid - -![][public] - -``` -boolean ModelCenter::IIntegerArray::isValid() -``` - - - -Finds out whether or not the array is valid. - - - - - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Return type**: boolean - -**Reimplements**: [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) - - -### Function validate - -![][public] - -``` -void ModelCenter::IIntegerArray::validate() -``` - - - -Causes the array to validate itself. - - - -**Return type**: void - -**Reimplements**: [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IIntegerArray::getName() -``` - - - -Gets the name of the array. - - - - - - -**Returns**: - -The name of the array. - - - -**Return type**: BSTR - -**Reimplements**: [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IIntegerArray::getFullName() -``` - - - -Gets the full ModelCenter path of the array. - - - - - - -**Returns**: - -The full ModelCenter path of the array. - - - -**Return type**: BSTR - -**Reimplements**: [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IIntegerArray::getType() -``` - - - -Gets the type of the array. - - - - - - -**Returns**: - -The type of the array as a string. - - - -**Return type**: BSTR - -**Reimplements**: [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) - - -### Function isInput - -![][public] - -``` -boolean ModelCenter::IIntegerArray::isInput() -``` - - - -Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a41c321c0260174a4c118e309fbd13085). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) - - -### Function toString - -![][public] - -``` -BSTR ModelCenter::IIntegerArray::toString() -``` - - - -Converts the array to a string, validating the array if necessary. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. - - - - - - -**Returns**: - -The converted string value of the array. - - - -**Return type**: BSTR - -**Reimplements**: [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) - - -### Function fromString - -![][public] - -``` -void ModelCenter::IIntegerArray::fromString(BSTR value) -``` - - - -Sets the value of the array from a specified string. For 1D arrays, the specification is of the form '1,2,3'.
-For nD arrays, the specification is of the form 'bounds[2,2,2] {1,2,3,4,5,6,7,8}'.
-String arrays may optionally have the elements quoted in the form 'bounds[2,3] {"a", "b,c", "d", "", "e", "f"}' - - - - - - -**Parameters**: - -* **value**: New value. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - -**Reimplements**: [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) - - -### Function toStringAbsolute - -![][public] - -``` -BSTR ModelCenter::IIntegerArray::toStringAbsolute() -``` - - - -Converts the array to a string. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. - - - - - - -**Returns**: - -The converted string value of the array. - - - -**Return type**: BSTR - -**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IIntegerArray::invalidate() -``` - - - -Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. - - - -**Return type**: void - -**Reimplements**: [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) - - -### Function directPrecedents - -![][public] - -``` -LPDISPATCH ModelCenter::IIntegerArray::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) - - -### Function directDependents - -![][public] - -``` -LPDISPATCH ModelCenter::IIntegerArray::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) - - -### Function precedentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IIntegerArray::precedentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) - - -### Function dependentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IIntegerArray::dependentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) - - -### Function precedents - -![][public] - -``` -LPDISPATCH ModelCenter::IIntegerArray::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) - - -### Function dependents - -![][public] - -``` -LPDISPATCH ModelCenter::IIntegerArray::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) - - -### Function isInputToComponent - -![][public] - -``` -boolean ModelCenter::IIntegerArray::isInputToComponent() -``` - - - -Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) - - -### Function isInputToModel - -![][public] - -``` -boolean ModelCenter::IIntegerArray::isInputToModel() -``` - - - -Checks whether or not the variable is an input. A linked input returns false (Output). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) - - -### Function setMetadata - -![][public] - -``` -void ModelCenter::IIntegerArray::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) -``` - - - -Sets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata specifier used to store the data. -* **type**:
-* **value**:
-* **access**:
-* **archive**:
- - - -**Parameters**: - -* BSTR **name** -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** -* VARIANT **value** -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** -* boolean **archive** - -**Return type**: void - -**Reimplements**: [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) - - -### Function getMetadata - -![][public] - -``` -VARIANT ModelCenter::IIntegerArray::getMetadata(BSTR name) -``` - - - -Gets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata key name. - - -**Returns**: - -Metadata value. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -**Reimplements**: [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) - - -### Function toStringEx - -![][public] - -``` -BSTR ModelCenter::IIntegerArray::toStringEx(long index) -``` - - - -Converts the value of an array element to a string, validating the array if necessary. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The value of the element as a string. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - -**Reimplements**: [toStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a37c622ae9f50579f714ce98c0379cd98) - - -### Function fromStringEx - -![][public] - -``` -void ModelCenter::IIntegerArray::fromStringEx(BSTR value, long index) -``` - - - -Sets the value of an array element from a specified string. - - - - - - -**Parameters**: - -* **value**: New value. -* **index**: Index of the array element (0-based index). - - - -**Parameters**: - -* BSTR **value** -* long **index** - -**Return type**: void - -**Reimplements**: [fromStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad23f4082662c464be07251d6d1695a2d) - - -### Function toStringAbsoluteEx - -![][public] - -``` -BSTR ModelCenter::IIntegerArray::toStringAbsoluteEx(long index) -``` - - - -Converts the value of an array element to a string. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The value of the element as a string. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - -**Reimplements**: [toStringAbsoluteEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a2e3041440581aab716c684fe88d2ee87) - - -### Function getLength - -![][public] - -``` -long ModelCenter::IIntegerArray::getLength([optional] VARIANT dim) -``` - - - -Get the length of the n'th dimension of the array. - - - - - - -**Parameters**: - -* **dim**: Dimension of the array to query. This uses a 0 based index, so 0 will give you the first dimension, 1 the second, etc. If omitted, gives the first dimension - - -**Returns**: - -Length(size) of the array. - - - -**Parameters**: - -* _[optional]_ VARIANT **dim** - -**Return type**: long - -**Reimplements**: [getLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) - - -### Function setLength - -![][public] - -``` -void ModelCenter::IIntegerArray::setLength(long length, [optional] VARIANT dim) -``` - - - -Sets the length of the n'th dimension of the array - - - - - - -**Parameters**: - -* **length**: New length of the n'th dimension of the array -* **dim**: The dimension to set. This uses a 0 based index, so 0 will set the first dimension, 1 the second, etc. If omitted, sets the first dimension - - - -**Parameters**: - -* long **length** -* _[optional]_ VARIANT **dim** - -**Return type**: void - -**Reimplements**: [setLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) - - -### Function setDimensions - -![][public] - -``` -void ModelCenter::IIntegerArray::setDimensions(long d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Sets the number of dimensions of an array and the length of each dimension in one call. An array initializes to 0 length. If any dimension of the array has 0 length, the whole array contains no data. You must set the array size before filling in values unless you are using the [setArray()](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a89811fdbf06146c4bf0b14ea099df689) call. - - - - - - -**Parameters**: - -* **d1**: length of the 1st dimension of the array -* **d2**: length of the 2nd dimension of the array. If omitted, the array is 1 dimensional -* **d3**: length of the 3rd dimension of the array. If omitted, the array is 2 dimensional -* **d4**: length of the 4th dimension of the array. If omitted, the array is 3 dimensional -* **d5**: length of the 5th dimension of the array. If omitted, the array is 4 dimensional -* **d6**: length of the 6th dimension of the array. If omitted, the array is 5 dimensional -* **d7**: length of the 7th dimension of the array. If omitted, the array is 6 dimensional -* **d8**: length of the 8th dimension of the array. If omitted, the array is 7 dimensional -* **d9**: length of the 9th dimension of the array. If omitted, the array is 8 dimensional -* **d10**: length of the 10th dimension of the array. If omitted, the array is 9 dimensional - - - -**Parameters**: - -* long **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: void - -**Reimplements**: [setDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) - - -### Function hasLowerBound - -![][public] - -``` -boolean ModelCenter::IIntegerArray::hasLowerBound() -``` - - - -Whether or not the array has an lower bound. - - - - - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Return type**: boolean - - -### Function hasUpperBound - -![][public] - -``` -boolean ModelCenter::IIntegerArray::hasUpperBound() -``` - - - -Whether or not the array has an upper bound. - - - - - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Return type**: boolean - - -### Function getValue - -![][public] - -``` -long ModelCenter::IIntegerArray::getValue(VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Gets the value of an array element. - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - -**Returns**: - -The value. - - - -**Parameters**: - -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: long - - -### Function setValue - -![][public] - -``` -void ModelCenter::IIntegerArray::setValue(long value, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Sets the value of an array element. - - - - - - -**Parameters**: - -* **value**: New value. -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - - -**Parameters**: - -* long **value** -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: void - - -### Function getArray - -![][public] - -``` -VARIANT ModelCenter::IIntegerArray::getArray() -``` - - - -Gets the COM array. - - - - - - -**Returns**: - -The COM array. - - - -**Return type**: VARIANT - - -### Function setArray - -![][public] - -``` -void ModelCenter::IIntegerArray::setArray(VARIANT array) -``` - - - -Sets the COM array. - - - - - - -**Parameters**: - -* **array**: The COM array. - - - -**Parameters**: - -* VARIANT **array** - -**Return type**: void - - -### Function toFormattedStringEx - -![][public] - -``` -BSTR ModelCenter::IIntegerArray::toFormattedStringEx(long index) -``` - - - -Converts the value to a formatted string. - - - - - - -**Parameters**: - -* **index**: Position in the array (0-based index). - - -**Returns**: - -The formatted string. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - - -### Function fromFormattedStringEx - -![][public] - -``` -void ModelCenter::IIntegerArray::fromFormattedStringEx(BSTR value, long index) -``` - - - -Loads a formatted string. - - - - - - -**Parameters**: - -* **value**: Formatted value to load. -* **index**: Position in the array (0-based index). - - - -**Parameters**: - -* BSTR **value** -* long **index** - -**Return type**: void - - -### Function toFormattedStringAbsoluteEx - -![][public] - -``` -BSTR ModelCenter::IIntegerArray::toFormattedStringAbsoluteEx(long index) -``` - - - -Converts the value to an absolute formatted string. - - - - - - -**Parameters**: - -* **index**: Position in the array (0-based index). - - -**Returns**: - -The formatted string. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - - -### Function clearUpperBound - -![][public] - -``` -void ModelCenter::IIntegerArray::clearUpperBound() -``` - - - -Clears the upper bound property of the array if it has previously been set. - - - -**Return type**: void - - -### Function clearLowerBound - -![][public] - -``` -void ModelCenter::IIntegerArray::clearLowerBound() -``` - - - -Clears the lower bound property of the array if it has previously been set. - - - -**Return type**: void - - -### Function getValueAbsolute - -![][public] - -``` -long ModelCenter::IIntegerArray::getValueAbsolute(VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Gets the value of an array element without validating. - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - -**Returns**: - -The value. - - - -**Parameters**: - -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: long - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IIntegerArray + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3201) + + + +COM Instance + +**Inherits from**: + +* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) + +## Members + +* [autoSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aca63a47369d69cbbf53532286b64a611) +* [clearLowerBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ab51bcc939e91ef1da288c78be99a7fcc) +* [clearUpperBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1aa3f1505493e089a8717c092e37927600) +* [dependentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a399b9b49ca3133d2a49923637f19609a) +* [dependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af6712999aa6e50091a95dd66db088661) +* [description](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a9933e6b9d3328cf70f35075b8556e8ab) +* [directDependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a44b3a3cc73cd46ea7661e776b20b4ded) +* [directPrecedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae3879cd50b0512f2b5660765393bd24e) +* [enumAliases](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ade7b31cc762cc412e399fff92260fb99) +* [enumValues](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5d823185c095e0c48f696a8ec27a78cb) +* [format](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ad328109c650cbcc2ca8cf08b688de6af) +* [fromFormattedStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a9a6ac88dcfe81e7651c7cc5d15e4bf59) +* [fromString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af3d5cd8601c1227d439b7b3f74cc2d16) +* [fromStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a26f9cfd27774a2233ae2cb232cc8fec9) +* [getArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5e233233ced66879ff8aa58832981a7d) +* [getDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a83abe70ccf5e8a0a582748d84e3d7956) +* [getFullName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a8c74276fefc00a8b85a576e1d1b58053) +* [getLength](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a8167ef387b9cc11bc76e9a0e0694a833) +* [getMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a76933c6f159d52907c0b9f6ba3d13136) +* [getName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a79fdcc3e290b4b0df816f69d8a8d5f9d) +* [getSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a3d171136e0b219dd4e2d0d1b4bb9aa1f) +* [getType](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a05e311dcfb051f0df6afc99dd01d6773) +* [getValue](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1addb4d3f364f0f952a6341b52616bb0cd) +* [getValueAbsolute](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a7c1be797998fc344c26e23ce85d9057d) +* [hasChanged](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a117efbea02cce1afa842341cf3e70bae) +* [hasLowerBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a37a15ea329f97b885f57b2660f8cf519) +* [hasUpperBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a4b31b367d82c30fef71bd2412482c25f) +* [hide](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5f571b35a242ad8260a3380f75ec5acf) +* [invalidate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a521514c594a1ab4e30669305585530b7) +* [isInput](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a3752394336c9689384efac1005422431) +* [isInputToComponent](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a2a19aa7ca1e4c4fb862016aede378c05) +* [isInputToModel](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a41c321c0260174a4c118e309fbd13085) +* [isValid](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ab3d891c3978182e073923a56b4dbe89b) +* [length](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af118bdf4b120050d6700a7ceae7f5bec) +* [lowerBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ad38b7c1cfa620446572595dba1b607f6) +* [numDimensions](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a7b259767761bcb4f84893a2f8baaa139) +* [OwningComponent](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a9d3e429a72048e669d3e37f814294828) +* [precedentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ac71c9a184e57f627b336438de0b7a238) +* [precedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a01bd8fce84abbb243a9f7e3c771c185c) +* [setArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a89811fdbf06146c4bf0b14ea099df689) +* [setDimensions](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a1010ee85bb6325b98fab48f96b582103) +* [setLength](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a91d122341cefcb887c3871d43ea34524) +* [setMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae69f586d5f6a7cf93728f99a47b841cf) +* [setSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b7b41ca5463a86aecb2368d73464c0e) +* [setValue](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a18caa8754a18f914632f71675d6821dd) +* [size](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a49fc48bf1f28f403f2b96b92fb8e5819) +* [toFormattedStringAbsoluteEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a7a0ff2e8e1875ee5465deadb6496b81c) +* [toFormattedStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a895cc520f94cb105b922380b105f448d) +* [toString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a83e5e9905df758b37c901bae5e87430e) +* [toStringAbsolute](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5bc139ce096dbc917734386869a3be78) +* [toStringAbsoluteEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5794b0c172b46da36d761bf31046db07) +* [toStringEx](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae3d6633e9533a68590025dee14298912) +* [units](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1afe8daf819657e592587af96079b0a0a9) +* [upperBound](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a1a062cc1750c92e8db32de2b53d83e9a) +* [validate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a84ab133f5b1147d475fb8e2c4275b32b) +* [value](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1aa7b9346ccbe5c4088c45e09ffb8b7d02) +* [value](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a2b4b654f1094bfd632e383909ea37bad) + +## Properties + + +### Property hasChanged + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IIntegerArray::hasChanged +``` + + + + + + + +**Return type**: boolean + + +### Property hide + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IIntegerArray::hide +``` + + + + + + + +**Return type**: boolean + + +### Property OwningComponent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IIntegerArray::OwningComponent +``` + + + + + + + +**Return type**: LPDISPATCH + + +### Property size + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IIntegerArray::size +``` + + + + + + + +**Return type**: long + + +### Property numDimensions + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IIntegerArray::numDimensions +``` + + + + + + + +**Return type**: long + + +### Property lowerBound + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IIntegerArray::lowerBound +``` + + + +Lower bound of the array. + + + +**Return type**: long + + +### Property upperBound + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IIntegerArray::upperBound +``` + + + +Upper bound of the array. + + + +**Return type**: long + + +### Property description + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IIntegerArray::description +``` + + + +Description of the array. + + + +**Return type**: BSTR + + +### Property units + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IIntegerArray::units +``` + + + +Units of the array. + + + +**Return type**: BSTR + + +### Property enumAliases + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IIntegerArray::enumAliases +``` + + + +Enumerated aliases of the array. + + + +**Return type**: BSTR + + +### Property enumValues + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IIntegerArray::enumValues +``` + + + +Enumerated values of the array. + + + +**Return type**: BSTR + + +### Property format + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IIntegerArray::format +``` + + + +Format of the variable. + + + +**Return type**: BSTR + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3309) + +``` +VARIANT ModelCenter::IIntegerArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9) +``` + + + +Get the value of an array element. + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + +**Returns**: + +The value. + + + +**Return type**: VARIANT + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3325) + +``` +long ModelCenter::IIntegerArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9,[optional] VARIANT d10) +``` + + + +Sets the value of an array element. + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). +* **newValue**: New value. + + + +**Return type**: long + +## Public functions + + +### Function isValid + +![][public] + +``` +boolean ModelCenter::IIntegerArray::isValid() +``` + + + +Finds out whether or not the array is valid. + + + + + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Return type**: boolean + +**Reimplements**: [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) + + +### Function validate + +![][public] + +``` +void ModelCenter::IIntegerArray::validate() +``` + + + +Causes the array to validate itself. + + + +**Return type**: void + +**Reimplements**: [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IIntegerArray::getName() +``` + + + +Gets the name of the array. + + + + + + +**Returns**: + +The name of the array. + + + +**Return type**: BSTR + +**Reimplements**: [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IIntegerArray::getFullName() +``` + + + +Gets the full ModelCenter path of the array. + + + + + + +**Returns**: + +The full ModelCenter path of the array. + + + +**Return type**: BSTR + +**Reimplements**: [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IIntegerArray::getType() +``` + + + +Gets the type of the array. + + + + + + +**Returns**: + +The type of the array as a string. + + + +**Return type**: BSTR + +**Reimplements**: [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) + + +### Function isInput + +![][public] + +``` +boolean ModelCenter::IIntegerArray::isInput() +``` + + + +Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a41c321c0260174a4c118e309fbd13085). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) + + +### Function toString + +![][public] + +``` +BSTR ModelCenter::IIntegerArray::toString() +``` + + + +Converts the array to a string, validating the array if necessary. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. + + + + + + +**Returns**: + +The converted string value of the array. + + + +**Return type**: BSTR + +**Reimplements**: [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) + + +### Function fromString + +![][public] + +``` +void ModelCenter::IIntegerArray::fromString(BSTR value) +``` + + + +Sets the value of the array from a specified string. For 1D arrays, the specification is of the form '1,2,3'.
+For nD arrays, the specification is of the form 'bounds[2,2,2] {1,2,3,4,5,6,7,8}'.
+String arrays may optionally have the elements quoted in the form 'bounds[2,3] {"a", "b,c", "d", "", "e", "f"}' + + + + + + +**Parameters**: + +* **value**: New value. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + +**Reimplements**: [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) + + +### Function toStringAbsolute + +![][public] + +``` +BSTR ModelCenter::IIntegerArray::toStringAbsolute() +``` + + + +Converts the array to a string. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. + + + + + + +**Returns**: + +The converted string value of the array. + + + +**Return type**: BSTR + +**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IIntegerArray::invalidate() +``` + + + +Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. + + + +**Return type**: void + +**Reimplements**: [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) + + +### Function directPrecedents + +![][public] + +``` +LPDISPATCH ModelCenter::IIntegerArray::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) + + +### Function directDependents + +![][public] + +``` +LPDISPATCH ModelCenter::IIntegerArray::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) + + +### Function precedentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IIntegerArray::precedentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) + + +### Function dependentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IIntegerArray::dependentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) + + +### Function precedents + +![][public] + +``` +LPDISPATCH ModelCenter::IIntegerArray::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) + + +### Function dependents + +![][public] + +``` +LPDISPATCH ModelCenter::IIntegerArray::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) + + +### Function isInputToComponent + +![][public] + +``` +boolean ModelCenter::IIntegerArray::isInputToComponent() +``` + + + +Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) + + +### Function isInputToModel + +![][public] + +``` +boolean ModelCenter::IIntegerArray::isInputToModel() +``` + + + +Checks whether or not the variable is an input. A linked input returns false (Output). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) + + +### Function setMetadata + +![][public] + +``` +void ModelCenter::IIntegerArray::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) +``` + + + +Sets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata specifier used to store the data. +* **type**:
+* **value**:
+* **access**:
+* **archive**:
+ + + +**Parameters**: + +* BSTR **name** +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** +* VARIANT **value** +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** +* boolean **archive** + +**Return type**: void + +**Reimplements**: [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) + + +### Function getMetadata + +![][public] + +``` +VARIANT ModelCenter::IIntegerArray::getMetadata(BSTR name) +``` + + + +Gets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata key name. + + +**Returns**: + +Metadata value. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +**Reimplements**: [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) + + +### Function toStringEx + +![][public] + +``` +BSTR ModelCenter::IIntegerArray::toStringEx(long index) +``` + + + +Converts the value of an array element to a string, validating the array if necessary. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The value of the element as a string. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + +**Reimplements**: [toStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a37c622ae9f50579f714ce98c0379cd98) + + +### Function fromStringEx + +![][public] + +``` +void ModelCenter::IIntegerArray::fromStringEx(BSTR value, long index) +``` + + + +Sets the value of an array element from a specified string. + + + + + + +**Parameters**: + +* **value**: New value. +* **index**: Index of the array element (0-based index). + + + +**Parameters**: + +* BSTR **value** +* long **index** + +**Return type**: void + +**Reimplements**: [fromStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad23f4082662c464be07251d6d1695a2d) + + +### Function toStringAbsoluteEx + +![][public] + +``` +BSTR ModelCenter::IIntegerArray::toStringAbsoluteEx(long index) +``` + + + +Converts the value of an array element to a string. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The value of the element as a string. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + +**Reimplements**: [toStringAbsoluteEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a2e3041440581aab716c684fe88d2ee87) + + +### Function getLength + +![][public] + +``` +long ModelCenter::IIntegerArray::getLength([optional] VARIANT dim) +``` + + + +Get the length of the n'th dimension of the array. + + + + + + +**Parameters**: + +* **dim**: Dimension of the array to query. This uses a 0 based index, so 0 will give you the first dimension, 1 the second, etc. If omitted, gives the first dimension + + +**Returns**: + +Length(size) of the array. + + + +**Parameters**: + +* _[optional]_ VARIANT **dim** + +**Return type**: long + +**Reimplements**: [getLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) + + +### Function setLength + +![][public] + +``` +void ModelCenter::IIntegerArray::setLength(long length, [optional] VARIANT dim) +``` + + + +Sets the length of the n'th dimension of the array + + + + + + +**Parameters**: + +* **length**: New length of the n'th dimension of the array +* **dim**: The dimension to set. This uses a 0 based index, so 0 will set the first dimension, 1 the second, etc. If omitted, sets the first dimension + + + +**Parameters**: + +* long **length** +* _[optional]_ VARIANT **dim** + +**Return type**: void + +**Reimplements**: [setLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) + + +### Function setDimensions + +![][public] + +``` +void ModelCenter::IIntegerArray::setDimensions(long d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Sets the number of dimensions of an array and the length of each dimension in one call. An array initializes to 0 length. If any dimension of the array has 0 length, the whole array contains no data. You must set the array size before filling in values unless you are using the [setArray()](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a89811fdbf06146c4bf0b14ea099df689) call. + + + + + + +**Parameters**: + +* **d1**: length of the 1st dimension of the array +* **d2**: length of the 2nd dimension of the array. If omitted, the array is 1 dimensional +* **d3**: length of the 3rd dimension of the array. If omitted, the array is 2 dimensional +* **d4**: length of the 4th dimension of the array. If omitted, the array is 3 dimensional +* **d5**: length of the 5th dimension of the array. If omitted, the array is 4 dimensional +* **d6**: length of the 6th dimension of the array. If omitted, the array is 5 dimensional +* **d7**: length of the 7th dimension of the array. If omitted, the array is 6 dimensional +* **d8**: length of the 8th dimension of the array. If omitted, the array is 7 dimensional +* **d9**: length of the 9th dimension of the array. If omitted, the array is 8 dimensional +* **d10**: length of the 10th dimension of the array. If omitted, the array is 9 dimensional + + + +**Parameters**: + +* long **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: void + +**Reimplements**: [setDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) + + +### Function hasLowerBound + +![][public] + +``` +boolean ModelCenter::IIntegerArray::hasLowerBound() +``` + + + +Whether or not the array has an lower bound. + + + + + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Return type**: boolean + + +### Function hasUpperBound + +![][public] + +``` +boolean ModelCenter::IIntegerArray::hasUpperBound() +``` + + + +Whether or not the array has an upper bound. + + + + + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Return type**: boolean + + +### Function getValue + +![][public] + +``` +long ModelCenter::IIntegerArray::getValue(VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Gets the value of an array element. + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + +**Returns**: + +The value. + + + +**Parameters**: + +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: long + + +### Function setValue + +![][public] + +``` +void ModelCenter::IIntegerArray::setValue(long value, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Sets the value of an array element. + + + + + + +**Parameters**: + +* **value**: New value. +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + + +**Parameters**: + +* long **value** +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: void + + +### Function getArray + +![][public] + +``` +VARIANT ModelCenter::IIntegerArray::getArray() +``` + + + +Gets the COM array. + + + + + + +**Returns**: + +The COM array. + + + +**Return type**: VARIANT + + +### Function setArray + +![][public] + +``` +void ModelCenter::IIntegerArray::setArray(VARIANT array) +``` + + + +Sets the COM array. + + + + + + +**Parameters**: + +* **array**: The COM array. + + + +**Parameters**: + +* VARIANT **array** + +**Return type**: void + + +### Function toFormattedStringEx + +![][public] + +``` +BSTR ModelCenter::IIntegerArray::toFormattedStringEx(long index) +``` + + + +Converts the value to a formatted string. + + + + + + +**Parameters**: + +* **index**: Position in the array (0-based index). + + +**Returns**: + +The formatted string. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + + +### Function fromFormattedStringEx + +![][public] + +``` +void ModelCenter::IIntegerArray::fromFormattedStringEx(BSTR value, long index) +``` + + + +Loads a formatted string. + + + + + + +**Parameters**: + +* **value**: Formatted value to load. +* **index**: Position in the array (0-based index). + + + +**Parameters**: + +* BSTR **value** +* long **index** + +**Return type**: void + + +### Function toFormattedStringAbsoluteEx + +![][public] + +``` +BSTR ModelCenter::IIntegerArray::toFormattedStringAbsoluteEx(long index) +``` + + + +Converts the value to an absolute formatted string. + + + + + + +**Parameters**: + +* **index**: Position in the array (0-based index). + + +**Returns**: + +The formatted string. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + + +### Function clearUpperBound + +![][public] + +``` +void ModelCenter::IIntegerArray::clearUpperBound() +``` + + + +Clears the upper bound property of the array if it has previously been set. + + + +**Return type**: void + + +### Function clearLowerBound + +![][public] + +``` +void ModelCenter::IIntegerArray::clearLowerBound() +``` + + + +Clears the lower bound property of the array if it has previously been set. + + + +**Return type**: void + + +### Function getValueAbsolute + +![][public] + +``` +long ModelCenter::IIntegerArray::getValueAbsolute(VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Gets the value of an array element without validating. + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + +**Returns**: + +The value. + + + +**Parameters**: + +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: long + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IIntegerVariable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IIntegerVariable.md index fa5320f581..d260d4a927 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IIntegerVariable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IIntegerVariable.md @@ -1,1124 +1,1123 @@ - -# Interface ModelCenter::IIntegerVariable - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3461) - - - -COM Instance. - -**Inherits from**: - -* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) - -## Members - -* [clearLowerBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a16f466aa207ea88961361ee69a683850) -* [clearUpperBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aba1030008767dd31ae13f40f90ba58d8) -* [dependentLinks](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a1328684b4767a3ee6b006feca4f0296d) -* [dependents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aa8739ff163a52ceed99e867e5126330f) -* [description](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a746f793efe758a7e3f36ba188d07ccee) -* [directDependents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ad783a3a7e231dd0aa00b869699a5bca4) -* [directPrecedents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a5c99fbda3111d689db126a61e0727106) -* [enumAliases](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac706776dfc20b9410c859471f981f43e) -* [enumValues](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1af9ee5a112578385dcae1893f96f0143b) -* [format](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac28287849865c6233468b6e1a9034248) -* [fromFormattedString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a647cc6b6832eefd008c51457a34c9ff5) -* [fromString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a180292624fd43a95348bd496b0fee8a6) -* [getFullName](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a6bbb377e1c98a99b660cfdfa3c61f191) -* [getMetadata](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aea17e7f7dc6d8979c2c83aec3f8a0c42) -* [getName](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abcd09429d47c396bab6dc63690e1a1c1) -* [getType](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a38de94bbe44275b88d92522926b1a841) -* [hasChanged](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a752e2918df57582c7e0639840f2653f7) -* [hasLowerBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a3f0459ca0bc1b7108721b4ee36304bc9) -* [hasUpperBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a6434f421569bb898aabc32204d615f1a) -* [hide](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a0baef047e82cd94c3fe393690a129bb0) -* [invalidate](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a07f62e68cae660a8bea1d1e31d754fcf) -* [isInput](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ab441aa413516cf14c082aa39801250c4) -* [isInputToComponent](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a67665668e8c1abee8bc9db708b05e970) -* [isInputToModel](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a87d3f8de3185380e368fdb008466dfe3) -* [isValid](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ae03686387c15bc80d2caec8c3a5a913f) -* [lowerBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a15d6fe654e10ea55a5df2e7bea934e75) -* [OwningComponent](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a7156a5b9cb1cd09eced27ffaacd9f521) -* [precedentLinks](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a02a977781b36247895725b38a725dca9) -* [precedents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a902fe35d10c8e25b86a64e13953a62f1) -* [setInitialValue](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a4f198a32ba9ba7975e6a81f769a6df0f) -* [setMetadata](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ad80d2a2e770297e5e57af0cd86601f83) -* [toFormattedString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abf09981270a02adab12c6bd420e07a22) -* [toFormattedStringAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a7c3ea8978f890824c3e08134c7bf7747) -* [toString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a2ec6bbef037c4c0a6ab5e510f9063923) -* [toStringAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac13b9c8e85a30831a81cedcdca610e01) -* [units](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a3752ce74846eb04caed29711d1da302d) -* [upperBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abc988cc945fcc8e2cf905c885a180542) -* [validate](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a2807c2dd1e70fe7d8eab0af0a64e2d74) -* [value](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a8626c616deb64d587178b6c1cbdc2974) -* [valueAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a5e2a2a61e1c4978200a2009c1f6ab74c) - -## Properties - - -### Property hasChanged - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IIntegerVariable::hasChanged -``` - - - - - - - -**Return type**: boolean - - -### Property hide - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IIntegerVariable::hide -``` - - - - - - - -**Return type**: boolean - - -### Property OwningComponent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IIntegerVariable::OwningComponent -``` - - - - - - - -**Return type**: LPDISPATCH - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IIntegerVariable::value -``` - - - -Value of the variable. - - - -**Return type**: long - - -### Property valueAbsolute - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IIntegerVariable::valueAbsolute -``` - - - -The value of the variable (Fetched without attempting to validate). - - - -**Return type**: long - - -### Property lowerBound - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IIntegerVariable::lowerBound -``` - - - -Lower bound of the variable. - - - -**Return type**: long - - -### Property upperBound - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IIntegerVariable::upperBound -``` - - - -Upper bound of the variable. - - - -**Return type**: long - - -### Property units - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IIntegerVariable::units -``` - - - -Units of the variable. - - - -**Return type**: BSTR - - -### Property description - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IIntegerVariable::description -``` - - - -Description of the variable. - - - -**Return type**: BSTR - - -### Property enumValues - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IIntegerVariable::enumValues -``` - - - -Enumerated values of the variable. - - - -**Return type**: BSTR - - -### Property enumAliases - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IIntegerVariable::enumAliases -``` - - - -Enumerated aliases of the variable. - - - -**Return type**: BSTR - - -### Property format - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IIntegerVariable::format -``` - - - -Format of the variable. - - - -**Return type**: BSTR - -## Public functions - - -### Function isValid - -![][public] - -``` -boolean ModelCenter::IIntegerVariable::isValid() -``` - - - -Returns whether or not the variable is valid. - - - - - - -**Returns**: - -True if variable is valid. False if the variable is not valid. - - - -**Return type**: boolean - -**Reimplements**: [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) - - -### Function validate - -![][public] - -``` -void ModelCenter::IIntegerVariable::validate() -``` - - - -Validates the variable by running the component if needed. - - - -**Return type**: void - -**Reimplements**: [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IIntegerVariable::getName() -``` - - - -Gets the name of the variable. - - - - - - -**Returns**: - -The name of the variable. - - - -**Return type**: BSTR - -**Reimplements**: [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IIntegerVariable::getFullName() -``` - - - -Gets the full ModelCenter path of the variable. - - - - - - -**Returns**: - -The full ModelCenter path of the variable. - - - -**Return type**: BSTR - -**Reimplements**: [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IIntegerVariable::getType() -``` - - - -Gets the type of the variable. - - - - - - -**Returns**: - -The type of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) - - -### Function isInput - -![][public] - -``` -boolean ModelCenter::IIntegerVariable::isInput() -``` - - - -Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a87d3f8de3185380e368fdb008466dfe3). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) - - -### Function toString - -![][public] - -``` -BSTR ModelCenter::IIntegerVariable::toString() -``` - - - -Converts the variable value to a string, validating the variable if necessary. - - - - - - -**Returns**: - -The value of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) - - -### Function fromString - -![][public] - -``` -void ModelCenter::IIntegerVariable::fromString(BSTR value) -``` - - - -Sets the value of the variable from the specified string. - - - - - - -**Parameters**: - -* **value**: New value. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - -**Reimplements**: [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) - - -### Function toStringAbsolute - -![][public] - -``` -BSTR ModelCenter::IIntegerVariable::toStringAbsolute() -``` - - - -Converts the value of the variable to a string. - - - - - - -**Returns**: - -The value of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IIntegerVariable::invalidate() -``` - - - -Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. - - - -**Return type**: void - -**Reimplements**: [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) - - -### Function directPrecedents - -![][public] - -``` -LPDISPATCH ModelCenter::IIntegerVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) - - -### Function directDependents - -![][public] - -``` -LPDISPATCH ModelCenter::IIntegerVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) - - -### Function precedentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IIntegerVariable::precedentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) - - -### Function dependentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IIntegerVariable::dependentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) - - -### Function precedents - -![][public] - -``` -LPDISPATCH ModelCenter::IIntegerVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) - - -### Function dependents - -![][public] - -``` -LPDISPATCH ModelCenter::IIntegerVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) - - -### Function isInputToComponent - -![][public] - -``` -boolean ModelCenter::IIntegerVariable::isInputToComponent() -``` - - - -Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) - - -### Function isInputToModel - -![][public] - -``` -boolean ModelCenter::IIntegerVariable::isInputToModel() -``` - - - -Checks whether or not the variable is an input. A linked input returns false (Output). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) - - -### Function setMetadata - -![][public] - -``` -void ModelCenter::IIntegerVariable::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) -``` - - - -Sets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata specifier used to store the data. -* **type**:
-* **value**:
-* **access**:
-* **archive**:
- - - -**Parameters**: - -* BSTR **name** -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** -* VARIANT **value** -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** -* boolean **archive** - -**Return type**: void - -**Reimplements**: [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) - - -### Function getMetadata - -![][public] - -``` -VARIANT ModelCenter::IIntegerVariable::getMetadata(BSTR name) -``` - - - -Gets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata key name. - - -**Returns**: - -Metadata value. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -**Reimplements**: [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) - - -### Function setInitialValue - -![][public] - -``` -void ModelCenter::IIntegerVariable::setInitialValue(long value) -``` - - - -Sets the initial value of the variable. - - - - - - -**Parameters**: - -* **value**: Initial value. - - - -**Parameters**: - -* long **value** - -**Return type**: void - - -### Function hasLowerBound - -![][public] - -``` -boolean ModelCenter::IIntegerVariable::hasLowerBound() -``` - - - -Whether or not the variable has an lower bound. - - - - - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Return type**: boolean - - -### Function hasUpperBound - -![][public] - -``` -boolean ModelCenter::IIntegerVariable::hasUpperBound() -``` - - - -Whether or not the variable has an upper bound. - - - - - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Return type**: boolean - - -### Function toFormattedString - -![][public] - -``` -BSTR ModelCenter::IIntegerVariable::toFormattedString() -``` - - - -Converts the value to a formatted string. - - - - - - -**Returns**: - -The formatted value. - - - -**Return type**: BSTR - - -### Function fromFormattedString - -![][public] - -``` -void ModelCenter::IIntegerVariable::fromFormattedString(BSTR value) -``` - - - -Sets the value from a formatted string. - - - - - - -**Parameters**: - -* **value**: Formatted value to load. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - - -### Function toFormattedStringAbsolute - -![][public] - -``` -BSTR ModelCenter::IIntegerVariable::toFormattedStringAbsolute() -``` - - - -Converts the value to a formatted string without validating. - - - - - - -**Returns**: - -The formatted value. - - - -**Return type**: BSTR - - -### Function clearUpperBound - -![][public] - -``` -void ModelCenter::IIntegerVariable::clearUpperBound() -``` - - - -Clears the lower bound property of the variable if it has previously been set. - - - -**Return type**: void - - -### Function clearLowerBound - -![][public] - -``` -void ModelCenter::IIntegerVariable::clearLowerBound() -``` - - - -Clears the upper bound property of the variable if it has previously been set. - - - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IIntegerVariable + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3461) + + + +COM Instance. + +**Inherits from**: + +* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) + +## Members + +* [clearLowerBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a16f466aa207ea88961361ee69a683850) +* [clearUpperBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aba1030008767dd31ae13f40f90ba58d8) +* [dependentLinks](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a1328684b4767a3ee6b006feca4f0296d) +* [dependents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aa8739ff163a52ceed99e867e5126330f) +* [description](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a746f793efe758a7e3f36ba188d07ccee) +* [directDependents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ad783a3a7e231dd0aa00b869699a5bca4) +* [directPrecedents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a5c99fbda3111d689db126a61e0727106) +* [enumAliases](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac706776dfc20b9410c859471f981f43e) +* [enumValues](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1af9ee5a112578385dcae1893f96f0143b) +* [format](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac28287849865c6233468b6e1a9034248) +* [fromFormattedString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a647cc6b6832eefd008c51457a34c9ff5) +* [fromString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a180292624fd43a95348bd496b0fee8a6) +* [getFullName](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a6bbb377e1c98a99b660cfdfa3c61f191) +* [getMetadata](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aea17e7f7dc6d8979c2c83aec3f8a0c42) +* [getName](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abcd09429d47c396bab6dc63690e1a1c1) +* [getType](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a38de94bbe44275b88d92522926b1a841) +* [hasChanged](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a752e2918df57582c7e0639840f2653f7) +* [hasLowerBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a3f0459ca0bc1b7108721b4ee36304bc9) +* [hasUpperBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a6434f421569bb898aabc32204d615f1a) +* [hide](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a0baef047e82cd94c3fe393690a129bb0) +* [invalidate](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a07f62e68cae660a8bea1d1e31d754fcf) +* [isInput](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ab441aa413516cf14c082aa39801250c4) +* [isInputToComponent](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a67665668e8c1abee8bc9db708b05e970) +* [isInputToModel](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a87d3f8de3185380e368fdb008466dfe3) +* [isValid](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ae03686387c15bc80d2caec8c3a5a913f) +* [lowerBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a15d6fe654e10ea55a5df2e7bea934e75) +* [OwningComponent](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a7156a5b9cb1cd09eced27ffaacd9f521) +* [precedentLinks](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a02a977781b36247895725b38a725dca9) +* [precedents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a902fe35d10c8e25b86a64e13953a62f1) +* [setInitialValue](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a4f198a32ba9ba7975e6a81f769a6df0f) +* [setMetadata](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ad80d2a2e770297e5e57af0cd86601f83) +* [toFormattedString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abf09981270a02adab12c6bd420e07a22) +* [toFormattedStringAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a7c3ea8978f890824c3e08134c7bf7747) +* [toString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a2ec6bbef037c4c0a6ab5e510f9063923) +* [toStringAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac13b9c8e85a30831a81cedcdca610e01) +* [units](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a3752ce74846eb04caed29711d1da302d) +* [upperBound](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abc988cc945fcc8e2cf905c885a180542) +* [validate](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a2807c2dd1e70fe7d8eab0af0a64e2d74) +* [value](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a8626c616deb64d587178b6c1cbdc2974) +* [valueAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a5e2a2a61e1c4978200a2009c1f6ab74c) + +## Properties + + +### Property hasChanged + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IIntegerVariable::hasChanged +``` + + + + + + + +**Return type**: boolean + + +### Property hide + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IIntegerVariable::hide +``` + + + + + + + +**Return type**: boolean + + +### Property OwningComponent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IIntegerVariable::OwningComponent +``` + + + + + + + +**Return type**: LPDISPATCH + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IIntegerVariable::value +``` + + + +Value of the variable. + + + +**Return type**: long + + +### Property valueAbsolute + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IIntegerVariable::valueAbsolute +``` + + + +The value of the variable (Fetched without attempting to validate). + + + +**Return type**: long + + +### Property lowerBound + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IIntegerVariable::lowerBound +``` + + + +Lower bound of the variable. + + + +**Return type**: long + + +### Property upperBound + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IIntegerVariable::upperBound +``` + + + +Upper bound of the variable. + + + +**Return type**: long + + +### Property units + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IIntegerVariable::units +``` + + + +Units of the variable. + + + +**Return type**: BSTR + + +### Property description + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IIntegerVariable::description +``` + + + +Description of the variable. + + + +**Return type**: BSTR + + +### Property enumValues + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IIntegerVariable::enumValues +``` + + + +Enumerated values of the variable. + + + +**Return type**: BSTR + + +### Property enumAliases + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IIntegerVariable::enumAliases +``` + + + +Enumerated aliases of the variable. + + + +**Return type**: BSTR + + +### Property format + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IIntegerVariable::format +``` + + + +Format of the variable. + + + +**Return type**: BSTR + +## Public functions + + +### Function isValid + +![][public] + +``` +boolean ModelCenter::IIntegerVariable::isValid() +``` + + + +Returns whether or not the variable is valid. + + + + + + +**Returns**: + +True if variable is valid. False if the variable is not valid. + + + +**Return type**: boolean + +**Reimplements**: [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) + + +### Function validate + +![][public] + +``` +void ModelCenter::IIntegerVariable::validate() +``` + + + +Validates the variable by running the component if needed. + + + +**Return type**: void + +**Reimplements**: [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IIntegerVariable::getName() +``` + + + +Gets the name of the variable. + + + + + + +**Returns**: + +The name of the variable. + + + +**Return type**: BSTR + +**Reimplements**: [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IIntegerVariable::getFullName() +``` + + + +Gets the full ModelCenter path of the variable. + + + + + + +**Returns**: + +The full ModelCenter path of the variable. + + + +**Return type**: BSTR + +**Reimplements**: [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IIntegerVariable::getType() +``` + + + +Gets the type of the variable. + + + + + + +**Returns**: + +The type of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) + + +### Function isInput + +![][public] + +``` +boolean ModelCenter::IIntegerVariable::isInput() +``` + + + +Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a87d3f8de3185380e368fdb008466dfe3). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) + + +### Function toString + +![][public] + +``` +BSTR ModelCenter::IIntegerVariable::toString() +``` + + + +Converts the variable value to a string, validating the variable if necessary. + + + + + + +**Returns**: + +The value of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) + + +### Function fromString + +![][public] + +``` +void ModelCenter::IIntegerVariable::fromString(BSTR value) +``` + + + +Sets the value of the variable from the specified string. + + + + + + +**Parameters**: + +* **value**: New value. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + +**Reimplements**: [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) + + +### Function toStringAbsolute + +![][public] + +``` +BSTR ModelCenter::IIntegerVariable::toStringAbsolute() +``` + + + +Converts the value of the variable to a string. + + + + + + +**Returns**: + +The value of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IIntegerVariable::invalidate() +``` + + + +Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. + + + +**Return type**: void + +**Reimplements**: [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) + + +### Function directPrecedents + +![][public] + +``` +LPDISPATCH ModelCenter::IIntegerVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) + + +### Function directDependents + +![][public] + +``` +LPDISPATCH ModelCenter::IIntegerVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) + + +### Function precedentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IIntegerVariable::precedentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) + + +### Function dependentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IIntegerVariable::dependentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) + + +### Function precedents + +![][public] + +``` +LPDISPATCH ModelCenter::IIntegerVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) + + +### Function dependents + +![][public] + +``` +LPDISPATCH ModelCenter::IIntegerVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) + + +### Function isInputToComponent + +![][public] + +``` +boolean ModelCenter::IIntegerVariable::isInputToComponent() +``` + + + +Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) + + +### Function isInputToModel + +![][public] + +``` +boolean ModelCenter::IIntegerVariable::isInputToModel() +``` + + + +Checks whether or not the variable is an input. A linked input returns false (Output). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) + + +### Function setMetadata + +![][public] + +``` +void ModelCenter::IIntegerVariable::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) +``` + + + +Sets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata specifier used to store the data. +* **type**:
+* **value**:
+* **access**:
+* **archive**:
+ + + +**Parameters**: + +* BSTR **name** +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** +* VARIANT **value** +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** +* boolean **archive** + +**Return type**: void + +**Reimplements**: [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) + + +### Function getMetadata + +![][public] + +``` +VARIANT ModelCenter::IIntegerVariable::getMetadata(BSTR name) +``` + + + +Gets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata key name. + + +**Returns**: + +Metadata value. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +**Reimplements**: [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) + + +### Function setInitialValue + +![][public] + +``` +void ModelCenter::IIntegerVariable::setInitialValue(long value) +``` + + + +Sets the initial value of the variable. + + + + + + +**Parameters**: + +* **value**: Initial value. + + + +**Parameters**: + +* long **value** + +**Return type**: void + + +### Function hasLowerBound + +![][public] + +``` +boolean ModelCenter::IIntegerVariable::hasLowerBound() +``` + + + +Whether or not the variable has an lower bound. + + + + + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Return type**: boolean + + +### Function hasUpperBound + +![][public] + +``` +boolean ModelCenter::IIntegerVariable::hasUpperBound() +``` + + + +Whether or not the variable has an upper bound. + + + + + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Return type**: boolean + + +### Function toFormattedString + +![][public] + +``` +BSTR ModelCenter::IIntegerVariable::toFormattedString() +``` + + + +Converts the value to a formatted string. + + + + + + +**Returns**: + +The formatted value. + + + +**Return type**: BSTR + + +### Function fromFormattedString + +![][public] + +``` +void ModelCenter::IIntegerVariable::fromFormattedString(BSTR value) +``` + + + +Sets the value from a formatted string. + + + + + + +**Parameters**: + +* **value**: Formatted value to load. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + + +### Function toFormattedStringAbsolute + +![][public] + +``` +BSTR ModelCenter::IIntegerVariable::toFormattedStringAbsolute() +``` + + + +Converts the value to a formatted string without validating. + + + + + + +**Returns**: + +The formatted value. + + + +**Return type**: BSTR + + +### Function clearUpperBound + +![][public] + +``` +void ModelCenter::IIntegerVariable::clearUpperBound() +``` + + + +Clears the lower bound property of the variable if it has previously been set. + + + +**Return type**: void + + +### Function clearLowerBound + +![][public] + +``` +void ModelCenter::IIntegerVariable::clearLowerBound() +``` + + + +Clears the upper bound property of the variable if it has previously been set. + + + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IJobManager.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IJobManager.md index 75efee90c7..240017cf99 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IJobManager.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IJobManager.md @@ -1,840 +1,839 @@ - -# Interface ModelCenter::IJobManager - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3598) - - - -Allows you to set up a matrix of runs and runs them in parallel or serial depending on the preferences mode. - -## Members - -* [addInput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ab95c6155dd1c2dbd24441bf3641a5542) -* [addOutput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a4591b4c0b98d14307aa691f42547c97e) -* [addRerun](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a3e06470a8599a950a01c275f75c0d6cb) -* [clearCache](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a06a3f847d50eb2f10e3b061ea91b453b) -* [enableCache](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1af28b9a4ab0944f31f2d157ab6826999c) -* [getInput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ac205f68299271d8e97adbc34f7c33655) -* [getInputLabel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a4d6a218d3dfff84908b13db7016a947c) -* [getNumInputs](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad8dcd18454e462b191092edd4096ab0c) -* [getNumOutputs](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a49fae6444ed2747c716f7829f8113969) -* [getNumRuns](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ae63c0e8eda0494dda49ee20141f11ece) -* [getNumThreads](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a2a6391025814c8b85861fe9d8eaebf58) -* [getOutput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1aede4e8c73a70bff3143317d0fa8dca97) -* [getOutputLabel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a7665a71ea25ae6436d201cd2e339e976) -* [getRunIndex](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a03b40110aba59370e9eb6aad1b6b2076) -* [getRunInParallel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a8893b7830affcf596e4a6d149ab47753) -* [getValidateAll](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a53f5cbf8459b20f9c748535d8013eafd) -* [halt](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1aa550897654f63d845e410ac9bda26b8a) -* [resume](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a1bce7921ac7cedd5712423589b99afb2) -* [setCustomMetadata](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad106f381c9834b32c12e169264f1272a) -* [setInput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1abd6b3fa7a63b620f95141c191cd1c29e) -* [setNumRuns](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a89e662a1a1c15ed27f8517b5a526b94d) -* [setNumThreads](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a034974bf844d74af316ef687be4b84f7) -* [setRunInParallel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a660d28f5c25a2efbe370cb162bc58f4e) -* [setValidateAll](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1aefca61419c9622f520429f257aa6061c) -* [submit](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad1b204f5e684c57b28dc1e3dc733e285) -* [waitForJobCompletion](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a65bfecf019c1e9c8752fa3c90fd5d3a7) -* [wasHalted](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a103d78a1bad75512c13080d2467fb11e) - -## Properties - - -### Property wasHalted - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IJobManager::wasHalted -``` - - - - - - - -**Return type**: boolean - -## Public functions - - -### Function addInput - -![][public] - -``` -void ModelCenter::IJobManager::addInput(BSTR name, BSTR label) -``` - - - -Adds an input to all runs in the Job Manager. - - - - - - -**Parameters**: - -* **name**: Variable name. -* **label**: Variable label. - - - -**Parameters**: - -* BSTR **name** -* BSTR **label** - -**Return type**: void - - -### Function setInput - -![][public] - -``` -void ModelCenter::IJobManager::setInput(long run, BSTR name, BSTR value) -``` - - - -Sets the value for a specified input variable for a specified run. - - - - - - -**Parameters**: - -* **run**: Index of the run this is to apply to (0-based index). -* **name**: Name of the specified variable. -* **value**: Value for the specified variable to run for this specified run. - - - -**Parameters**: - -* long **run** -* BSTR **name** -* BSTR **value** - -**Return type**: void - - -### Function addOutput - -![][public] - -``` -void ModelCenter::IJobManager::addOutput(BSTR name, BSTR label) -``` - - - -Adds an output to all runs in the Job Manager. - - - - - - -**Parameters**: - -* **name**: Variable name. -* **label**: Variable label. - - - -**Parameters**: - -* BSTR **name** -* BSTR **label** - -**Return type**: void - - -### Function getValidateAll - -![][public] - -``` -boolean ModelCenter::IJobManager::getValidateAll() -``` - - - -Whether or not the Job Manager will validate everything. - - - - - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Return type**: boolean - - -### Function setValidateAll - -![][public] - -``` -void ModelCenter::IJobManager::setValidateAll(boolean flag) -``` - - - -Sets whether or not the Job Manager will validate everything. - - - - - - -**Parameters**: - -* **flag**: yes(TRUE) or no(FALSE). - - - -**Parameters**: - -* boolean **flag** - -**Return type**: void - - -### Function getNumRuns - -![][public] - -``` -long ModelCenter::IJobManager::getNumRuns() -``` - - - -Gets the number of runs currently in the job matrix. - - - - - - -**Returns**: - -The number of runs. - - - -**Return type**: long - - -### Function setNumRuns - -![][public] - -``` -void ModelCenter::IJobManager::setNumRuns(long numRuns) -``` - - - -Sets the number of runs that will take place in this job matrix. - - - - - - -**Parameters**: - -* **numRuns**: Number of runs. - - - -**Parameters**: - -* long **numRuns** - -**Return type**: void - - -### Function submit - -![][public] - -``` -void ModelCenter::IJobManager::submit(IDispatch *dataCollector, [optional]VARIANT description, [optional]VARIANT fireAndForget) -``` - - - -Causes the run matrix to begin. - - - - - - -**Parameters**: - -* **dataCollector**: IDispatch* to an [IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) object. -* **description**: The type of trade study to be run. -* **fireAndForget**: Flag for whether fire-n-forget is enabled - - - -**Parameters**: - -* IDispatch * **dataCollector** -* _[optional]_ VARIANT **description** -* _[optional]_ VARIANT **fireAndForget** - -**Return type**: void - - -### Function waitForJobCompletion - -![][public] - -``` -void ModelCenter::IJobManager::waitForJobCompletion() -``` - - - -Waits until the current run matrix has completed before continuing. - - - -**Return type**: void - - -### Function addRerun - -![][public] - -``` -void ModelCenter::IJobManager::addRerun(long run) -``` - - - -The job manager may alternately be used to re-run runs out of an existing Data Collector or Data Explorer object. Simply call this function for each run which should be run. When using the Job Manager in this form, do not use addInput, addOutput, setInput or setNumRuns. - - - - - - -**Parameters**: - -* **run**: 0 based run number to add to the re-run list. - - - -**Parameters**: - -* long **run** - -**Return type**: void - - -### Function halt - -![][public] - -``` -void ModelCenter::IJobManager::halt(boolean halt) -``` - - - -Halt the running job in the Job Manager. - - - - - - -**Parameters**: - -* **halt**: Whether to halt the job or not. - - - -**Parameters**: - -* boolean **halt** - -**Return type**: void - - -### Function getNumInputs - -![][public] - -``` -long ModelCenter::IJobManager::getNumInputs() -``` - - - -Retrieve the number of inputs in the job. - - - - - - -**Returns**: - -The number of inputs. - - - -**Return type**: long - - -### Function getNumOutputs - -![][public] - -``` -long ModelCenter::IJobManager::getNumOutputs() -``` - - - -Retrieve the number of outputs in the job. - - - - - - -**Returns**: - -The number of outputs. - - - -**Return type**: long - - -### Function getInput - -![][public] - -``` -BSTR ModelCenter::IJobManager::getInput(long index) -``` - - - -Get the specified input. - - - - - - -**Parameters**: - -* **index**: The index of the input to fetch. - - -**Returns**: - -The input. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - - -### Function getOutput - -![][public] - -``` -BSTR ModelCenter::IJobManager::getOutput(long index) -``` - - - -Get the specified output. - - - - - - -**Parameters**: - -* **index**: The index of the output to fetch. - - -**Returns**: - -The output. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - - -### Function getInputLabel - -![][public] - -``` -BSTR ModelCenter::IJobManager::getInputLabel(long index) -``` - - - -Get the label of the specified input. - - - - - - -**Parameters**: - -* **index**: The index of the input to fetch. - - -**Returns**: - -The label of the input. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - - -### Function getOutputLabel - -![][public] - -``` -BSTR ModelCenter::IJobManager::getOutputLabel(long index) -``` - - - -Get the label of the specified output. - - - - - - -**Parameters**: - -* **index**: The index of the output to fetch. - - -**Returns**: - -The label of the output. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - - -### Function getNumThreads - -![][public] - -``` -long ModelCenter::IJobManager::getNumThreads() -``` - - - -Get the number of threads to use when running in parallel. - - - - - - -**Returns**: - -The number of threads to use - - - -**Return type**: long - - -### Function getRunInParallel - -![][public] - -``` -boolean ModelCenter::IJobManager::getRunInParallel() -``` - - - -Determine whether or not to run the job in parallel. - - - - - - -**Returns**: - -true if the job is to be ran in parallel false otherwise. - - - -**Return type**: boolean - - -### Function setNumThreads - -![][public] - -``` -void ModelCenter::IJobManager::setNumThreads(long numThreads) -``` - - - -Set the number of threads to use if the job is to be ran in parallel. - - - - - - -**Parameters**: - -* **numThreads**: the number of threads to use - - - -**Parameters**: - -* long **numThreads** - -**Return type**: void - - -### Function setRunInParallel - -![][public] - -``` -void ModelCenter::IJobManager::setRunInParallel(boolean runInParallel) -``` - - - -Tell the job manager to run the job in parallel. - - - - - - -**Parameters**: - -* **runInParallel**: true if the job is to be ran in parallel, false otherwise - - - -**Parameters**: - -* boolean **runInParallel** - -**Return type**: void - - -### Function enableCache - -![][public] - -``` -boolean ModelCenter::IJobManager::enableCache(boolean enable) -``` - - - -Method to tell the job manager to enable or disable using cache for submitted designs. If you disable the cache, runs may be purged from the cache lookup either immediately or after subsequent runs. - - - - - - -**Parameters**: - -* **enable**: true if run values could be get from cache, if false, all submitted runs are to be executed. - - -**Returns**: - -Previous setting. - - - -**Parameters**: - -* boolean **enable** - -**Return type**: boolean - - -### Function clearCache - -![][public] - -``` -void ModelCenter::IJobManager::clearCache() -``` - - - -Method to actively clear job manager's internal cache of executed runs. - - - -**Return type**: void - - -### Function getRunIndex - -![][public] - -``` -long ModelCenter::IJobManager::getRunIndex(VARIANT names, VARIANT values) -``` - - - -Method to get Run Index for the given design from cache. Only works if you've been running jobs with the run cache enabled. - - - - - - -**Parameters**: - -* **names**: array of variable names for the design -* **values**: array of values corresponding to the names array - - -**Returns**: - -index of design in data explorer if design found else -1
- - - -**Parameters**: - -* VARIANT **names** -* VARIANT **values** - -**Return type**: long - - -### Function resume - -![][public] - -``` -void ModelCenter::IJobManager::resume(IDispatch *dataHistory) -``` - - - -Pick up from the last checkpoint in a data history. If you subsequently pass a data collector, data explorer, or data history to [submit()](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad1b204f5e684c57b28dc1e3dc733e285), you should be sure to pass one with the same data history or all restored runs will be lost. Note: this function merely loads the run cache; it does not actually submit any runs. You must still specify the runs to perform and call [submit()](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad1b204f5e684c57b28dc1e3dc733e285) in order to continue evaluation. -**Parameters**: - -* **dataHistory**: the Data History to restore from; if null uses the current data history; if non-null this becomes the current data history; you may pass a data explorer or data collector instead - - - -**Parameters**: - -* IDispatch * **dataHistory** - -**Return type**: void - - -### Function setCustomMetadata - -![][public] - -``` -void ModelCenter::IJobManager::setCustomMetadata(BSTR name, BSTR key, BSTR value) -``` - - - -Add custom metadata to a variable. - - - - - - -**Parameters**: - -* **name**: Variable name. -* **key**: the key of the metadata to add -* **value**: the value of the metadata to add. - - - -**Parameters**: - -* BSTR **name** -* BSTR **key** -* BSTR **value** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IJobManager + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3598) + + + +Allows you to set up a matrix of runs and runs them in parallel or serial depending on the preferences mode. + +## Members + +* [addInput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ab95c6155dd1c2dbd24441bf3641a5542) +* [addOutput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a4591b4c0b98d14307aa691f42547c97e) +* [addRerun](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a3e06470a8599a950a01c275f75c0d6cb) +* [clearCache](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a06a3f847d50eb2f10e3b061ea91b453b) +* [enableCache](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1af28b9a4ab0944f31f2d157ab6826999c) +* [getInput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ac205f68299271d8e97adbc34f7c33655) +* [getInputLabel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a4d6a218d3dfff84908b13db7016a947c) +* [getNumInputs](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad8dcd18454e462b191092edd4096ab0c) +* [getNumOutputs](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a49fae6444ed2747c716f7829f8113969) +* [getNumRuns](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ae63c0e8eda0494dda49ee20141f11ece) +* [getNumThreads](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a2a6391025814c8b85861fe9d8eaebf58) +* [getOutput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1aede4e8c73a70bff3143317d0fa8dca97) +* [getOutputLabel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a7665a71ea25ae6436d201cd2e339e976) +* [getRunIndex](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a03b40110aba59370e9eb6aad1b6b2076) +* [getRunInParallel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a8893b7830affcf596e4a6d149ab47753) +* [getValidateAll](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a53f5cbf8459b20f9c748535d8013eafd) +* [halt](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1aa550897654f63d845e410ac9bda26b8a) +* [resume](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a1bce7921ac7cedd5712423589b99afb2) +* [setCustomMetadata](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad106f381c9834b32c12e169264f1272a) +* [setInput](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1abd6b3fa7a63b620f95141c191cd1c29e) +* [setNumRuns](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a89e662a1a1c15ed27f8517b5a526b94d) +* [setNumThreads](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a034974bf844d74af316ef687be4b84f7) +* [setRunInParallel](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a660d28f5c25a2efbe370cb162bc58f4e) +* [setValidateAll](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1aefca61419c9622f520429f257aa6061c) +* [submit](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad1b204f5e684c57b28dc1e3dc733e285) +* [waitForJobCompletion](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a65bfecf019c1e9c8752fa3c90fd5d3a7) +* [wasHalted](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1a103d78a1bad75512c13080d2467fb11e) + +## Properties + + +### Property wasHalted + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IJobManager::wasHalted +``` + + + + + + + +**Return type**: boolean + +## Public functions + + +### Function addInput + +![][public] + +``` +void ModelCenter::IJobManager::addInput(BSTR name, BSTR label) +``` + + + +Adds an input to all runs in the Job Manager. + + + + + + +**Parameters**: + +* **name**: Variable name. +* **label**: Variable label. + + + +**Parameters**: + +* BSTR **name** +* BSTR **label** + +**Return type**: void + + +### Function setInput + +![][public] + +``` +void ModelCenter::IJobManager::setInput(long run, BSTR name, BSTR value) +``` + + + +Sets the value for a specified input variable for a specified run. + + + + + + +**Parameters**: + +* **run**: Index of the run this is to apply to (0-based index). +* **name**: Name of the specified variable. +* **value**: Value for the specified variable to run for this specified run. + + + +**Parameters**: + +* long **run** +* BSTR **name** +* BSTR **value** + +**Return type**: void + + +### Function addOutput + +![][public] + +``` +void ModelCenter::IJobManager::addOutput(BSTR name, BSTR label) +``` + + + +Adds an output to all runs in the Job Manager. + + + + + + +**Parameters**: + +* **name**: Variable name. +* **label**: Variable label. + + + +**Parameters**: + +* BSTR **name** +* BSTR **label** + +**Return type**: void + + +### Function getValidateAll + +![][public] + +``` +boolean ModelCenter::IJobManager::getValidateAll() +``` + + + +Whether or not the Job Manager will validate everything. + + + + + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Return type**: boolean + + +### Function setValidateAll + +![][public] + +``` +void ModelCenter::IJobManager::setValidateAll(boolean flag) +``` + + + +Sets whether or not the Job Manager will validate everything. + + + + + + +**Parameters**: + +* **flag**: yes(TRUE) or no(FALSE). + + + +**Parameters**: + +* boolean **flag** + +**Return type**: void + + +### Function getNumRuns + +![][public] + +``` +long ModelCenter::IJobManager::getNumRuns() +``` + + + +Gets the number of runs currently in the job matrix. + + + + + + +**Returns**: + +The number of runs. + + + +**Return type**: long + + +### Function setNumRuns + +![][public] + +``` +void ModelCenter::IJobManager::setNumRuns(long numRuns) +``` + + + +Sets the number of runs that will take place in this job matrix. + + + + + + +**Parameters**: + +* **numRuns**: Number of runs. + + + +**Parameters**: + +* long **numRuns** + +**Return type**: void + + +### Function submit + +![][public] + +``` +void ModelCenter::IJobManager::submit(IDispatch *dataCollector, [optional]VARIANT description, [optional]VARIANT fireAndForget) +``` + + + +Causes the run matrix to begin. + + + + + + +**Parameters**: + +* **dataCollector**: IDispatch* to an [IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) object. +* **description**: The type of trade study to be run. +* **fireAndForget**: Flag for whether fire-n-forget is enabled + + + +**Parameters**: + +* IDispatch * **dataCollector** +* _[optional]_ VARIANT **description** +* _[optional]_ VARIANT **fireAndForget** + +**Return type**: void + + +### Function waitForJobCompletion + +![][public] + +``` +void ModelCenter::IJobManager::waitForJobCompletion() +``` + + + +Waits until the current run matrix has completed before continuing. + + + +**Return type**: void + + +### Function addRerun + +![][public] + +``` +void ModelCenter::IJobManager::addRerun(long run) +``` + + + +The job manager may alternately be used to re-run runs out of an existing Data Collector or Data Explorer object. Simply call this function for each run which should be run. When using the Job Manager in this form, do not use addInput, addOutput, setInput or setNumRuns. + + + + + + +**Parameters**: + +* **run**: 0 based run number to add to the re-run list. + + + +**Parameters**: + +* long **run** + +**Return type**: void + + +### Function halt + +![][public] + +``` +void ModelCenter::IJobManager::halt(boolean halt) +``` + + + +Halt the running job in the Job Manager. + + + + + + +**Parameters**: + +* **halt**: Whether to halt the job or not. + + + +**Parameters**: + +* boolean **halt** + +**Return type**: void + + +### Function getNumInputs + +![][public] + +``` +long ModelCenter::IJobManager::getNumInputs() +``` + + + +Retrieve the number of inputs in the job. + + + + + + +**Returns**: + +The number of inputs. + + + +**Return type**: long + + +### Function getNumOutputs + +![][public] + +``` +long ModelCenter::IJobManager::getNumOutputs() +``` + + + +Retrieve the number of outputs in the job. + + + + + + +**Returns**: + +The number of outputs. + + + +**Return type**: long + + +### Function getInput + +![][public] + +``` +BSTR ModelCenter::IJobManager::getInput(long index) +``` + + + +Get the specified input. + + + + + + +**Parameters**: + +* **index**: The index of the input to fetch. + + +**Returns**: + +The input. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + + +### Function getOutput + +![][public] + +``` +BSTR ModelCenter::IJobManager::getOutput(long index) +``` + + + +Get the specified output. + + + + + + +**Parameters**: + +* **index**: The index of the output to fetch. + + +**Returns**: + +The output. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + + +### Function getInputLabel + +![][public] + +``` +BSTR ModelCenter::IJobManager::getInputLabel(long index) +``` + + + +Get the label of the specified input. + + + + + + +**Parameters**: + +* **index**: The index of the input to fetch. + + +**Returns**: + +The label of the input. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + + +### Function getOutputLabel + +![][public] + +``` +BSTR ModelCenter::IJobManager::getOutputLabel(long index) +``` + + + +Get the label of the specified output. + + + + + + +**Parameters**: + +* **index**: The index of the output to fetch. + + +**Returns**: + +The label of the output. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + + +### Function getNumThreads + +![][public] + +``` +long ModelCenter::IJobManager::getNumThreads() +``` + + + +Get the number of threads to use when running in parallel. + + + + + + +**Returns**: + +The number of threads to use + + + +**Return type**: long + + +### Function getRunInParallel + +![][public] + +``` +boolean ModelCenter::IJobManager::getRunInParallel() +``` + + + +Determine whether or not to run the job in parallel. + + + + + + +**Returns**: + +true if the job is to be ran in parallel false otherwise. + + + +**Return type**: boolean + + +### Function setNumThreads + +![][public] + +``` +void ModelCenter::IJobManager::setNumThreads(long numThreads) +``` + + + +Set the number of threads to use if the job is to be ran in parallel. + + + + + + +**Parameters**: + +* **numThreads**: the number of threads to use + + + +**Parameters**: + +* long **numThreads** + +**Return type**: void + + +### Function setRunInParallel + +![][public] + +``` +void ModelCenter::IJobManager::setRunInParallel(boolean runInParallel) +``` + + + +Tell the job manager to run the job in parallel. + + + + + + +**Parameters**: + +* **runInParallel**: true if the job is to be ran in parallel, false otherwise + + + +**Parameters**: + +* boolean **runInParallel** + +**Return type**: void + + +### Function enableCache + +![][public] + +``` +boolean ModelCenter::IJobManager::enableCache(boolean enable) +``` + + + +Method to tell the job manager to enable or disable using cache for submitted designs. If you disable the cache, runs may be purged from the cache lookup either immediately or after subsequent runs. + + + + + + +**Parameters**: + +* **enable**: true if run values could be get from cache, if false, all submitted runs are to be executed. + + +**Returns**: + +Previous setting. + + + +**Parameters**: + +* boolean **enable** + +**Return type**: boolean + + +### Function clearCache + +![][public] + +``` +void ModelCenter::IJobManager::clearCache() +``` + + + +Method to actively clear job manager's internal cache of executed runs. + + + +**Return type**: void + + +### Function getRunIndex + +![][public] + +``` +long ModelCenter::IJobManager::getRunIndex(VARIANT names, VARIANT values) +``` + + + +Method to get Run Index for the given design from cache. Only works if you've been running jobs with the run cache enabled. + + + + + + +**Parameters**: + +* **names**: array of variable names for the design +* **values**: array of values corresponding to the names array + + +**Returns**: + +index of design in data explorer if design found else -1
+ + + +**Parameters**: + +* VARIANT **names** +* VARIANT **values** + +**Return type**: long + + +### Function resume + +![][public] + +``` +void ModelCenter::IJobManager::resume(IDispatch *dataHistory) +``` + + + +Pick up from the last checkpoint in a data history. If you subsequently pass a data collector, data explorer, or data history to [submit()](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad1b204f5e684c57b28dc1e3dc733e285), you should be sure to pass one with the same data history or all restored runs will be lost. Note: this function merely loads the run cache; it does not actually submit any runs. You must still specify the runs to perform and call [submit()](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager_1ad1b204f5e684c57b28dc1e3dc733e285) in order to continue evaluation. +**Parameters**: + +* **dataHistory**: the Data History to restore from; if null uses the current data history; if non-null this becomes the current data history; you may pass a data explorer or data collector instead + + + +**Parameters**: + +* IDispatch * **dataHistory** + +**Return type**: void + + +### Function setCustomMetadata + +![][public] + +``` +void ModelCenter::IJobManager::setCustomMetadata(BSTR name, BSTR key, BSTR value) +``` + + + +Add custom metadata to a variable. + + + + + + +**Parameters**: + +* **name**: Variable name. +* **key**: the key of the metadata to add +* **value**: the value of the metadata to add. + + + +**Parameters**: + +* BSTR **name** +* BSTR **key** +* BSTR **value** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ILogger.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ILogger.md index f1969eb43d..b26760d240 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ILogger.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ILogger.md @@ -1,310 +1,309 @@ - -# Interface ModelCenter::ILogger - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6487) - - - -A set of methods for logging status and error messages. ILogger has 5 levels: TRACE, DEBUG, INFO, WARN, and ERROR. - -## Members - -* [debug](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a1ff316d9091c838bcbdeaf5706e8216e) -* [error](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a576c679c95d7e5c38917bcc0bab46296) -* [info](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a0a400bf773ffc4fd5d9c4440fd2d79da) -* [isDebugEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1adc9ab6356bfc5c95aad04ee887c21588) -* [isErrorEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1aea7f6bb4163869086c07a72b5ec14666) -* [isInfoEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a4472be2e0c0f6302d2e73ad582fe6b9c) -* [isTraceEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1acef00afc02324874e8ff47c61dfb4455) -* [isWarnEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1aeeb727ee61ec84c356257e23c8ac72da) -* [trace](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a97945d07f653d3cb3e483b512f7c569d) -* [warn](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1acf5456282ad4295bfbb5dc3d6c41b8b2) - -## Public functions - - -### Function isTraceEnabled - -![][public] - -``` -boolean ModelCenter::ILogger::isTraceEnabled() -``` - - - -Returns whether the TRACE level is enabled for this logger. - - - - - - -**Returns**: - -true or false - - - -**Return type**: boolean - - -### Function isDebugEnabled - -![][public] - -``` -boolean ModelCenter::ILogger::isDebugEnabled() -``` - - - -Returns whether the DEBUG level is enabled for this logger. - - - - - - -**Returns**: - -true or false - - - -**Return type**: boolean - - -### Function isInfoEnabled - -![][public] - -``` -boolean ModelCenter::ILogger::isInfoEnabled() -``` - - - -Returns whether the INFO level is enabled for this logger. - - - - - - -**Returns**: - -true or false - - - -**Return type**: boolean - - -### Function isWarnEnabled - -![][public] - -``` -boolean ModelCenter::ILogger::isWarnEnabled() -``` - - - -Returns whether the WARN level is enabled for this logger. - - - - - - -**Returns**: - -true or false - - - -**Return type**: boolean - - -### Function isErrorEnabled - -![][public] - -``` -boolean ModelCenter::ILogger::isErrorEnabled() -``` - - - -Returns whether the ERROR level is enabled for this logger. - - - - - - -**Returns**: - -true or false - - - -**Return type**: boolean - - -### Function trace - -![][public] - -``` -void ModelCenter::ILogger::trace(BSTR message) -``` - - - -Logs a message at the TRACE level. - - - - - - -**Parameters**: - -* **message**: The message to log. - - - -**Parameters**: - -* BSTR **message** - -**Return type**: void - - -### Function debug - -![][public] - -``` -void ModelCenter::ILogger::debug(BSTR message) -``` - - - -Logs a message at the DEBUG level. - - - - - - -**Parameters**: - -* **message**: The message to log. - - - -**Parameters**: - -* BSTR **message** - -**Return type**: void - - -### Function info - -![][public] - -``` -void ModelCenter::ILogger::info(BSTR message) -``` - - - -Logs a message at the INFO level. - - - - - - -**Parameters**: - -* **message**: The message to log. - - - -**Parameters**: - -* BSTR **message** - -**Return type**: void - - -### Function warn - -![][public] - -``` -void ModelCenter::ILogger::warn(BSTR message) -``` - - - -Logs a message at the WARN level. - - - - - - -**Parameters**: - -* **message**: The message to log. - - - -**Parameters**: - -* BSTR **message** - -**Return type**: void - - -### Function error - -![][public] - -``` -void ModelCenter::ILogger::error(BSTR message) -``` - - - -Logs a message at the ERROR level. - - - - - - -**Parameters**: - -* **message**: The message to log. - - - -**Parameters**: - -* BSTR **message** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::ILogger + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6487) + + + +A set of methods for logging status and error messages. ILogger has 5 levels: TRACE, DEBUG, INFO, WARN, and ERROR. + +## Members + +* [debug](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a1ff316d9091c838bcbdeaf5706e8216e) +* [error](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a576c679c95d7e5c38917bcc0bab46296) +* [info](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a0a400bf773ffc4fd5d9c4440fd2d79da) +* [isDebugEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1adc9ab6356bfc5c95aad04ee887c21588) +* [isErrorEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1aea7f6bb4163869086c07a72b5ec14666) +* [isInfoEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a4472be2e0c0f6302d2e73ad582fe6b9c) +* [isTraceEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1acef00afc02324874e8ff47c61dfb4455) +* [isWarnEnabled](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1aeeb727ee61ec84c356257e23c8ac72da) +* [trace](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1a97945d07f653d3cb3e483b512f7c569d) +* [warn](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger_1acf5456282ad4295bfbb5dc3d6c41b8b2) + +## Public functions + + +### Function isTraceEnabled + +![][public] + +``` +boolean ModelCenter::ILogger::isTraceEnabled() +``` + + + +Returns whether the TRACE level is enabled for this logger. + + + + + + +**Returns**: + +true or false + + + +**Return type**: boolean + + +### Function isDebugEnabled + +![][public] + +``` +boolean ModelCenter::ILogger::isDebugEnabled() +``` + + + +Returns whether the DEBUG level is enabled for this logger. + + + + + + +**Returns**: + +true or false + + + +**Return type**: boolean + + +### Function isInfoEnabled + +![][public] + +``` +boolean ModelCenter::ILogger::isInfoEnabled() +``` + + + +Returns whether the INFO level is enabled for this logger. + + + + + + +**Returns**: + +true or false + + + +**Return type**: boolean + + +### Function isWarnEnabled + +![][public] + +``` +boolean ModelCenter::ILogger::isWarnEnabled() +``` + + + +Returns whether the WARN level is enabled for this logger. + + + + + + +**Returns**: + +true or false + + + +**Return type**: boolean + + +### Function isErrorEnabled + +![][public] + +``` +boolean ModelCenter::ILogger::isErrorEnabled() +``` + + + +Returns whether the ERROR level is enabled for this logger. + + + + + + +**Returns**: + +true or false + + + +**Return type**: boolean + + +### Function trace + +![][public] + +``` +void ModelCenter::ILogger::trace(BSTR message) +``` + + + +Logs a message at the TRACE level. + + + + + + +**Parameters**: + +* **message**: The message to log. + + + +**Parameters**: + +* BSTR **message** + +**Return type**: void + + +### Function debug + +![][public] + +``` +void ModelCenter::ILogger::debug(BSTR message) +``` + + + +Logs a message at the DEBUG level. + + + + + + +**Parameters**: + +* **message**: The message to log. + + + +**Parameters**: + +* BSTR **message** + +**Return type**: void + + +### Function info + +![][public] + +``` +void ModelCenter::ILogger::info(BSTR message) +``` + + + +Logs a message at the INFO level. + + + + + + +**Parameters**: + +* **message**: The message to log. + + + +**Parameters**: + +* BSTR **message** + +**Return type**: void + + +### Function warn + +![][public] + +``` +void ModelCenter::ILogger::warn(BSTR message) +``` + + + +Logs a message at the WARN level. + + + + + + +**Parameters**: + +* **message**: The message to log. + + + +**Parameters**: + +* BSTR **message** + +**Return type**: void + + +### Function error + +![][public] + +``` +void ModelCenter::ILogger::error(BSTR message) +``` + + + +Logs a message at the ERROR level. + + + + + + +**Parameters**: + +* **message**: The message to log. + + + +**Parameters**: + +* BSTR **message** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ILoginCallback.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ILoginCallback.md index f200c9cb45..408238fc47 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ILoginCallback.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ILoginCallback.md @@ -1,124 +1,123 @@ - -# Interface ModelCenter::ILoginCallback - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 4918) - - - -The Login Callback allows non-ModelCenter processes to hook into [ModelCenter](namespaceModelCenter.md#namespaceModelCenter)'s authentication. Primarily used when running [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) in server mode. - -## Members - -* [loginSucceeded](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback_1a4b7dc5df7be75023f025f8d83fff7579) -* [requestAuthCredentials](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback_1a9a1b24d936f4ee5dd2979ad38538929b) -* [verifySslWarning](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback_1a9c27b392b3c109f6abe689251e1e27c7) - -## Public functions - - -### Function requestAuthCredentials - -![][public] - -``` -boolean ModelCenter::ILoginCallback::requestAuthCredentials(BSTR uri, boolean isFailedAttempt, VARIANT *username, VARIANT *password, VARIANT *savePassword) -``` - - - -Called when [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) needs to request a username and password. -**Parameters**: - -* **uri**: URI authenticating to -* **isFailedAttempt**: true if request is due to previous failed attempt, false otherwise -* **username**: Username to use. Cannot be null. -* **password**: Password to use. Cannot be null. -* **savePassword**: True if password should be saved, false otherwise. Cannot be null. - - -**Returns**: - -true if username/password is submitted, false otherwise - - -**Exceptions**: - -* **COM**: exception if username, password, or savePassword is null - - - -**Parameters**: - -* BSTR **uri** -* boolean **isFailedAttempt** -* VARIANT * **username** -* VARIANT * **password** -* VARIANT * **savePassword** - -**Return type**: boolean - - -### Function loginSucceeded - -![][public] - -``` -void ModelCenter::ILoginCallback::loginSucceeded(BSTR uri, BSTR username, BSTR password, boolean savePassword) -``` - - - -Called when [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) succeeds in authentication. -**Parameters**: - -* **uri**: URI successfully authenticated to -* **username**: username that successfully authenticated -* **password**: password that successfully authenticated -* **savePassword**: true if password should be saved, false otherwise - - - -**Parameters**: - -* BSTR **uri** -* BSTR **username** -* BSTR **password** -* boolean **savePassword** - -**Return type**: void - - -### Function verifySslWarning - -![][public] - -``` -boolean ModelCenter::ILoginCallback::verifySslWarning(BSTR msg) -``` - - - -Called when [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) needs an SSL warning to be verified/accepted. -**Parameters**: - -* **msg**: message to display to user - - -**Returns**: - -true if [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) should proceed, false otherwse - - - -**Parameters**: - -* BSTR **msg** - -**Return type**: boolean - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::ILoginCallback + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 4918) + + + +The Login Callback allows non-ModelCenter processes to hook into [ModelCenter](namespaceModelCenter.md#namespaceModelCenter)'s authentication. Primarily used when running [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) in server mode. + +## Members + +* [loginSucceeded](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback_1a4b7dc5df7be75023f025f8d83fff7579) +* [requestAuthCredentials](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback_1a9a1b24d936f4ee5dd2979ad38538929b) +* [verifySslWarning](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback_1a9c27b392b3c109f6abe689251e1e27c7) + +## Public functions + + +### Function requestAuthCredentials + +![][public] + +``` +boolean ModelCenter::ILoginCallback::requestAuthCredentials(BSTR uri, boolean isFailedAttempt, VARIANT *username, VARIANT *password, VARIANT *savePassword) +``` + + + +Called when [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) needs to request a username and password. +**Parameters**: + +* **uri**: URI authenticating to +* **isFailedAttempt**: true if request is due to previous failed attempt, false otherwise +* **username**: Username to use. Cannot be null. +* **password**: Password to use. Cannot be null. +* **savePassword**: True if password should be saved, false otherwise. Cannot be null. + + +**Returns**: + +true if username/password is submitted, false otherwise + + +**Exceptions**: + +* **COM**: exception if username, password, or savePassword is null + + + +**Parameters**: + +* BSTR **uri** +* boolean **isFailedAttempt** +* VARIANT * **username** +* VARIANT * **password** +* VARIANT * **savePassword** + +**Return type**: boolean + + +### Function loginSucceeded + +![][public] + +``` +void ModelCenter::ILoginCallback::loginSucceeded(BSTR uri, BSTR username, BSTR password, boolean savePassword) +``` + + + +Called when [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) succeeds in authentication. +**Parameters**: + +* **uri**: URI successfully authenticated to +* **username**: username that successfully authenticated +* **password**: password that successfully authenticated +* **savePassword**: true if password should be saved, false otherwise + + + +**Parameters**: + +* BSTR **uri** +* BSTR **username** +* BSTR **password** +* boolean **savePassword** + +**Return type**: void + + +### Function verifySslWarning + +![][public] + +``` +boolean ModelCenter::ILoginCallback::verifySslWarning(BSTR msg) +``` + + + +Called when [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) needs an SSL warning to be verified/accepted. +**Parameters**: + +* **msg**: message to display to user + + +**Returns**: + +true if [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) should proceed, false otherwse + + + +**Parameters**: + +* BSTR **msg** + +**Return type**: boolean + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IModelCenter.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IModelCenter.md index 1dd6460b7d..2d09aef857 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IModelCenter.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IModelCenter.md @@ -1,3958 +1,3957 @@ - -# Interface ModelCenter::IModelCenter - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3947) - - - -COM instance. - - - - - - -**ModelCenter batch mode**: - -This example demonstrates invoking ModelCenter and running a Model in batch mode through the COM API. -``` -Dim mc -Set mc=CreateObject("ModelCenter.Application") -mc.loadModel "c:\testmodel.pxc" -' -Dim x -Dim s -For x=0 To 10 - mc.setValue "Model.Linear.x", x - s=s & "x=" & x & ", y=" & mc.getValue("Model.Linear.y") & vbNewLine -Next -msgbox s -``` - - -**Example ModelCenter Script**: - -This script demonstrates how to automate ModelCenter to create a Model.
-First, a new Model is loaded into ModelCenter, two components are instantiated, and then several links are created.
-Last, the Model is saved to a .pxc file. -``` -' This is a test script that automates the creation of a Model -' -' -------------------- start ModelCenter -' -Dim app -Set app = WScript.CreateObject("ModelCenter.Application") -' -' -------------------- start a new Model -' -app.newModel -' -' -------------------- instantiate a few components -' -app.createComponent "mcre://localhost/Block", "block", "Model" -app.createComponent "mcre://localhost/Block", "block1", "Model" -' -' -------------------- create some links -' -app.createLink "Model.block.width", "Model.block1.width" -app.createLink "Model.block.height", "Model.block1.width + Model.block1.height" -' -' -------------------- save the file -' -file = "c:\model.pxc" -app.saveModelAs(file) -``` - - -**Example DOE Script**: - -This script demonstrates how to call ModelCenter to perform a DOE.
-The script loads a Model into ModelCenter, and then repeatedly sets and gets values to perform the DOE. -``` -' -' This is a test script that performs a DOE using ModelCenter. To -' run the script, type "cscript DOE.vbs" -' -' -' -------------------- start ModelCenter -' -Dim app -Set app = WScript.CreateObject( "ModelCenter.Application" ) -' -' -------------------- load a file -' -file = "d:\model.pxc" -app.loadFile file -' -' -------------------- setup a DOE table -' -numTrials = 4 -numInputs = 2 -numOutputs = 2 -Dim inputs(2) -inputs(0) = "script.VBScript.a" -inputs(1) = "script.VBScript.b" -Dim outputs(2) -outputs(0) = "script.VBScript.c" -outputs(1) = "script.VBScript.d" -Dim trials(4,2) -trials(0,0) = 5 -trials(0,1) = 2 -trials(1,0) = 4 -trials(1,1) = 2 -trials(2,0) = 5 -trials(2,1) = 3 -trials(3,0) = 4 -trials(3,1) = 3 -' -' -------------------- perform the runs -' -' print a header -msg = "" -For var = 0 To numInputs-1 - msg = msg & inputs(var) & " " -Next -For var = 0 To numOutputs-1 - msg = msg & outputs(var) & " " -Next -' print the values -WScript.echo msg -' collect and print values -For i = 0 To numTrials-1 - ' create a message - msg = "" - ' set the input values - For var = 0 To numInputs-1 - app.setValue inputs(var), trials(i,var) - msg = msg & trials(i,0) & " " - Next - ' get the outputs - For var = 0 To numOutputs-1 - msg = msg & app.getValue( outputs(var) ) & " " - Next - ' print the values - WScript.echo msg -Next -``` - -## Members - -* [addIcon](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ada4b443f077f7c53744ada601a3c12be) -* [addNewMacro](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a9d209b30adb83ac9fe48f8efd1959f3a) -* [appFullPath](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a999bedcb3195dc2a12b034e0fa0222ec) -* [appName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a1a5d90dca23414ddb8ef45e99c091ea4) -* [autoLink](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1adea9c027f61fb0c23ce34a0e47924679) -* [breakLink](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a231cd11fa3198cc4a22db3ee0483b59c) -* [checkout](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5ea6a58aa4def0e7d48f5c48dfc46d35) -* [checkout2](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3b8e21abd2354b4fd537084f36c9a180) -* [closeHTMLViewer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a46b4e01256fa252da2f589af87833ac1) -* [closeModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a00bcefae609c5a453dd1f4e0586820fc) -* [configureLogging](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acb8cad870e072bee4a80b1902476929a) -* [createAndInitComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a049e13b6d3ba54dd40a162a16d03bb66) -* [createAssembly](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a402db0953a58ac7573cf3585c938eafa) -* [createAssemblyVariable](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a72e28e9146e37b0854aaa3274b60362c) -* [createComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa1c2ba41e8aeff2bc97408fd6d5e8832) -* [createDataCollector](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad91dff33c09345053346ce2d831fd968) -* [createDataExplorer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3edba311337bb171b956e0d331cfa05f) -* [createDataHistoryVariable](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5f2d90be1a4bed0126993b3021d24981) -* [createDataMonitor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad86e8cd5714f0d22dc84b1b71979fdc5) -* [createJobManager](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5878e18adeeafe78c1920e5544253442) -* [createLink](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac46503f8f560edbcddd87fb9c9045326) -* [createPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1afb0f2d3715e4a48c1ee1c865864c5314) -* [createPlugInFrame2](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acd338a67839da36df138a0521ee3aead) -* [createTradeStudy](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab18e9a5fa259695357cd26f155ee95dd) -* [destroyPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a24cc8bd489975150c9d5c5c3e9502b87) -* [displayAboutBox](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa9057344d6d2ffc28569709efdbdb5ad) -* [displayPreferencesDialog](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae8f7829bf075209faf0fcecf742e76be) -* [dumpComDebug](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a27b453e8058a238c25049c8fcb5121e4) -* [exit](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aba655ef2cf9a8f639acde2697d8319a2) -* [getActiveJobManager](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a931fee19976a7a03e263284ec0ee9d53) -* [getAssembly](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a461a8c0e8efdd3353da6feb22b232029) -* [getAssemblyStyle](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab1d7ce6494121cd997115f91e91d795a) -* [getComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a779902b1a3f3c4c0db2b58484ec75fe0) -* [getDataCollector](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a29b8af2a820e24e728425e6467881067) -* [getDataCollectorForDataExplorer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a59b46ca7b15c869fb190ecfeb70bf90a) -* [getDataExplorer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae1bdc8f0abc612490b737852f189027a) -* [getDataMonitor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a6212fa2f41e2132f8f40d78164059eb7) -* [getFileSystemInfo](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a6d6d38245d99b3f53fda689a1adee17f) -* [getFormatter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a1533da4a5c2e70aa5b196215af7637bc) -* [getGlobalParameters](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2fac8021991150ab97e3673e4b0c0dc1) -* [getHaltStatus](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa75908bb0ec202342833c666b10fcb66) -* [getHWND](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aaaa18b9967d91f5e9afa0f663fb4ddae) -* [getLastErrorMessage](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5a57f078a8de6d78e6cc4f808c761fe8) -* [getLicensingPath](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af5bdeb0442c6f35c0e5db849b1a166fd) -* [getLinks](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac83decf1799275a0d13ecadeffb008cd) -* [getLogger](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af2d28cb0c0290a80ebe0e31f91497f11) -* [getMacroScript](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a16bc3b79ea75a2c2e9c6aaf48591f840) -* [getMacroScriptLanguage](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8c930544d5f9fc2e49afb076b5ccee76) -* [getMacroTimeout](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a18766ae9a0fda73f8febdb709adfceea) -* [getModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5d42323e20b243257f4cef533dd58e7d) -* [getModelCenterPath](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1adc47ef3cf5fa8d766117ec19c7dfab92) -* [getModelUUID](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a499de038ba95ad40b52862e5239bf18c) -* [getNetworkLocations](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a375ab85c506633857e960502c208ed79) -* [getNumUnitCategories](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a0f6aab6d238cbe899af59725ab0de842) -* [getNumUnits](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad6a35e6ac78e89ddcd4a68023bcdd651) -* [getPreference](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aadc031780e0355e1ca2bba83cb13441a) -* [getRunOnlyMode](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a38682504615aef9e603a9c2f3d4bd2e8) -* [getUnitCategoryName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1abe07ee5b95ed640b926a165f2e02b7f1) -* [getUnitName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aab8bb46de63e10f150e9614ea36d0b9a) -* [getValue](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8cacc6c81e217bf7affe180a59d21455) -* [getValueAbsolute](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a04408aef2e249b325db44eb8e0ca6758) -* [getVariable](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af87c3dde3f5645f1257ba0edb037889b) -* [getVariableMetaData](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aebbf42a396f1eea5b917d13b85e0fb8e) -* [getXMLExtension](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af94e33f84d46652cfad0af931db0d59b) -* [guiCloseAllMultiplexers](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8708a9033fcd77731539b085a1c6c047) -* [guiLoadFile](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a255ea30feb95451802aa280bdffcd7b8) -* [guiSaveModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8ad33e25dfad91e8ba248d399a1b6449) -* [halt](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a4cde569f8ca3555ede7fd8d3d2cd4387) -* [hidePlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a806cc1860aaadaa5496d4caa0a51fe91) -* [HTMLViewerGetMyHWND](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad6f56123c0b435ffca19628deaa4169f) -* [HTMLViewerWaitForClose](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad62471b3a17a7b182d7f8fa0df7048b7) -* [internalLicensing](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae91fcfa7f9dfe5fa3df62fb9d3c703c8) -* [invokeHelp](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2a8f95eb131aad5e03597ada8251ef30) -* [IsInteractive](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7fc1e5b5a0eee411b82f7508243f453f) -* [isOkToClose](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af91d7535a069da55220c52b759ca5238) -* [launchDataCollectorPlugIn](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a434995395fc673c8197bfde7e1256240) -* [launchHTMLViewer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aae5eb45abe323ca501a777f31b9ae5b8) -* [launchMacroEditor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab180eb62170146926e7a6c2384d5ad66) -* [launchTradeStudy](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a24726ff2cf91ef85884d6b2bea513ed4) -* [loadFile](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a21295b971e1a8854d7524b85332fcb3b) -* [loadModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab57546e9e718895bbdfa25bc1b7d1e9d) -* [MessageBox](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa31343d27c063cc384336028b12abac2) -* [modelDirectory](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1adf58dfafa5401318de434c22d9e12ef3) -* [modelFileName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1abb83f0e9475f2ccf8de46b09946d79e3) -* [moveComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a70986fc1018ab96fdbd507b4ebe568fc) -* [newModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a90ad7c497e4da5b9474d747ba6bd9715) -* [parallelInstance](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7dc06d52fa432893eaf74db606db3864) -* [ProcessID](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acb08040260ee9e91a9a455c15d9fc0ad) -* [removeComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7bbd736a48c08e2eb90c4af45872e6f5) -* [removeDataMonitor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2dd2279b4d0250af8ae6d3506f55c57a) -* [run](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a158d8bbb37d23dd35bbf87b1340c95d6) -* [runAntFile](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2d684049210e4062f14cf2e3e2abb031) -* [runMacro](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a762c9d09a2d611300bc3e09f9891c86e) -* [SAFEARRAY](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa2ca200dd05dc8257c35af74035459e1) -* [saveModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a16dc53d7c16d4517b6859acc1ee25a50) -* [saveModelAs](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab3fcf686594e1e2f81b7814bab8a6752) -* [saveTradeStudy](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af139d41f66681c63c80243adbd48cbc0) -* [saveVersionedModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac658a0c1392f2fd8b851794c9ac1896f) -* [saveVersionedModelAs](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab65847c07b712a58acfe6a21659518b5) -* [screenUpdating](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acc9b3db9f6b75b711cf8106947576e89) -* [setAlternateParentFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a83b97e8dd461f4bc8fbe5cdc63809b74) -* [setAssemblyStyle](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af1bef892aa57d153cd63b6f4ba9037f4) -* [setIconPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a65a6502ad779fd4394d06f45adabc398) -* [setLoginCallback](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a156c716bde56ad5bc070f00e2037a2da) -* [setMacroScript](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae2b0614b8c0367ab7893c5fb32e14b96) -* [setMacroScriptLanguage](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7b92a22213e11d5f4b3ad8dfe7a894f9) -* [setMacroTimeout](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a559cd3b9f0e68e5ecc2c4006c8014667) -* [setPassword](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a677e2965bfb8998dc4546673f95355de) -* [setPreference](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac7c886a8b0333b565333d6b16d9ab824) -* [setRunOnlyMode](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aba91dde2a4c0674816c3781ed873457e) -* [setScheduler](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa312b4e6e4585bd0f4d7cc9a69d1d7ec) -* [setUserName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a359b38b4b8bc935b9eb5cf9e68a3a34f) -* [setValue](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a535535c056577a2306bfd089423a6e8b) -* [setXMLExtension](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a70666088b3363b2c9738cd15ec446d8e) -* [showFileBrowseDialog](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a9dabff9569cfbb6c65ccdae26aab3ff7) -* [showFileSaveDialog](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a23ea9bc699e8f31401f96d2594f79ae6) -* [showPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad1fc33915ad5917cd645e795251f01de) -* [startGUIMode](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a06c77786a3965c9ca7c72c6ba7af7ad3) -* [tradeStudyEnd](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a85f4a4b6557102133fc5dad3ef0a1ff8) -* [tradeStudyStart](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a39de949b1cdace01114ee9391fc4a484) -* [transformAVPoint](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a23a3683a4c5b5f4380e33232e2ca30be) -* [unAssociatedInstance](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a21a60528e3b43cbbbbc131adaf5a1151) -* [version](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3072c85db32956a1c302668a49b031f8) - -## Properties - - -### Property modelDirectory - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IModelCenter::modelDirectory -``` - - - -Directory of the current Model. If no model is open it will raise an error. If the model has not yet been saved, it will return an empty string. - - - -**Return type**: BSTR - - -### Property screenUpdating - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IModelCenter::screenUpdating -``` - - - -Whether or not screen updating is turned on. - - - -**Return type**: boolean - - -### Property modelFileName - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IModelCenter::modelFileName -``` - - - -The Full path of the current ModelCenter Model. - - - -**Return type**: BSTR - - -### Property appName - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IModelCenter::appName -``` - - - -Gets the [Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) name - - - - - - -**Returns**: - -[Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) name - - - -**Return type**: BSTR - - -### Property appFullPath - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IModelCenter::appFullPath -``` - - - -Gets the full path to the application. - - - -**Return type**: BSTR - - -### Property IsInteractive - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BOOL ModelCenter::IModelCenter::IsInteractive -``` - - - -Is ModelCenter running in interactive/GUI mode. - - - -**Return type**: BOOL - - -### Property ProcessID - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IModelCenter::ProcessID -``` - - - -The process identifier of the [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) process. Useful for cases where [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) is running in COM server mode and a client process needs to grant it permission to do something (like move a window to the foreground). - - - -**Return type**: long - - -### Property version - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 4270) - -``` -long ModelCenter::IModelCenter::version -``` - - - -Gets the version number of ModelCenter. ModelCenter versions are in the form 5.1.2 where 5 is the major version, 1 is the minor, and 2 is the patch version. - - - - - - -**Parameters**: - -* **index**: Which part of the version to get. -* 0 - Get the major version number - -* 1 - Get the minor version number - -* 2 - Get the patch version number - - -**Returns**: - -The requested version part. - - - -**Return type**: long - -## Public functions - - -### Function getLastErrorMessage - -![][public] - -``` -BSTR ModelCenter::IModelCenter::getLastErrorMessage() -``` - - - -Gets the last error message. - - - - - - -**Returns**: - -The last error message. - - - -**Return type**: BSTR - - -### Function loadFile - -![][public] - -``` -void ModelCenter::IModelCenter::loadFile(BSTR fileName, [optional]VARIANT onConnectError) -``` - - - -Loads a .pxc file. - - - - - - -**Parameters**: - -* **fileName**: Path of the .pxc file. -* **onConnectError**: States what to do when a connect error is encountered.
- (see [OnConnectionErrorMode](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2) for error modes, default is CONN_ERR_ERROR). - - - -**Parameters**: - -* BSTR **fileName** -* _[optional]_ VARIANT **onConnectError** - -**Return type**: void - - -### Function setValue - -![][public] - -``` -void ModelCenter::IModelCenter::setValue(BSTR varName, BSTR value) -``` - - - -Sets the value of a variable. - - - - - - -**Parameters**: - -* **varName**: Full ModelCenter path of the variable. -* **value**: The new value. - - - -**Parameters**: - -* BSTR **varName** -* BSTR **value** - -**Return type**: void - - -### Function getValue - -![][public] - -``` -VARIANT ModelCenter::IModelCenter::getValue(BSTR varName) -``` - - - -Gets the value of a variable. - - - - - - -**Parameters**: - -* **varName**: Full ModelCenter path of the variable. - - -**Returns**: - -The value as a variant. - - - -**Parameters**: - -* BSTR **varName** - -**Return type**: VARIANT - - -### Function createComponent - -![][public] - -``` -void ModelCenter::IModelCenter::createComponent(BSTR serverPath, BSTR name, BSTR parent, [optional]VARIANT xPos, [optional]VARIANT yPos) -``` - - - -Creates, or connects, to a new MCRE Component. - - - - - - -**Parameters**: - -* **serverPath**: The MCRE source path of the new component. -* **name**: Name of the new component. -* **parent**: Parent assembly of the component. -* **xPos**: The x-position in pixels in the Analysis View. -* **yPos**: The y-position in pixels in the Analysis View. - - - -**Parameters**: - -* BSTR **serverPath** -* BSTR **name** -* BSTR **parent** -* _[optional]_ VARIANT **xPos** -* _[optional]_ VARIANT **yPos** - -**Return type**: void - - -### Function createLink - -![][public] - -``` -void ModelCenter::IModelCenter::createLink(BSTR variable, BSTR equation) -``` - - - -Creates a link to the specified variable based on the specified equation. - - - - - - -**Parameters**: - -* **variable**: Variable to add the link to. -* **equation**: Equation of the link. - - - -**Parameters**: - -* BSTR **variable** -* BSTR **equation** - -**Return type**: void - - -### Function newModel - -![][public] - -``` -void ModelCenter::IModelCenter::newModel([optional]VARIANT modelType) -``` - - - -Creates a new Model. - - - - - - -**Parameters**: - -* **modelType**:
- - - -**Parameters**: - -* _[optional]_ VARIANT **modelType** - -**Return type**: void - - -### Function saveModel - -![][public] - -``` -void ModelCenter::IModelCenter::saveModel() -``` - - - -Saves the current Model. - - - -**Return type**: void - - -### Function saveModelAs - -![][public] - -``` -void ModelCenter::IModelCenter::saveModelAs(BSTR fileName) -``` - - - -Saves the current Model to a specified file. - - - - - - -**Parameters**: - -* **fileName**: Path to save the Model in. - - - -**Parameters**: - -* BSTR **fileName** - -**Return type**: void - - -### Function closeModel - -![][public] - -``` -void ModelCenter::IModelCenter::closeModel() -``` - - - -Closes the current Model. - - - -**Return type**: void - - -### Function loadModel - -![][public] - -``` -void ModelCenter::IModelCenter::loadModel(BSTR fileName, [optional]VARIANT onConnectError) -``` - - - -Loads a .pxc file. - - - - - - -**Parameters**: - -* **fileName**: Path of the .pxc file. -* **onConnectError**: States what to do when a connect error is encountered.
- (see [OnConnectionErrorMode](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2) for error modes, default is CONN_ERR_ERROR). - - - -**Parameters**: - -* BSTR **fileName** -* _[optional]_ VARIANT **onConnectError** - -**Return type**: void - - -### Function getVariable - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::getVariable(BSTR name) -``` - - - -Gets a pointer to a variable. - - - - - - -**Parameters**: - -* **name**: Full ModelCenter path of the variable. - - -**Returns**: - -IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: IDispatch * - - -### Function getComponent - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::getComponent(BSTR name) -``` - - - -Gets a pointer to the Component. - - - - - - -**Parameters**: - -* **name**: Full ModelCenter path of the Component. - - -**Returns**: - -IDispatch* to an [IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) object. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: IDispatch * - - -### Function exit - -![][public] - -``` -void ModelCenter::IModelCenter::exit() -``` - - - -Deprecated. -**Deprecated**: - -No longer used. - - - -**Return type**: void - - -### Function createDataCollector - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::createDataCollector(BSTR tradeStudyType, BSTR setup) -``` - - - -Creates a new Data Collector. - - - - - - -**Parameters**: - -* **tradeStudyType**: Registry ID of the Plug-In. This is obtained by calling the [getRegID ](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac0dd856b24d06484c6ded0aba0199016) method of the IAddToModel* object that is passed into the Plug-In's construct method. -* **setup**: A string that is generated from the Plug-In's "toString" method that can be restored later by the Plug-In's "fromString" method. - - -**Returns**: - -IDispatch* to an [IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) object. - - -**Deprecated**: - -use [createDataExplorer()](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3edba311337bb171b956e0d331cfa05f) instead - - - -**Parameters**: - -* BSTR **tradeStudyType** -* BSTR **setup** - -**Return type**: IDispatch * - - -### Function tradeStudyEnd - -![][public] - -``` -void ModelCenter::IModelCenter::tradeStudyEnd() -``` - - - -Lets ModelCenter know that a Trade Study has been completed. - - - -**Return type**: void - - -### Function createJobManager - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::createJobManager([optional]VARIANT showProgressDialog) -``` - - - -Creates a new Job Manager object. - - - - - - -**Parameters**: - -* **showProgressDialog**: an optional VARIANT that specifies whether or not to show a progress dialog when creating the job manager. Possible values are: -* true to show a progress dialog and attempt to parent it to [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) - -* false to not show a progress dialog - -* a long value that corresponds to the HWND of the window to which the progress dialog should be parented
- - -**Returns**: - -IDispatch* to an [IJobManager](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **showProgressDialog** - -**Return type**: IDispatch * - - -### Function tradeStudyStart - -![][public] - -``` -void ModelCenter::IModelCenter::tradeStudyStart() -``` - - - -Lets ModelCenter know that a Trade Study has been started. - - - -**Return type**: void - - -### Function getHaltStatus - -![][public] - -``` -boolean ModelCenter::IModelCenter::getHaltStatus() -``` - - - -Finds out if the user has pressed the halt button. - - - - - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Return type**: boolean - - -### Function getModel - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::getModel() -``` - - - -Gets a pointer to the Model. - - - - - - -**Returns**: - -IDispatch* to an [IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) object. - - - -**Return type**: IDispatch * - - -### Function MessageBox - -![][public] - -``` -void ModelCenter::IModelCenter::MessageBox(BSTR msg,[optional]VARIANT force) -``` - - - -Creates a MessageBox dialog. - - - - - - -**Parameters**: - -* **msg**: Message to display in the MessageBox. -* **force**:
- - - -**Parameters**: - -* BSTR **msg** -* _[optional]_ VARIANT **force** - -**Return type**: void - - -### Function getValueAbsolute - -![][public] - -``` -VARIANT ModelCenter::IModelCenter::getValueAbsolute(BSTR varName) -``` - - - -Gets the value of a variable without validating it. - - - - - - -**Parameters**: - -* **varName**: Full ModelCenter path of the variable. - - -**Returns**: - -The value as a variant. - - - -**Parameters**: - -* BSTR **varName** - -**Return type**: VARIANT - - -### Function setScheduler - -![][public] - -``` -void ModelCenter::IModelCenter::setScheduler(BSTR scheduler) -``` - - - -Sets the current active scheduler for the Model. - - - - - - -**Parameters**: - -* **scheduler**: The scheduler type. Possible types are: -* forward - -* backward - -* mixed - -* script - -Note: all scheduler types are case sensitive. - - - -**Parameters**: - -* BSTR **scheduler** - -**Return type**: void - - -### Function removeComponent - -![][public] - -``` -void ModelCenter::IModelCenter::removeComponent(BSTR name) -``` - - - -Removes the specified component from the Model. - - - - - - -**Parameters**: - -* **name**: Full ModelCenter path of the component to remove. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: void - - -### Function breakLink - -![][public] - -``` -void ModelCenter::IModelCenter::breakLink(BSTR variable) -``` - - - -Breaks the link to a variable. - - - - - - -**Parameters**: - -* **variable**: The full ModelCenter path of the variable whose link is to be broken. - -Example demonstrating how to break a link: -``` -mc.breakLink "Model.Linear.x" -``` - - - -**Parameters**: - -* BSTR **variable** - -**Return type**: void - - -### Function getHWND - -![][public] - -``` -long ModelCenter::IModelCenter::getHWND() -``` - - - -Gets the HWND of the current ModelCenter instance. This HWND can then be used as the parent of the Plug-In GUI. - - - - - - -**Returns**: - -Value of the current HWND instance. - - - -**Return type**: long - - -### Function checkout - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::checkout(BSTR feature) -``` - - - -Checks out a license feature from FLEXlm - - - - - - -**Parameters**: - -* **feature**: the name of the feature to be checked out - - -**Returns**: - -an [IFeature](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature) object - - - -**Parameters**: - -* BSTR **feature** - -**Return type**: IDispatch * - - -### Function checkout2 - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::checkout2(BSTR feature, BSTR productRelease) -``` - - - -Checks out a license feature from FLEXlm - - - - - - -**Parameters**: - -* **feature**: the name of the feature to be checked out -* **productRelease**: the release date of the feature being passed - - -**Returns**: - -an [IFeature](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature) object - - - -**Parameters**: - -* BSTR **feature** -* BSTR **productRelease** - -**Return type**: IDispatch * - - -### Function runMacro - -![][public] - -``` -VARIANT ModelCenter::IModelCenter::runMacro(BSTR macro, [optional]VARIANT useMCObject) -``` - - - -Runs the specified macro. - - - - - - -**Parameters**: - -* **macro**: The name of the macro to run. -* **useMCObject**: whether or not to use the [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) object - - -**Returns**: - -
- - - -**Parameters**: - -* BSTR **macro** -* _[optional]_ VARIANT **useMCObject** - -**Return type**: VARIANT - - -### Function createAssembly - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::createAssembly(BSTR name, BSTR parent, [optional]VARIANT assemblyType) -``` - - - -Creates a new Assembly in the Model. - - - - - - -**Parameters**: - -* **name**: Desired name of the new Assembly. -* **parent**: Full ModelCenter path of the parent Assembly. -* **assemblyType**:
- - -**Returns**: - -IDispatch* to an [IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) object. - -Example demonstrating how to create an Assembly: -``` -Dim assembly As IAssembly -Set assembly=mc.createAssembly("myAssembly", "Model") -``` - - - -**Parameters**: - -* BSTR **name** -* BSTR **parent** -* _[optional]_ VARIANT **assemblyType** - -**Return type**: IDispatch * - - -### Function createAssemblyVariable - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::createAssemblyVariable(BSTR name, BSTR type, BSTR parent) -``` - - - -Create a new variable in an Assembly. - - - - - - -**Parameters**: - -* **name**: Desired name of the new variable. -* **type**: Type of the new variable. Possible types are: -* double - -* int - -* boolean - -* string - -* file - -* double[] - -* int[] - -* boolean[] - -* string[] - -* quadfacet - -* surfaceofrevolution - -* nurbs - -* bspline - -* ruled - -* skinned - -* vrml - -* node -* **parent**: Full ModelCenter path of the parent Assembly. - - -**Returns**: - -IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object. - -Example demonstrating how to create a variable in an existing Assembly: -``` -Dim var As IVariable -Set var=mc.createAssemblyVariable("myVar", "double", "Model") -``` - - - -**Parameters**: - -* BSTR **name** -* BSTR **type** -* BSTR **parent** - -**Return type**: IDispatch * - - -### Function autoLink - -![][public] - -``` -void ModelCenter::IModelCenter::autoLink(BSTR srcComp, BSTR destComp) -``` - - - -Automatically links two components. - - - - - - -**Parameters**: - -* **srcComp**: The source component. -* **destComp**: The destination component. - - - -**Parameters**: - -* BSTR **srcComp** -* BSTR **destComp** - -**Return type**: void - - -### Function getLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IModelCenter::getLinks([optional]VARIANT reserved) -``` - - - -Returns a list of all links in the model. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - - -### Function getModelUUID - -![][public] - -``` -BSTR ModelCenter::IModelCenter::getModelUUID() -``` - - - -Returns the unique ID string for the current model. - - - - - - -**Returns**: - -The ID string for the current model. - - - -**Return type**: BSTR - - -### Function getFormatter - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::getFormatter(BSTR format) -``` - - - -Creates a new instance of a formatter which can be used to format numbers to and from a particular string style. See documentation on [IPHXFormat.setFormat()](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1aa34d6054f4542a34efb60a961ad78519) for more information on available styles. - - - - - - -**Parameters**: - -* **format**: Specified string format for the Formatter object. - - -**Returns**: - -An IDispatch* to the [IPHXFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat) object. - - - -**Parameters**: - -* BSTR **format** - -**Return type**: IDispatch * - - -### Function invokeHelp - -![][public] - -``` -void ModelCenter::IModelCenter::invokeHelp(long pageID) -``` - - - -Invokes the specified context sensitive help item out of the ModelCenter help file. - - - - - - -**Parameters**: - -* **pageID**:
- - - -**Parameters**: - -* long **pageID** - -**Return type**: void - - -### Function launchTradeStudy - -![][public] - -``` -void ModelCenter::IModelCenter::launchTradeStudy(BSTR type, [optional]VARIANT setup) -``` - - - -Causes the specified Trade Study tool to be launched. - - - - - - -**Parameters**: - -* **type**: May be a common name, like "doe" or a fully specified URL like "common:\\tradestudy\\doe". -* **setup**:
- - - -**Parameters**: - -* BSTR **type** -* _[optional]_ VARIANT **setup** - -**Return type**: void - - -### Function createPlugInFrame - -![][public] - -``` -long ModelCenter::IModelCenter::createPlugInFrame(BSTR name, BSTR title, BSTR reserved, LPDISPATCH plugIn, [optional]VARIANT showFavorites, [optional]VARIANT defaultHeight, [optional]VARIANT defaultWidth) -``` - - - -Creates a new frame window with favorites in it which can be used by Plug-Ins as a parent window in order to integrate with ModelCenter closer and to get favorites. Currently only supports C++ Plug-Ins. - - - - - - -**Parameters**: - -* **name**: The programmatic name of the plug-in. This is used to store favorites and settings uniquely. -* **title**: The title to put on the frame -* **reserved**: Reserved, must be blank -* **plugIn**: An IDispatch to the plug-in, used to get at the to/from string to use with favorites. -* **showFavorites**:
-* **defaultHeight**: The default height of the frame. -* **defaultWidth**: The default width of the frame. - - -**Returns**: - -
- - - -**Parameters**: - -* BSTR **name** -* BSTR **title** -* BSTR **reserved** -* LPDISPATCH **plugIn** -* _[optional]_ VARIANT **showFavorites** -* _[optional]_ VARIANT **defaultHeight** -* _[optional]_ VARIANT **defaultWidth** - -**Return type**: long - - -### Function displayAboutBox - -![][public] - -``` -void ModelCenter::IModelCenter::displayAboutBox() -``` - - - -Display the "About" dialog for ModelCenter. - - - -**Return type**: void - - -### Function halt - -![][public] - -``` -void ModelCenter::IModelCenter::halt() -``` - - - -Stop execution of the Model currently running in ModelCenter. - - - -**Return type**: void - - -### Function displayPreferencesDialog - -![][public] - -``` -void ModelCenter::IModelCenter::displayPreferencesDialog() -``` - - - -Display the "Preferences" dialog for ModelCenter. - - - -**Return type**: void - - -### Function run - -![][public] - -``` -void ModelCenter::IModelCenter::run(BSTR variableArray) -``` - - - -Runs a specified set of variables in the current Model. - - - - - - -**Parameters**: - -* **variableArray**: A comma-separated list of ModelCenter variables to validate.
- If no variables are specified then the entire model will be run (equivalent to clicking the scheduler run button). - - - -**Parameters**: - -* BSTR **variableArray** - -**Return type**: void - - -### Function getDataMonitor - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::getDataMonitor(BSTR component, VARIANT index) -``` - - - -Retrieves the indexed Data Monitor associated with the specified Component. - - - - - - -**Parameters**: - -* **component**: The desired Component name. -* **index**: The desired index number (0-based index). - - -**Returns**: - -
- - - -**Parameters**: - -* BSTR **component** -* VARIANT **index** - -**Return type**: IDispatch * - - -### Function createDataMonitor - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::createDataMonitor(BSTR component, BSTR name, int x, int y) -``` - - - -Creates a Data Monitor associated with a particular component. - - - - - - -**Parameters**: - -* **component**: The name of the ModelCenter component to associate the Data Monitor with. -* **name**: The name of the Data Monitor. -* **x**: The x-position of the Data Monitor. -* **y**: The y-position of the Data Monitor. - - -**Returns**: - -
- - - -**Parameters**: - -* BSTR **component** -* BSTR **name** -* int **x** -* int **y** - -**Return type**: IDispatch * - - -### Function isOkToClose - -![][public] - -``` -boolean ModelCenter::IModelCenter::isOkToClose() -``` - - - -Determines whether any sub-windows are currently open in ModelCenter. - - - - - - -**Returns**: - -True if no sub windows are open, else false. - - - -**Return type**: boolean - - -### Function addIcon - -![][public] - -``` -short ModelCenter::IModelCenter::addIcon(BSTR iconFile) -``` - - - -Adds a given icon file to the list of icons known by model. - - - - - - -**Parameters**: - -* **iconFile**: The name of the icon file to add. - - -**Returns**: - -The index of the icon in [ModelCenter](namespaceModelCenter.md#namespaceModelCenter)'s icon list. - - - -**Parameters**: - -* BSTR **iconFile** - -**Return type**: short - - -### Function removeDataMonitor - -![][public] - -``` -boolean ModelCenter::IModelCenter::removeDataMonitor(BSTR component, VARIANT index) -``` - - - -Remove a specific data monitor associated with a particular component - - - - - - -**Parameters**: - -* **component**: the name of the component under which to find the data monitor for deletion -* **index**: the integer index (0-based index) or string title of the data monitor being removed - - -**Returns**: - -whether the data monitor was successfully found and deleted - - - -**Parameters**: - -* BSTR **component** -* VARIANT **index** - -**Return type**: boolean - - -### Function setUserName - -![][public] - -``` -void ModelCenter::IModelCenter::setUserName(BSTR userName) -``` - - - -Sets the user name that ModelCenter will use for authentication. - - - - - - -**Parameters**: - -* **userName**: The user name. - - - -**Parameters**: - -* BSTR **userName** - -**Return type**: void - - -### Function setPassword - -![][public] - -``` -void ModelCenter::IModelCenter::setPassword(BSTR password) -``` - - - -Sets the password that ModelCenter will use for authentication. - - - - - - -**Parameters**: - -* **password**: The password. - - - -**Parameters**: - -* BSTR **password** - -**Return type**: void - - -### Function getModelCenterPath - -![][public] - -``` -BSTR ModelCenter::IModelCenter::getModelCenterPath() -``` - - - -Returns the full path to where ModelCenter is installed. - - - - - - -**Returns**: - -Full file path where ModelCenter is installed. - - - -**Return type**: BSTR - - -### Function getDataExplorer - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::getDataExplorer(int index) -``` - - - -Gets a pointer to the specified Data Explorer. - - - - - - -**Parameters**: - -* **index**: The desired index number (0-based index). - - -**Returns**: - -IDispatch* to an IDataExplorer object. - - - -**Parameters**: - -* int **index** - -**Return type**: IDispatch * - - -### Function getDataCollector - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::getDataCollector(int index) -``` - - - -Gets a pointer to the specified Data Collector. - - - - - - -**Parameters**: - -* **index**: The desired index number (0-based index). - - -**Returns**: - -IDispatch* to an [IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) object. - - - -**Parameters**: - -* int **index** - -**Return type**: IDispatch * - - -### Function getLogger - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::getLogger() -``` - - - -Gets the [ILogger](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger) object used by ModelCenter for logging status and error messages. - - - - - - -**Returns**: - -IDispatch* to an [ILogger](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger) object. - - - -**Return type**: IDispatch * - - -### Function createPlugInFrame2 - -![][public] - -``` -long ModelCenter::IModelCenter::createPlugInFrame2(BSTR name, BSTR title, BSTR reserved, LPDISPATCH plugIn, [optional]VARIANT showFavorites, [optional]VARIANT defaultHeight, [optional]VARIANT defaultWidth, [optional]VARIANT minimumHeight, [optional]VARIANT minimumWidth) -``` - - - -Creates a new frame window with favorites in it which can be used by Plug-Ins as a parent window in order to integrate with ModelCenter closer and to get favorites. Currently only supports C++ Plug-Ins. - - - - - - -**Parameters**: - -* **name**: The programmatic name of the plug-in. This is used to store favorites and settings uniquely. -* **title**: The title to put on the frame -* **reserved**: Reserved, must be blank -* **plugIn**: An IDispatch to the plug-in, used to get at the to/from string to use with favorites. -* **showFavorites**:
-* **defaultHeight**: The default height of the frame. -* **defaultWidth**: The default width of the frame. -* **minimumHeight**: The minimum allowed height of the frame. -* **minimumWidth**: The minimum allowed width of the frame. - - -**Returns**: - -
- - - -**Parameters**: - -* BSTR **name** -* BSTR **title** -* BSTR **reserved** -* LPDISPATCH **plugIn** -* _[optional]_ VARIANT **showFavorites** -* _[optional]_ VARIANT **defaultHeight** -* _[optional]_ VARIANT **defaultWidth** -* _[optional]_ VARIANT **minimumHeight** -* _[optional]_ VARIANT **minimumWidth** - -**Return type**: long - - -### Function moveComponent - -![][public] - -``` -void ModelCenter::IModelCenter::moveComponent(BSTR component, BSTR parent, [optional]VARIANT index) -``` - - - -Moves the component to the parent at the given index. - - - - - - -**Parameters**: - -* **component**: The component to move. -* **parent**: Owning object of the component. -* **index**: Position in the parent. - - - -**Parameters**: - -* BSTR **component** -* BSTR **parent** -* _[optional]_ VARIANT **index** - -**Return type**: void - - -### Function setAssemblyStyle - -![][public] - -``` -void ModelCenter::IModelCenter::setAssemblyStyle(BSTR assemblyName, AssemblyStyle style, [optional]VARIANT width, [optional]VARIANT height) -``` - - - -Sets the assembly style of the component (collapse, expanded, N^2, etc). - - - - - - -**Parameters**: - -* **assemblyName**: The assembly the style will be set. -* **style**:
-* **width**:
-* **height**:
- - - -**Parameters**: - -* BSTR **assemblyName** -* [AssemblyStyle](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625) **style** -* _[optional]_ VARIANT **width** -* _[optional]_ VARIANT **height** - -**Return type**: void - - -### Function getAssemblyStyle - -![][public] - -``` -AssemblyStyle ModelCenter::IModelCenter::getAssemblyStyle(BSTR assemblyName, int *width, int *height) -``` - - - -Gets the style of the assembly (Collapsed, expanded, N^2, etc). - - - - - - -**Parameters**: - -* **assemblyName**: The assembly to retrieve. -* **width**:
-* **height**:
- - -**Returns**: - -AssemblyStyle - - - -**Parameters**: - -* BSTR **assemblyName** -* int * **width** -* int * **height** - -**Return type**: [AssemblyStyle](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625) - - -### Function getAssembly - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::getAssembly(BSTR name) -``` - - - -Gets the assembly by the given name. - - - - - - -**Parameters**: - -* **name**: The name of the assembly. - - -**Returns**: - -IDispatch* to an [IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) object. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: IDispatch * - - -### Function createAndInitComponent - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::createAndInitComponent(BSTR serverPath, BSTR name, BSTR parent, BSTR initString, [optional]VARIANT xPos, [optional]VARIANT yPos) -``` - - - -Creates a new component and initializes it from string data. - - - - - - -?> This method can only be invoked on plug-ins which support IComponentPlugin.fromString(). Furthermore, it should only be used when you know exactly the format that is expected by the component's fromString() method. It is designed to be used from plug-ins in third-party software which need to initialize a matching component to connect to that software in the model.
-
-Ideally, both the plug-in for the third-party software and the ModelCenter component will share the same codebase, so you can generate the configuration string from the same code which you will use to process it later. Mismatch between formats will almost certainly cause this method to fail. - - -**Parameters**: - -* **serverPath**: The server path, e.g. "mcre:\\localhost\block". You can get examples of server paths by looking at the component properties for existing [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) components. -* **name**: The name of the new component. -* **parent**: The parent component. -* **initString**: The initialization string for the component. If NULL, the behavior of this function is identical to [createComponent()](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa1c2ba41e8aeff2bc97408fd6d5e8832). -* **xPos**: The X position. -* **yPos**: The Y position. - - -**Returns**: - -The newly created [IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) object - - - -**Parameters**: - -* BSTR **serverPath** -* BSTR **name** -* BSTR **parent** -* BSTR **initString** -* _[optional]_ VARIANT **xPos** -* _[optional]_ VARIANT **yPos** - -**Return type**: IDispatch * - - -### Function getLicensingPath - -![][public] - -``` -BSTR ModelCenter::IModelCenter::getLicensingPath() -``` - - - -Gets the licensing path used by ModelCenter. By default the path is the base ModelCenter install directory. - - - - - - -**Returns**: - - - -**Return type**: BSTR - - -### Function getMacroScript - -![][public] - -``` -BSTR ModelCenter::IModelCenter::getMacroScript(BSTR macroName) -``` - - - -Gets a macro script - - - - - - -?> This method is not safe for use from a component in parallel mode and will throw an exception if used in such a manner. - - -**Parameters**: - -* **macroName**: The name of the macro. - - -**Returns**: - -A string representing the macro script. - - - -**Parameters**: - -* BSTR **macroName** - -**Return type**: BSTR - - -### Function setMacroScript - -![][public] - -``` -void ModelCenter::IModelCenter::setMacroScript(BSTR macroName, BSTR script) -``` - - - -Sets a macro script - - - - - - -?> This method is not safe for use from a component in parallel mode and will throw an exception if used in such a manner. - - -**Parameters**: - -* **macroName**: The name of the macro. -* **script**: The script text. - - - -**Parameters**: - -* BSTR **macroName** -* BSTR **script** - -**Return type**: void - - -### Function getMacroScriptLanguage - -![][public] - -``` -BSTR ModelCenter::IModelCenter::getMacroScriptLanguage(BSTR macroName) -``` - - - -Gets a macro script language - - - - - - -?> This method is not safe for use from a component in parallel mode and will throw an exception if used in such a manner. - - -**Parameters**: - -* **macroName**: The name of the macro. - - -**Returns**: - -A string representing the macro script language. - - - -**Parameters**: - -* BSTR **macroName** - -**Return type**: BSTR - - -### Function setMacroScriptLanguage - -![][public] - -``` -void ModelCenter::IModelCenter::setMacroScriptLanguage(BSTR macroName, BSTR language) -``` - - - -Sets the language for a macro script - - - - - - -?> This method is not safe for use from a component in parallel mode and will throw an exception if used in such a manner. - - -**Parameters**: - -* **macroName**: The name of the macro. -* **language**: The macro script language. - - - -**Parameters**: - -* BSTR **macroName** -* BSTR **language** - -**Return type**: void - - -### Function addNewMacro - -![][public] - -``` -void ModelCenter::IModelCenter::addNewMacro(BSTR macroName, boolean isAppMacro) -``` - - - -Adds a new macro - - - - - - -**Parameters**: - -* **macroName**: The name of the macro to show in the editor. -* **isAppMacro**: If true, the new macro will be an application macro. Otherwise, the new macro will be a model macro. - - - -**Parameters**: - -* BSTR **macroName** -* boolean **isAppMacro** - -**Return type**: void - - -### Function launchMacroEditor - -![][public] - -``` -void ModelCenter::IModelCenter::launchMacroEditor(BSTR macroName) -``` - - - -Launches the macro editor tool, and show the macro script corresponding to macroName - - - - - - -**Parameters**: - -* **macroName**: the name of the macro to show in the editor. Just show the editor if the argument is null, or is not a valid macro name. - - - -**Parameters**: - -* BSTR **macroName** - -**Return type**: void - - -### Function startGUIMode - -![][public] - -``` -void ModelCenter::IModelCenter::startGUIMode([optional]VARIANT showDialogs) -``` - - - -THIS FUNCTION IS A BETA CAPABILITY - - - - - -Normally when invoked via COM, [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) is in "server" mode and it hides all GUI and dialogs. This method can be invoked immediately after instantiating the [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) object to cause the GUI to be displayed.
- - - - - - -Calling this method at any other time than immediately after creating the [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) object is NOT SUPPORTED. Strange behavior or even crashes will likely ensue if it is called at any other time. - - - - - -Once this method is invoked, [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) may pop up GUI dialogs requiring user interaction at any time. This means your script may hang indefinitely if a user is not there to click through. For example, if a component fails to load on model load, the user would be prompted with the failed component dialog and the [loadModel()](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab57546e9e718895bbdfa25bc1b7d1e9d) api function would hang until the user answered the dialog. - - - - - - -**Parameters**: - -* **showDialogs**: Boolean, that if true, will allow showing of startup dialogs such as the 'Recover Trade Study' dialog or 'Welcome to [ModelCenter](namespaceModelCenter.md#namespaceModelCenter)' dialog. - - - -**Parameters**: - -* _[optional]_ VARIANT **showDialogs** - -**Return type**: void - - -### Function getNumUnitCategories - -![][public] - -``` -long ModelCenter::IModelCenter::getNumUnitCategories() -``` - - - -Returns the number of unit categories in the [IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) object. - - - - - - -**Returns**: - -The number for unit categories, or -1 if there is an error. - - - -**Return type**: long - - -### Function getUnitCategoryName - -![][public] - -``` -BSTR ModelCenter::IModelCenter::getUnitCategoryName(long index) -``` - - - -Returns the name of the category of a unit. - - - - - - -**Parameters**: - -* **index**: Index of the unit. - - -**Returns**: - -The name of the category, or empty string if there is an error. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - - -### Function getNumUnits - -![][public] - -``` -long ModelCenter::IModelCenter::getNumUnits(BSTR category) -``` - - - -Returns the number of units inside a specified category. - - - - - - -**Parameters**: - -* **category**: Specified category of units. - - -**Returns**: - -The number of units, or -1 if there is an error. - - - -**Parameters**: - -* BSTR **category** - -**Return type**: long - - -### Function getUnitName - -![][public] - -``` -BSTR ModelCenter::IModelCenter::getUnitName(BSTR category, long index) -``` - - - -Gets the name of the unit. - - - - - - -**Parameters**: - -* **category**: Category to retrieve the unit. -* **index**: Index of the element in the category. - - -**Returns**: - -The name of the unit, or empty string if there is an error. - - - -**Parameters**: - -* BSTR **category** -* long **index** - -**Return type**: BSTR - - -### Function createTradeStudy - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::createTradeStudy(BSTR type, [optional]VARIANT setup) -``` - - - -Launches the specified trade study. - - - - - - -**Parameters**: - -* **type**: The string identifier for the trade study that should be started. -* **setup**: The setup string. - - -**Returns**: - -An IDispatch* to the trade study object. - - - -**Parameters**: - -* BSTR **type** -* _[optional]_ VARIANT **setup** - -**Return type**: IDispatch * - - -### Function getNetworkLocations - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::getNetworkLocations() -``` - - - -Return a reference to the Network Locations object - - - - - - -**Returns**: - -An IDispatch* to the [INetworkLocations](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations) object. - - - -**Return type**: IDispatch * - - -### Function saveVersionedModel - -![][public] - -``` -void ModelCenter::IModelCenter::saveVersionedModel(VersionStatus versionStatus, BSTR checkinMessage) -``` - - - -Saves the current Model. - - - - - - -**Parameters**: - -* **versionStatus**: how to go about versioning the model (and its submodels) -* **checkinMessage**: check-in message to be associated with the model (and its submodels) - - - -**Parameters**: - -* [VersionStatus](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0) **versionStatus** -* BSTR **checkinMessage** - -**Return type**: void - - -### Function saveVersionedModelAs - -![][public] - -``` -void ModelCenter::IModelCenter::saveVersionedModelAs(BSTR fileName, VersionStatus versionStatus, BSTR checkinMessage) -``` - - - -Saves the current Model to a specified file. - - - - - - -**Parameters**: - -* **fileName**: Path to save the Model in. -* **versionStatus**: how to go about versioning the submodel (and its submodels) -* **checkinMessage**: check-in message to be associated with the model (and its submodels) - - - -**Parameters**: - -* BSTR **fileName** -* [VersionStatus](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0) **versionStatus** -* BSTR **checkinMessage** - -**Return type**: void - - -### Function getVariableMetaData - -![][public] - -``` -LPDISPATCH ModelCenter::IModelCenter::getVariableMetaData(BSTR name) -``` - - - -Get metadata from a variable. Throws an exception if the variable is not found. -**Parameters**: - -* **name**: the full name of the variable - - -**Returns**: - -the metadata, in the form of an IDHVariable (from [PHXDATAHISTORYLib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib)) - - - -**Parameters**: - -* BSTR **name** - -**Return type**: LPDISPATCH - - -### Function dumpComDebug - -![][public] - -``` -void ModelCenter::IModelCenter::dumpComDebug() -``` - - - -Dump COM debug information to TRACE(); only has an effect in debug builds. - - - -**Return type**: void - - -### Function showFileBrowseDialog - -![][public] - -``` -BSTR ModelCenter::IModelCenter::showFileBrowseDialog(BSTR title, [optional]VARIANT filters, [optional]VARIANT initialUri, [optional]VARIANT hwnd) -``` - - - -Displays file selection for loading dialog and returns URI of selected file. -**Parameters**: - -* **title**: title of dialog window -* **filters**: array of file type filters -* **initialUri**: initialUri to use in dialog -* **hwnd**: the window handle to which to parent the dialog - - -**Returns**: - -URI of selected file, or empty string if none selected - - - -**Parameters**: - -* BSTR **title** -* _[optional]_ VARIANT **filters** -* _[optional]_ VARIANT **initialUri** -* _[optional]_ VARIANT **hwnd** - -**Return type**: BSTR - - -### Function showFileSaveDialog - -![][public] - -``` -BSTR ModelCenter::IModelCenter::showFileSaveDialog(BSTR title, int *selectedFilter, [optional]VARIANT initialFilename, [optional]VARIANT filters, [optional]VARIANT initialUri, [optional]VARIANT hwnd) -``` - - - -Displays file selection for saving dialog and returns URI of selected file. -**Parameters**: - -* **title**: title of dialog window -* **selectedFilter**: the number of the filter selected -* **initialFilename**: the filename to populate the save dialog with -* **filters**: array of file type filters -* **initialUri**: initialUri to use in dialog -* **hwnd**: the window handle to which to parent the dialog - - -**Returns**: - -URI of selected file, or empty string if none selected - - - -**Parameters**: - -* BSTR **title** -* int * **selectedFilter** -* _[optional]_ VARIANT **initialFilename** -* _[optional]_ VARIANT **filters** -* _[optional]_ VARIANT **initialUri** -* _[optional]_ VARIANT **hwnd** - -**Return type**: BSTR - - -### Function setLoginCallback - -![][public] - -``` -void ModelCenter::IModelCenter::setLoginCallback(IDispatch *callback) -``` - - - -Sets the login callback to use for authentication. -**Parameters**: - -* **callback**: callback to use - - - -**Parameters**: - -* IDispatch * **callback** - -**Return type**: void - - -### Function createDataHistoryVariable - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::createDataHistoryVariable() -``` - - - -Create an IDHVariable object. - - - -**Return type**: IDispatch * - - -### Function getRunOnlyMode - -![][public] - -``` -boolean ModelCenter::IModelCenter::getRunOnlyMode() -``` - - - -Gets the status of [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) being in Run-Only Mode. - - - - - - -**Returns**: - -true if [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) is in Run-Only Mode; otherwise, false - - - -**Return type**: boolean - - -### Function setRunOnlyMode - -![][public] - -``` -void ModelCenter::IModelCenter::setRunOnlyMode(boolean shouldBeInRunOnly) -``` - - - -Sets the status of [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) being in Run-Only Mode to the specified value. - - - - - -Note: This function can only be called if it is the first function to be called on a new [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) object; otherwise, it will throw an exception. This is to ensure that the correct [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) license is checked out. - - - - - - -**Parameters**: - -* **shouldBeInRunOnly**: true if [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) should be in Run-Only Mode; otherwise, false - - - -**Parameters**: - -* boolean **shouldBeInRunOnly** - -**Return type**: void - - -### Function createDataExplorer - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::createDataExplorer(BSTR tradeStudyType, BSTR setup) -``` - - - -Creates a new Data Explorer. This documentation assumes you're creating it for a trade study; if you're not you can pass almost anything in for tradeStudyType or setup. - - - - - - -**Parameters**: - -* **tradeStudyType**: Registry ID of the Plug-In. This is obtained by calling the [getRegID ](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac0dd856b24d06484c6ded0aba0199016) method of the IAddToModel* object that is passed into the Plug-In's construct method. -* **setup**: A string that is generated from the Plug-In's "toString" method that can be restored later by the Plug-In's "fromString" method. - - -**Returns**: - -IDispatch* to an [PHXDATAEXPLORERLib::\_DPHXDataExplorer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer) object. - - - -**Parameters**: - -* BSTR **tradeStudyType** -* BSTR **setup** - -**Return type**: IDispatch * - - -### Function getFileSystemInfo - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::getFileSystemInfo(BSTR url) -``` - - - -Gets the FileSystemInfo for a given URL. - - - - - - -**Parameters**: - -* **url**: the url for which to load a file system info - - - -**Parameters**: - -* BSTR **url** - -**Return type**: IDispatch * - - -### Function SAFEARRAY - -![][public] - -``` -ModelCenter::IModelCenter::SAFEARRAY(BSTR) getTradeStudyFilters() -``` - - - -Returns an array containing a list of FileDialog filters for [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) trade study files. -**Returns**: - -SAFEARRAY of filters for use in FileDialog of the files used by trade studies - - - -**Parameters**: - -* BSTR - -**Return type**: - - -### Function saveTradeStudy - -![][public] - -``` -void ModelCenter::IModelCenter::saveTradeStudy(BSTR uri, int format, LPDISPATCH dataExplorer) -``` - - - -Save the trade study currently loaded in the DataExplorer to the given URI. It will overwrite the file if it exists. Note: Saving in pxt/pxtz formats will only save legacy plots and not the new plot types. Use tstudy(TS_FORMAT_TSTUDY) format to save all plots. -**Parameters**: - -* **uri**: the uri to write the trade study to -* **format**: the file format to be used when saving the trade study. Must be set to TS_FORMAT_TSTUDY. See [TradeStudyFormat](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dca) enumeration. -* **dataExplorer**: the data explorer from which to take trade study data - - - -**Parameters**: - -* BSTR **uri** -* int **format** -* LPDISPATCH **dataExplorer** - -**Return type**: void - - -### Function getDataCollectorForDataExplorer - -![][public] - -``` -IDispatch * ModelCenter::IModelCenter::getDataCollectorForDataExplorer(LPDISPATCH dataExplorer) -``` - - - -Retrieves a pointer to the Data Collector for the specified Data Explorer. - - - - - - -**Parameters**: - -* **dataExplorerPtr**: The Data Explorer pointer for which to retrieve a Data Collector - - -**Returns**: - -IDispatch* to the [IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) object for the specified Data Explorer - - - -**Parameters**: - -* LPDISPATCH **dataExplorer** - -**Return type**: IDispatch * - - -### Function launchDataCollectorPlugIn - -![][public] - -``` -void ModelCenter::IModelCenter::launchDataCollectorPlugIn(BSTR plugInName, LPDISPATCH dataExplorer) -``` - - - -Launches a specific Data Collector PlugIn, by name, on the specified Data Explorer. - - - - - - -**Parameters**: - -* **plugInName**: The name of the Data Collector PlugIn to be launched -* **dataExplorer**: The Data Explorer for which to launch the PlugIn - - - -**Parameters**: - -* BSTR **plugInName** -* LPDISPATCH **dataExplorer** - -**Return type**: void - - -### Function guiLoadFile - -![][public] - -``` -boolean ModelCenter::IModelCenter::guiLoadFile(BSTR fileName) -``` - - - -Loads a file in "GUI" mode, that is, unlike loadFile(...), will produce a prompt to the user to verify whether or not any currently opened model should be saved prior to loading the given file. - - - - - - -**Parameters**: - -* **fileName**: Path of the file to load. - - -**Return values**: - -* **true**: if the save was not canceled -* **false**: if the save was canceled - - - -**Parameters**: - -* BSTR **fileName** - -**Return type**: boolean - - -### Function guiSaveModel - -![][public] - -``` -void ModelCenter::IModelCenter::guiSaveModel() -``` - - - -Saves the currently open file in "GUI" mode; unlike saveModel, this can pop up a save dialog (if the file has not already been saved). It will use [ModelCenter](namespaceModelCenter.md#namespaceModelCenter)'s logic to determine what to do about versioned files. - - - -**Return type**: void - - -### Function getMacroTimeout - -![][public] - -``` -double ModelCenter::IModelCenter::getMacroTimeout(BSTR macroName) -``` - - - -Gets a macro's timeout. - - - - - - -?> This method is not safe for use from a component in parallel mode and will throw an exception if used in such a manner. - - -**Parameters**: - -* **macroName**: The name of the macro. - - -**Returns**: - -Number of seconds to allow a script to run before canceling it; -1 indicates no timeout. - - - -**Parameters**: - -* BSTR **macroName** - -**Return type**: double - - -### Function setMacroTimeout - -![][public] - -``` -void ModelCenter::IModelCenter::setMacroTimeout(BSTR macroName, double timeout) -``` - - - -Sets a macro's timeout. - - - - - - -?> This method is not safe for use from a component in parallel mode and will throw an exception if used in such a manner. - - -**Parameters**: - -* **macroName**: The name of the macro. -* **timeout**: The number of seconds to allow a script to run before canceling it; -1 indicates no timeout. - - - -**Parameters**: - -* BSTR **macroName** -* double **timeout** - -**Return type**: void - - -### Function guiCloseAllMultiplexers - -![][public] - -``` -boolean ModelCenter::IModelCenter::guiCloseAllMultiplexers() -``` - - - -Attempts to close the DataExplorers of all vizualization multiplexers. -**Returns**: - -true if the user allowed all multiplexers to close. - - - -**Return type**: boolean - -## Private functions - - -### Function setAlternateParentFrame - -![][private] - -``` -void ModelCenter::IModelCenter::setAlternateParentFrame(long hwnd) -``` - - - - - - - -**Parameters**: - -* long **hwnd** - -**Return type**: void - - -### Function destroyPlugInFrame - -![][private] - -``` -void ModelCenter::IModelCenter::destroyPlugInFrame(long hwnd) -``` - - - - - - - -**Parameters**: - -* long **hwnd** - -**Return type**: void - - -### Function showPlugInFrame - -![][private] - -``` -void ModelCenter::IModelCenter::showPlugInFrame(long hwnd) -``` - - - - - - - -**Parameters**: - -* long **hwnd** - -**Return type**: void - - -### Function hidePlugInFrame - -![][private] - -``` -void ModelCenter::IModelCenter::hidePlugInFrame(long hwnd) -``` - - - - - - - -**Parameters**: - -* long **hwnd** - -**Return type**: void - - -### Function setIconPlugInFrame - -![][private] - -``` -void ModelCenter::IModelCenter::setIconPlugInFrame(long hwnd, BSTR iconFile) -``` - - - - - - - -**Parameters**: - -* long **hwnd** -* BSTR **iconFile** - -**Return type**: void - - -### Function launchHTMLViewer - -![][private] - -``` -long ModelCenter::IModelCenter::launchHTMLViewer(BSTR url, boolean popup) -``` - - - - - - - -**Parameters**: - -* BSTR **url** -* boolean **popup** - -**Return type**: long - - -### Function runAntFile - -![][private] - -``` -void ModelCenter::IModelCenter::runAntFile(BSTR fileName) -``` - - - - - - - -**Parameters**: - -* BSTR **fileName** - -**Return type**: void - - -### Function getGlobalParameters - -![][private] - -``` -IDispatch * ModelCenter::IModelCenter::getGlobalParameters() -``` - - - - - - - -**Return type**: IDispatch * - - -### Function closeHTMLViewer - -![][private] - -``` -boolean ModelCenter::IModelCenter::closeHTMLViewer(long hwnd) -``` - - - - - - - -**Parameters**: - -* long **hwnd** - -**Return type**: boolean - - -### Function HTMLViewerWaitForClose - -![][private] - -``` -void ModelCenter::IModelCenter::HTMLViewerWaitForClose(long hwnd) -``` - - - - - - - -**Parameters**: - -* long **hwnd** - -**Return type**: void - - -### Function HTMLViewerGetMyHWND - -![][private] - -``` -long ModelCenter::IModelCenter::HTMLViewerGetMyHWND() -``` - - - - - - - -**Return type**: long - - -### Function getActiveJobManager - -![][private] - -``` -IDispatch * ModelCenter::IModelCenter::getActiveJobManager() -``` - - - - - - - -**Return type**: IDispatch * - - -### Function getPreference - -![][private] - -``` -VARIANT ModelCenter::IModelCenter::getPreference(BSTR pref) -``` - - - -Gets preference value for the given key (pref). Note: Parses preference value in following order: Bool -> long -> double -> string -**Parameters**: - -* **preference**: (key) value to get value for - - -**Returns**: - -preference value as a variant.
- - - -**Parameters**: - -* BSTR **pref** - -**Return type**: VARIANT - - -### Function internalLicensing - -![][private] - -``` -void ModelCenter::IModelCenter::internalLicensing(BSTR, long) -``` - - - - - - - -**Parameters**: - -* BSTR -* long - -**Return type**: void - - -### Function transformAVPoint - -![][private] - -``` -void ModelCenter::IModelCenter::transformAVPoint(int x, int y, boolean screen, VARIANT *tx, VARIANT *ty) -``` - - - - - - - -**Parameters**: - -* int **x** -* int **y** -* boolean **screen** -* VARIANT * **tx** -* VARIANT * **ty** - -**Return type**: void - - -### Function parallelInstance - -![][private] - -``` -IDispatch * ModelCenter::IModelCenter::parallelInstance() -``` - - - - - - - -**Return type**: IDispatch * - - -### Function unAssociatedInstance - -![][private] - -``` -IDispatch * ModelCenter::IModelCenter::unAssociatedInstance() -``` - - - - - - - -**Return type**: IDispatch * - - -### Function configureLogging - -![][private] - -``` -void ModelCenter::IModelCenter::configureLogging(boolean enableLogging) -``` - - - -Configures the [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) logger, currently used for testing. - - - - - - -**Parameters**: - -* **enableLogging**: Set to true to enable the logger. - - - -**Parameters**: - -* boolean **enableLogging** - -**Return type**: void - - -### Function setXMLExtension - -![][private] - -``` -void ModelCenter::IModelCenter::setXMLExtension(BSTR xml) -``` - - - -Adds the XML as an XML extension node to the model file. - - - - - - -**Parameters**: - -* **xml**: The XML string. - - - -**Parameters**: - -* BSTR **xml** - -**Return type**: void - - -### Function getXMLExtension - -![][private] - -``` -BSTR ModelCenter::IModelCenter::getXMLExtension(BSTR nodeName, BSTR attributeName, BSTR attributeValue) -``` - - - -Gets an XML extension node from the model file that matches the specified query. - - - - - - -**Parameters**: - -* **nodeName**: Name of the XML root tag. -* **attributeName**: Name of a distinguishing attribute for the XML tag. -* **attributeValue**: Value of the attribute. - - -**Returns**: - -
- - - -**Parameters**: - -* BSTR **nodeName** -* BSTR **attributeName** -* BSTR **attributeValue** - -**Return type**: BSTR - - -### Function setPreference - -![][private] - -``` -void ModelCenter::IModelCenter::setPreference(BSTR pref, BSTR value) -``` - - - - - - - -**Parameters**: - -* BSTR **pref** -* BSTR **value** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IModelCenter + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3947) + + + +COM instance. + + + + + + +**ModelCenter batch mode**: + +This example demonstrates invoking ModelCenter and running a Model in batch mode through the COM API. +``` +Dim mc +Set mc=CreateObject("ModelCenter.Application") +mc.loadModel "c:\testmodel.pxc" +' +Dim x +Dim s +For x=0 To 10 + mc.setValue "Model.Linear.x", x + s=s & "x=" & x & ", y=" & mc.getValue("Model.Linear.y") & vbNewLine +Next +msgbox s +``` + + +**Example ModelCenter Script**: + +This script demonstrates how to automate ModelCenter to create a Model.
+First, a new Model is loaded into ModelCenter, two components are instantiated, and then several links are created.
+Last, the Model is saved to a .pxc file. +``` +' This is a test script that automates the creation of a Model +' +' -------------------- start ModelCenter +' +Dim app +Set app = WScript.CreateObject("ModelCenter.Application") +' +' -------------------- start a new Model +' +app.newModel +' +' -------------------- instantiate a few components +' +app.createComponent "mcre://localhost/Block", "block", "Model" +app.createComponent "mcre://localhost/Block", "block1", "Model" +' +' -------------------- create some links +' +app.createLink "Model.block.width", "Model.block1.width" +app.createLink "Model.block.height", "Model.block1.width + Model.block1.height" +' +' -------------------- save the file +' +file = "c:\model.pxc" +app.saveModelAs(file) +``` + + +**Example DOE Script**: + +This script demonstrates how to call ModelCenter to perform a DOE.
+The script loads a Model into ModelCenter, and then repeatedly sets and gets values to perform the DOE. +``` +' +' This is a test script that performs a DOE using ModelCenter. To +' run the script, type "cscript DOE.vbs" +' +' +' -------------------- start ModelCenter +' +Dim app +Set app = WScript.CreateObject( "ModelCenter.Application" ) +' +' -------------------- load a file +' +file = "d:\model.pxc" +app.loadFile file +' +' -------------------- setup a DOE table +' +numTrials = 4 +numInputs = 2 +numOutputs = 2 +Dim inputs(2) +inputs(0) = "script.VBScript.a" +inputs(1) = "script.VBScript.b" +Dim outputs(2) +outputs(0) = "script.VBScript.c" +outputs(1) = "script.VBScript.d" +Dim trials(4,2) +trials(0,0) = 5 +trials(0,1) = 2 +trials(1,0) = 4 +trials(1,1) = 2 +trials(2,0) = 5 +trials(2,1) = 3 +trials(3,0) = 4 +trials(3,1) = 3 +' +' -------------------- perform the runs +' +' print a header +msg = "" +For var = 0 To numInputs-1 + msg = msg & inputs(var) & " " +Next +For var = 0 To numOutputs-1 + msg = msg & outputs(var) & " " +Next +' print the values +WScript.echo msg +' collect and print values +For i = 0 To numTrials-1 + ' create a message + msg = "" + ' set the input values + For var = 0 To numInputs-1 + app.setValue inputs(var), trials(i,var) + msg = msg & trials(i,0) & " " + Next + ' get the outputs + For var = 0 To numOutputs-1 + msg = msg & app.getValue( outputs(var) ) & " " + Next + ' print the values + WScript.echo msg +Next +``` + +## Members + +* [addIcon](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ada4b443f077f7c53744ada601a3c12be) +* [addNewMacro](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a9d209b30adb83ac9fe48f8efd1959f3a) +* [appFullPath](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a999bedcb3195dc2a12b034e0fa0222ec) +* [appName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a1a5d90dca23414ddb8ef45e99c091ea4) +* [autoLink](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1adea9c027f61fb0c23ce34a0e47924679) +* [breakLink](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a231cd11fa3198cc4a22db3ee0483b59c) +* [checkout](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5ea6a58aa4def0e7d48f5c48dfc46d35) +* [checkout2](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3b8e21abd2354b4fd537084f36c9a180) +* [closeHTMLViewer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a46b4e01256fa252da2f589af87833ac1) +* [closeModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a00bcefae609c5a453dd1f4e0586820fc) +* [configureLogging](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acb8cad870e072bee4a80b1902476929a) +* [createAndInitComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a049e13b6d3ba54dd40a162a16d03bb66) +* [createAssembly](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a402db0953a58ac7573cf3585c938eafa) +* [createAssemblyVariable](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a72e28e9146e37b0854aaa3274b60362c) +* [createComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa1c2ba41e8aeff2bc97408fd6d5e8832) +* [createDataCollector](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad91dff33c09345053346ce2d831fd968) +* [createDataExplorer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3edba311337bb171b956e0d331cfa05f) +* [createDataHistoryVariable](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5f2d90be1a4bed0126993b3021d24981) +* [createDataMonitor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad86e8cd5714f0d22dc84b1b71979fdc5) +* [createJobManager](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5878e18adeeafe78c1920e5544253442) +* [createLink](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac46503f8f560edbcddd87fb9c9045326) +* [createPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1afb0f2d3715e4a48c1ee1c865864c5314) +* [createPlugInFrame2](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acd338a67839da36df138a0521ee3aead) +* [createTradeStudy](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab18e9a5fa259695357cd26f155ee95dd) +* [destroyPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a24cc8bd489975150c9d5c5c3e9502b87) +* [displayAboutBox](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa9057344d6d2ffc28569709efdbdb5ad) +* [displayPreferencesDialog](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae8f7829bf075209faf0fcecf742e76be) +* [dumpComDebug](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a27b453e8058a238c25049c8fcb5121e4) +* [exit](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aba655ef2cf9a8f639acde2697d8319a2) +* [getActiveJobManager](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a931fee19976a7a03e263284ec0ee9d53) +* [getAssembly](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a461a8c0e8efdd3353da6feb22b232029) +* [getAssemblyStyle](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab1d7ce6494121cd997115f91e91d795a) +* [getComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a779902b1a3f3c4c0db2b58484ec75fe0) +* [getDataCollector](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a29b8af2a820e24e728425e6467881067) +* [getDataCollectorForDataExplorer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a59b46ca7b15c869fb190ecfeb70bf90a) +* [getDataExplorer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae1bdc8f0abc612490b737852f189027a) +* [getDataMonitor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a6212fa2f41e2132f8f40d78164059eb7) +* [getFileSystemInfo](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a6d6d38245d99b3f53fda689a1adee17f) +* [getFormatter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a1533da4a5c2e70aa5b196215af7637bc) +* [getGlobalParameters](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2fac8021991150ab97e3673e4b0c0dc1) +* [getHaltStatus](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa75908bb0ec202342833c666b10fcb66) +* [getHWND](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aaaa18b9967d91f5e9afa0f663fb4ddae) +* [getLastErrorMessage](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5a57f078a8de6d78e6cc4f808c761fe8) +* [getLicensingPath](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af5bdeb0442c6f35c0e5db849b1a166fd) +* [getLinks](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac83decf1799275a0d13ecadeffb008cd) +* [getLogger](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af2d28cb0c0290a80ebe0e31f91497f11) +* [getMacroScript](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a16bc3b79ea75a2c2e9c6aaf48591f840) +* [getMacroScriptLanguage](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8c930544d5f9fc2e49afb076b5ccee76) +* [getMacroTimeout](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a18766ae9a0fda73f8febdb709adfceea) +* [getModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a5d42323e20b243257f4cef533dd58e7d) +* [getModelCenterPath](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1adc47ef3cf5fa8d766117ec19c7dfab92) +* [getModelUUID](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a499de038ba95ad40b52862e5239bf18c) +* [getNetworkLocations](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a375ab85c506633857e960502c208ed79) +* [getNumUnitCategories](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a0f6aab6d238cbe899af59725ab0de842) +* [getNumUnits](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad6a35e6ac78e89ddcd4a68023bcdd651) +* [getPreference](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aadc031780e0355e1ca2bba83cb13441a) +* [getRunOnlyMode](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a38682504615aef9e603a9c2f3d4bd2e8) +* [getUnitCategoryName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1abe07ee5b95ed640b926a165f2e02b7f1) +* [getUnitName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aab8bb46de63e10f150e9614ea36d0b9a) +* [getValue](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8cacc6c81e217bf7affe180a59d21455) +* [getValueAbsolute](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a04408aef2e249b325db44eb8e0ca6758) +* [getVariable](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af87c3dde3f5645f1257ba0edb037889b) +* [getVariableMetaData](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aebbf42a396f1eea5b917d13b85e0fb8e) +* [getXMLExtension](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af94e33f84d46652cfad0af931db0d59b) +* [guiCloseAllMultiplexers](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8708a9033fcd77731539b085a1c6c047) +* [guiLoadFile](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a255ea30feb95451802aa280bdffcd7b8) +* [guiSaveModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a8ad33e25dfad91e8ba248d399a1b6449) +* [halt](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a4cde569f8ca3555ede7fd8d3d2cd4387) +* [hidePlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a806cc1860aaadaa5496d4caa0a51fe91) +* [HTMLViewerGetMyHWND](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad6f56123c0b435ffca19628deaa4169f) +* [HTMLViewerWaitForClose](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad62471b3a17a7b182d7f8fa0df7048b7) +* [internalLicensing](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae91fcfa7f9dfe5fa3df62fb9d3c703c8) +* [invokeHelp](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2a8f95eb131aad5e03597ada8251ef30) +* [IsInteractive](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7fc1e5b5a0eee411b82f7508243f453f) +* [isOkToClose](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af91d7535a069da55220c52b759ca5238) +* [launchDataCollectorPlugIn](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a434995395fc673c8197bfde7e1256240) +* [launchHTMLViewer](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aae5eb45abe323ca501a777f31b9ae5b8) +* [launchMacroEditor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab180eb62170146926e7a6c2384d5ad66) +* [launchTradeStudy](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a24726ff2cf91ef85884d6b2bea513ed4) +* [loadFile](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a21295b971e1a8854d7524b85332fcb3b) +* [loadModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab57546e9e718895bbdfa25bc1b7d1e9d) +* [MessageBox](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa31343d27c063cc384336028b12abac2) +* [modelDirectory](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1adf58dfafa5401318de434c22d9e12ef3) +* [modelFileName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1abb83f0e9475f2ccf8de46b09946d79e3) +* [moveComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a70986fc1018ab96fdbd507b4ebe568fc) +* [newModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a90ad7c497e4da5b9474d747ba6bd9715) +* [parallelInstance](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7dc06d52fa432893eaf74db606db3864) +* [ProcessID](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acb08040260ee9e91a9a455c15d9fc0ad) +* [removeComponent](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7bbd736a48c08e2eb90c4af45872e6f5) +* [removeDataMonitor](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2dd2279b4d0250af8ae6d3506f55c57a) +* [run](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a158d8bbb37d23dd35bbf87b1340c95d6) +* [runAntFile](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a2d684049210e4062f14cf2e3e2abb031) +* [runMacro](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a762c9d09a2d611300bc3e09f9891c86e) +* [SAFEARRAY](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa2ca200dd05dc8257c35af74035459e1) +* [saveModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a16dc53d7c16d4517b6859acc1ee25a50) +* [saveModelAs](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab3fcf686594e1e2f81b7814bab8a6752) +* [saveTradeStudy](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af139d41f66681c63c80243adbd48cbc0) +* [saveVersionedModel](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac658a0c1392f2fd8b851794c9ac1896f) +* [saveVersionedModelAs](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab65847c07b712a58acfe6a21659518b5) +* [screenUpdating](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1acc9b3db9f6b75b711cf8106947576e89) +* [setAlternateParentFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a83b97e8dd461f4bc8fbe5cdc63809b74) +* [setAssemblyStyle](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1af1bef892aa57d153cd63b6f4ba9037f4) +* [setIconPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a65a6502ad779fd4394d06f45adabc398) +* [setLoginCallback](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a156c716bde56ad5bc070f00e2037a2da) +* [setMacroScript](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ae2b0614b8c0367ab7893c5fb32e14b96) +* [setMacroScriptLanguage](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a7b92a22213e11d5f4b3ad8dfe7a894f9) +* [setMacroTimeout](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a559cd3b9f0e68e5ecc2c4006c8014667) +* [setPassword](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a677e2965bfb8998dc4546673f95355de) +* [setPreference](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ac7c886a8b0333b565333d6b16d9ab824) +* [setRunOnlyMode](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aba91dde2a4c0674816c3781ed873457e) +* [setScheduler](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa312b4e6e4585bd0f4d7cc9a69d1d7ec) +* [setUserName](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a359b38b4b8bc935b9eb5cf9e68a3a34f) +* [setValue](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a535535c056577a2306bfd089423a6e8b) +* [setXMLExtension](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a70666088b3363b2c9738cd15ec446d8e) +* [showFileBrowseDialog](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a9dabff9569cfbb6c65ccdae26aab3ff7) +* [showFileSaveDialog](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a23ea9bc699e8f31401f96d2594f79ae6) +* [showPlugInFrame](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ad1fc33915ad5917cd645e795251f01de) +* [startGUIMode](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a06c77786a3965c9ca7c72c6ba7af7ad3) +* [tradeStudyEnd](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a85f4a4b6557102133fc5dad3ef0a1ff8) +* [tradeStudyStart](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a39de949b1cdace01114ee9391fc4a484) +* [transformAVPoint](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a23a3683a4c5b5f4380e33232e2ca30be) +* [unAssociatedInstance](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a21a60528e3b43cbbbbc131adaf5a1151) +* [version](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3072c85db32956a1c302668a49b031f8) + +## Properties + + +### Property modelDirectory + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IModelCenter::modelDirectory +``` + + + +Directory of the current Model. If no model is open it will raise an error. If the model has not yet been saved, it will return an empty string. + + + +**Return type**: BSTR + + +### Property screenUpdating + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IModelCenter::screenUpdating +``` + + + +Whether or not screen updating is turned on. + + + +**Return type**: boolean + + +### Property modelFileName + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IModelCenter::modelFileName +``` + + + +The Full path of the current ModelCenter Model. + + + +**Return type**: BSTR + + +### Property appName + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IModelCenter::appName +``` + + + +Gets the [Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) name + + + + + + +**Returns**: + +[Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) name + + + +**Return type**: BSTR + + +### Property appFullPath + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IModelCenter::appFullPath +``` + + + +Gets the full path to the application. + + + +**Return type**: BSTR + + +### Property IsInteractive + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BOOL ModelCenter::IModelCenter::IsInteractive +``` + + + +Is ModelCenter running in interactive/GUI mode. + + + +**Return type**: BOOL + + +### Property ProcessID + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IModelCenter::ProcessID +``` + + + +The process identifier of the [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) process. Useful for cases where [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) is running in COM server mode and a client process needs to grant it permission to do something (like move a window to the foreground). + + + +**Return type**: long + + +### Property version + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 4270) + +``` +long ModelCenter::IModelCenter::version +``` + + + +Gets the version number of ModelCenter. ModelCenter versions are in the form 5.1.2 where 5 is the major version, 1 is the minor, and 2 is the patch version. + + + + + + +**Parameters**: + +* **index**: Which part of the version to get. +* 0 - Get the major version number + +* 1 - Get the minor version number + +* 2 - Get the patch version number + + +**Returns**: + +The requested version part. + + + +**Return type**: long + +## Public functions + + +### Function getLastErrorMessage + +![][public] + +``` +BSTR ModelCenter::IModelCenter::getLastErrorMessage() +``` + + + +Gets the last error message. + + + + + + +**Returns**: + +The last error message. + + + +**Return type**: BSTR + + +### Function loadFile + +![][public] + +``` +void ModelCenter::IModelCenter::loadFile(BSTR fileName, [optional]VARIANT onConnectError) +``` + + + +Loads a .pxc file. + + + + + + +**Parameters**: + +* **fileName**: Path of the .pxc file. +* **onConnectError**: States what to do when a connect error is encountered.
+ (see [OnConnectionErrorMode](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2) for error modes, default is CONN_ERR_ERROR). + + + +**Parameters**: + +* BSTR **fileName** +* _[optional]_ VARIANT **onConnectError** + +**Return type**: void + + +### Function setValue + +![][public] + +``` +void ModelCenter::IModelCenter::setValue(BSTR varName, BSTR value) +``` + + + +Sets the value of a variable. + + + + + + +**Parameters**: + +* **varName**: Full ModelCenter path of the variable. +* **value**: The new value. + + + +**Parameters**: + +* BSTR **varName** +* BSTR **value** + +**Return type**: void + + +### Function getValue + +![][public] + +``` +VARIANT ModelCenter::IModelCenter::getValue(BSTR varName) +``` + + + +Gets the value of a variable. + + + + + + +**Parameters**: + +* **varName**: Full ModelCenter path of the variable. + + +**Returns**: + +The value as a variant. + + + +**Parameters**: + +* BSTR **varName** + +**Return type**: VARIANT + + +### Function createComponent + +![][public] + +``` +void ModelCenter::IModelCenter::createComponent(BSTR serverPath, BSTR name, BSTR parent, [optional]VARIANT xPos, [optional]VARIANT yPos) +``` + + + +Creates, or connects, to a new MCRE Component. + + + + + + +**Parameters**: + +* **serverPath**: The MCRE source path of the new component. +* **name**: Name of the new component. +* **parent**: Parent assembly of the component. +* **xPos**: The x-position in pixels in the Analysis View. +* **yPos**: The y-position in pixels in the Analysis View. + + + +**Parameters**: + +* BSTR **serverPath** +* BSTR **name** +* BSTR **parent** +* _[optional]_ VARIANT **xPos** +* _[optional]_ VARIANT **yPos** + +**Return type**: void + + +### Function createLink + +![][public] + +``` +void ModelCenter::IModelCenter::createLink(BSTR variable, BSTR equation) +``` + + + +Creates a link to the specified variable based on the specified equation. + + + + + + +**Parameters**: + +* **variable**: Variable to add the link to. +* **equation**: Equation of the link. + + + +**Parameters**: + +* BSTR **variable** +* BSTR **equation** + +**Return type**: void + + +### Function newModel + +![][public] + +``` +void ModelCenter::IModelCenter::newModel([optional]VARIANT modelType) +``` + + + +Creates a new Model. + + + + + + +**Parameters**: + +* **modelType**:
+ + + +**Parameters**: + +* _[optional]_ VARIANT **modelType** + +**Return type**: void + + +### Function saveModel + +![][public] + +``` +void ModelCenter::IModelCenter::saveModel() +``` + + + +Saves the current Model. + + + +**Return type**: void + + +### Function saveModelAs + +![][public] + +``` +void ModelCenter::IModelCenter::saveModelAs(BSTR fileName) +``` + + + +Saves the current Model to a specified file. + + + + + + +**Parameters**: + +* **fileName**: Path to save the Model in. + + + +**Parameters**: + +* BSTR **fileName** + +**Return type**: void + + +### Function closeModel + +![][public] + +``` +void ModelCenter::IModelCenter::closeModel() +``` + + + +Closes the current Model. + + + +**Return type**: void + + +### Function loadModel + +![][public] + +``` +void ModelCenter::IModelCenter::loadModel(BSTR fileName, [optional]VARIANT onConnectError) +``` + + + +Loads a .pxc file. + + + + + + +**Parameters**: + +* **fileName**: Path of the .pxc file. +* **onConnectError**: States what to do when a connect error is encountered.
+ (see [OnConnectionErrorMode](namespaceModelCenter.md#namespaceModelCenter_1a916012c305b3ade57ea11ed7fe1f6af2) for error modes, default is CONN_ERR_ERROR). + + + +**Parameters**: + +* BSTR **fileName** +* _[optional]_ VARIANT **onConnectError** + +**Return type**: void + + +### Function getVariable + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::getVariable(BSTR name) +``` + + + +Gets a pointer to a variable. + + + + + + +**Parameters**: + +* **name**: Full ModelCenter path of the variable. + + +**Returns**: + +IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: IDispatch * + + +### Function getComponent + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::getComponent(BSTR name) +``` + + + +Gets a pointer to the Component. + + + + + + +**Parameters**: + +* **name**: Full ModelCenter path of the Component. + + +**Returns**: + +IDispatch* to an [IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) object. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: IDispatch * + + +### Function exit + +![][public] + +``` +void ModelCenter::IModelCenter::exit() +``` + + + +Deprecated. +**Deprecated**: + +No longer used. + + + +**Return type**: void + + +### Function createDataCollector + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::createDataCollector(BSTR tradeStudyType, BSTR setup) +``` + + + +Creates a new Data Collector. + + + + + + +**Parameters**: + +* **tradeStudyType**: Registry ID of the Plug-In. This is obtained by calling the [getRegID ](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac0dd856b24d06484c6ded0aba0199016) method of the IAddToModel* object that is passed into the Plug-In's construct method. +* **setup**: A string that is generated from the Plug-In's "toString" method that can be restored later by the Plug-In's "fromString" method. + + +**Returns**: + +IDispatch* to an [IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) object. + + +**Deprecated**: + +use [createDataExplorer()](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1a3edba311337bb171b956e0d331cfa05f) instead + + + +**Parameters**: + +* BSTR **tradeStudyType** +* BSTR **setup** + +**Return type**: IDispatch * + + +### Function tradeStudyEnd + +![][public] + +``` +void ModelCenter::IModelCenter::tradeStudyEnd() +``` + + + +Lets ModelCenter know that a Trade Study has been completed. + + + +**Return type**: void + + +### Function createJobManager + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::createJobManager([optional]VARIANT showProgressDialog) +``` + + + +Creates a new Job Manager object. + + + + + + +**Parameters**: + +* **showProgressDialog**: an optional VARIANT that specifies whether or not to show a progress dialog when creating the job manager. Possible values are: +* true to show a progress dialog and attempt to parent it to [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) + +* false to not show a progress dialog + +* a long value that corresponds to the HWND of the window to which the progress dialog should be parented
+ + +**Returns**: + +IDispatch* to an [IJobManager](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **showProgressDialog** + +**Return type**: IDispatch * + + +### Function tradeStudyStart + +![][public] + +``` +void ModelCenter::IModelCenter::tradeStudyStart() +``` + + + +Lets ModelCenter know that a Trade Study has been started. + + + +**Return type**: void + + +### Function getHaltStatus + +![][public] + +``` +boolean ModelCenter::IModelCenter::getHaltStatus() +``` + + + +Finds out if the user has pressed the halt button. + + + + + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Return type**: boolean + + +### Function getModel + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::getModel() +``` + + + +Gets a pointer to the Model. + + + + + + +**Returns**: + +IDispatch* to an [IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) object. + + + +**Return type**: IDispatch * + + +### Function MessageBox + +![][public] + +``` +void ModelCenter::IModelCenter::MessageBox(BSTR msg,[optional]VARIANT force) +``` + + + +Creates a MessageBox dialog. + + + + + + +**Parameters**: + +* **msg**: Message to display in the MessageBox. +* **force**:
+ + + +**Parameters**: + +* BSTR **msg** +* _[optional]_ VARIANT **force** + +**Return type**: void + + +### Function getValueAbsolute + +![][public] + +``` +VARIANT ModelCenter::IModelCenter::getValueAbsolute(BSTR varName) +``` + + + +Gets the value of a variable without validating it. + + + + + + +**Parameters**: + +* **varName**: Full ModelCenter path of the variable. + + +**Returns**: + +The value as a variant. + + + +**Parameters**: + +* BSTR **varName** + +**Return type**: VARIANT + + +### Function setScheduler + +![][public] + +``` +void ModelCenter::IModelCenter::setScheduler(BSTR scheduler) +``` + + + +Sets the current active scheduler for the Model. + + + + + + +**Parameters**: + +* **scheduler**: The scheduler type. Possible types are: +* forward + +* backward + +* mixed + +* script + +Note: all scheduler types are case sensitive. + + + +**Parameters**: + +* BSTR **scheduler** + +**Return type**: void + + +### Function removeComponent + +![][public] + +``` +void ModelCenter::IModelCenter::removeComponent(BSTR name) +``` + + + +Removes the specified component from the Model. + + + + + + +**Parameters**: + +* **name**: Full ModelCenter path of the component to remove. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: void + + +### Function breakLink + +![][public] + +``` +void ModelCenter::IModelCenter::breakLink(BSTR variable) +``` + + + +Breaks the link to a variable. + + + + + + +**Parameters**: + +* **variable**: The full ModelCenter path of the variable whose link is to be broken. + +Example demonstrating how to break a link: +``` +mc.breakLink "Model.Linear.x" +``` + + + +**Parameters**: + +* BSTR **variable** + +**Return type**: void + + +### Function getHWND + +![][public] + +``` +long ModelCenter::IModelCenter::getHWND() +``` + + + +Gets the HWND of the current ModelCenter instance. This HWND can then be used as the parent of the Plug-In GUI. + + + + + + +**Returns**: + +Value of the current HWND instance. + + + +**Return type**: long + + +### Function checkout + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::checkout(BSTR feature) +``` + + + +Checks out a license feature from FLEXlm + + + + + + +**Parameters**: + +* **feature**: the name of the feature to be checked out + + +**Returns**: + +an [IFeature](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature) object + + + +**Parameters**: + +* BSTR **feature** + +**Return type**: IDispatch * + + +### Function checkout2 + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::checkout2(BSTR feature, BSTR productRelease) +``` + + + +Checks out a license feature from FLEXlm + + + + + + +**Parameters**: + +* **feature**: the name of the feature to be checked out +* **productRelease**: the release date of the feature being passed + + +**Returns**: + +an [IFeature](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature) object + + + +**Parameters**: + +* BSTR **feature** +* BSTR **productRelease** + +**Return type**: IDispatch * + + +### Function runMacro + +![][public] + +``` +VARIANT ModelCenter::IModelCenter::runMacro(BSTR macro, [optional]VARIANT useMCObject) +``` + + + +Runs the specified macro. + + + + + + +**Parameters**: + +* **macro**: The name of the macro to run. +* **useMCObject**: whether or not to use the [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) object + + +**Returns**: + +
+ + + +**Parameters**: + +* BSTR **macro** +* _[optional]_ VARIANT **useMCObject** + +**Return type**: VARIANT + + +### Function createAssembly + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::createAssembly(BSTR name, BSTR parent, [optional]VARIANT assemblyType) +``` + + + +Creates a new Assembly in the Model. + + + + + + +**Parameters**: + +* **name**: Desired name of the new Assembly. +* **parent**: Full ModelCenter path of the parent Assembly. +* **assemblyType**:
+ + +**Returns**: + +IDispatch* to an [IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) object. + +Example demonstrating how to create an Assembly: +``` +Dim assembly As IAssembly +Set assembly=mc.createAssembly("myAssembly", "Model") +``` + + + +**Parameters**: + +* BSTR **name** +* BSTR **parent** +* _[optional]_ VARIANT **assemblyType** + +**Return type**: IDispatch * + + +### Function createAssemblyVariable + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::createAssemblyVariable(BSTR name, BSTR type, BSTR parent) +``` + + + +Create a new variable in an Assembly. + + + + + + +**Parameters**: + +* **name**: Desired name of the new variable. +* **type**: Type of the new variable. Possible types are: +* double + +* int + +* boolean + +* string + +* file + +* double[] + +* int[] + +* boolean[] + +* string[] + +* quadfacet + +* surfaceofrevolution + +* nurbs + +* bspline + +* ruled + +* skinned + +* vrml + +* node +* **parent**: Full ModelCenter path of the parent Assembly. + + +**Returns**: + +IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object. + +Example demonstrating how to create a variable in an existing Assembly: +``` +Dim var As IVariable +Set var=mc.createAssemblyVariable("myVar", "double", "Model") +``` + + + +**Parameters**: + +* BSTR **name** +* BSTR **type** +* BSTR **parent** + +**Return type**: IDispatch * + + +### Function autoLink + +![][public] + +``` +void ModelCenter::IModelCenter::autoLink(BSTR srcComp, BSTR destComp) +``` + + + +Automatically links two components. + + + + + + +**Parameters**: + +* **srcComp**: The source component. +* **destComp**: The destination component. + + + +**Parameters**: + +* BSTR **srcComp** +* BSTR **destComp** + +**Return type**: void + + +### Function getLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IModelCenter::getLinks([optional]VARIANT reserved) +``` + + + +Returns a list of all links in the model. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + + +### Function getModelUUID + +![][public] + +``` +BSTR ModelCenter::IModelCenter::getModelUUID() +``` + + + +Returns the unique ID string for the current model. + + + + + + +**Returns**: + +The ID string for the current model. + + + +**Return type**: BSTR + + +### Function getFormatter + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::getFormatter(BSTR format) +``` + + + +Creates a new instance of a formatter which can be used to format numbers to and from a particular string style. See documentation on [IPHXFormat.setFormat()](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1aa34d6054f4542a34efb60a961ad78519) for more information on available styles. + + + + + + +**Parameters**: + +* **format**: Specified string format for the Formatter object. + + +**Returns**: + +An IDispatch* to the [IPHXFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat) object. + + + +**Parameters**: + +* BSTR **format** + +**Return type**: IDispatch * + + +### Function invokeHelp + +![][public] + +``` +void ModelCenter::IModelCenter::invokeHelp(long pageID) +``` + + + +Invokes the specified context sensitive help item out of the ModelCenter help file. + + + + + + +**Parameters**: + +* **pageID**:
+ + + +**Parameters**: + +* long **pageID** + +**Return type**: void + + +### Function launchTradeStudy + +![][public] + +``` +void ModelCenter::IModelCenter::launchTradeStudy(BSTR type, [optional]VARIANT setup) +``` + + + +Causes the specified Trade Study tool to be launched. + + + + + + +**Parameters**: + +* **type**: May be a common name, like "doe" or a fully specified URL like "common:\\tradestudy\\doe". +* **setup**:
+ + + +**Parameters**: + +* BSTR **type** +* _[optional]_ VARIANT **setup** + +**Return type**: void + + +### Function createPlugInFrame + +![][public] + +``` +long ModelCenter::IModelCenter::createPlugInFrame(BSTR name, BSTR title, BSTR reserved, LPDISPATCH plugIn, [optional]VARIANT showFavorites, [optional]VARIANT defaultHeight, [optional]VARIANT defaultWidth) +``` + + + +Creates a new frame window with favorites in it which can be used by Plug-Ins as a parent window in order to integrate with ModelCenter closer and to get favorites. Currently only supports C++ Plug-Ins. + + + + + + +**Parameters**: + +* **name**: The programmatic name of the plug-in. This is used to store favorites and settings uniquely. +* **title**: The title to put on the frame +* **reserved**: Reserved, must be blank +* **plugIn**: An IDispatch to the plug-in, used to get at the to/from string to use with favorites. +* **showFavorites**:
+* **defaultHeight**: The default height of the frame. +* **defaultWidth**: The default width of the frame. + + +**Returns**: + +
+ + + +**Parameters**: + +* BSTR **name** +* BSTR **title** +* BSTR **reserved** +* LPDISPATCH **plugIn** +* _[optional]_ VARIANT **showFavorites** +* _[optional]_ VARIANT **defaultHeight** +* _[optional]_ VARIANT **defaultWidth** + +**Return type**: long + + +### Function displayAboutBox + +![][public] + +``` +void ModelCenter::IModelCenter::displayAboutBox() +``` + + + +Display the "About" dialog for ModelCenter. + + + +**Return type**: void + + +### Function halt + +![][public] + +``` +void ModelCenter::IModelCenter::halt() +``` + + + +Stop execution of the Model currently running in ModelCenter. + + + +**Return type**: void + + +### Function displayPreferencesDialog + +![][public] + +``` +void ModelCenter::IModelCenter::displayPreferencesDialog() +``` + + + +Display the "Preferences" dialog for ModelCenter. + + + +**Return type**: void + + +### Function run + +![][public] + +``` +void ModelCenter::IModelCenter::run(BSTR variableArray) +``` + + + +Runs a specified set of variables in the current Model. + + + + + + +**Parameters**: + +* **variableArray**: A comma-separated list of ModelCenter variables to validate.
+ If no variables are specified then the entire model will be run (equivalent to clicking the scheduler run button). + + + +**Parameters**: + +* BSTR **variableArray** + +**Return type**: void + + +### Function getDataMonitor + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::getDataMonitor(BSTR component, VARIANT index) +``` + + + +Retrieves the indexed Data Monitor associated with the specified Component. + + + + + + +**Parameters**: + +* **component**: The desired Component name. +* **index**: The desired index number (0-based index). + + +**Returns**: + +
+ + + +**Parameters**: + +* BSTR **component** +* VARIANT **index** + +**Return type**: IDispatch * + + +### Function createDataMonitor + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::createDataMonitor(BSTR component, BSTR name, int x, int y) +``` + + + +Creates a Data Monitor associated with a particular component. + + + + + + +**Parameters**: + +* **component**: The name of the ModelCenter component to associate the Data Monitor with. +* **name**: The name of the Data Monitor. +* **x**: The x-position of the Data Monitor. +* **y**: The y-position of the Data Monitor. + + +**Returns**: + +
+ + + +**Parameters**: + +* BSTR **component** +* BSTR **name** +* int **x** +* int **y** + +**Return type**: IDispatch * + + +### Function isOkToClose + +![][public] + +``` +boolean ModelCenter::IModelCenter::isOkToClose() +``` + + + +Determines whether any sub-windows are currently open in ModelCenter. + + + + + + +**Returns**: + +True if no sub windows are open, else false. + + + +**Return type**: boolean + + +### Function addIcon + +![][public] + +``` +short ModelCenter::IModelCenter::addIcon(BSTR iconFile) +``` + + + +Adds a given icon file to the list of icons known by model. + + + + + + +**Parameters**: + +* **iconFile**: The name of the icon file to add. + + +**Returns**: + +The index of the icon in [ModelCenter](namespaceModelCenter.md#namespaceModelCenter)'s icon list. + + + +**Parameters**: + +* BSTR **iconFile** + +**Return type**: short + + +### Function removeDataMonitor + +![][public] + +``` +boolean ModelCenter::IModelCenter::removeDataMonitor(BSTR component, VARIANT index) +``` + + + +Remove a specific data monitor associated with a particular component + + + + + + +**Parameters**: + +* **component**: the name of the component under which to find the data monitor for deletion +* **index**: the integer index (0-based index) or string title of the data monitor being removed + + +**Returns**: + +whether the data monitor was successfully found and deleted + + + +**Parameters**: + +* BSTR **component** +* VARIANT **index** + +**Return type**: boolean + + +### Function setUserName + +![][public] + +``` +void ModelCenter::IModelCenter::setUserName(BSTR userName) +``` + + + +Sets the user name that ModelCenter will use for authentication. + + + + + + +**Parameters**: + +* **userName**: The user name. + + + +**Parameters**: + +* BSTR **userName** + +**Return type**: void + + +### Function setPassword + +![][public] + +``` +void ModelCenter::IModelCenter::setPassword(BSTR password) +``` + + + +Sets the password that ModelCenter will use for authentication. + + + + + + +**Parameters**: + +* **password**: The password. + + + +**Parameters**: + +* BSTR **password** + +**Return type**: void + + +### Function getModelCenterPath + +![][public] + +``` +BSTR ModelCenter::IModelCenter::getModelCenterPath() +``` + + + +Returns the full path to where ModelCenter is installed. + + + + + + +**Returns**: + +Full file path where ModelCenter is installed. + + + +**Return type**: BSTR + + +### Function getDataExplorer + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::getDataExplorer(int index) +``` + + + +Gets a pointer to the specified Data Explorer. + + + + + + +**Parameters**: + +* **index**: The desired index number (0-based index). + + +**Returns**: + +IDispatch* to an IDataExplorer object. + + + +**Parameters**: + +* int **index** + +**Return type**: IDispatch * + + +### Function getDataCollector + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::getDataCollector(int index) +``` + + + +Gets a pointer to the specified Data Collector. + + + + + + +**Parameters**: + +* **index**: The desired index number (0-based index). + + +**Returns**: + +IDispatch* to an [IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) object. + + + +**Parameters**: + +* int **index** + +**Return type**: IDispatch * + + +### Function getLogger + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::getLogger() +``` + + + +Gets the [ILogger](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger) object used by ModelCenter for logging status and error messages. + + + + + + +**Returns**: + +IDispatch* to an [ILogger](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger) object. + + + +**Return type**: IDispatch * + + +### Function createPlugInFrame2 + +![][public] + +``` +long ModelCenter::IModelCenter::createPlugInFrame2(BSTR name, BSTR title, BSTR reserved, LPDISPATCH plugIn, [optional]VARIANT showFavorites, [optional]VARIANT defaultHeight, [optional]VARIANT defaultWidth, [optional]VARIANT minimumHeight, [optional]VARIANT minimumWidth) +``` + + + +Creates a new frame window with favorites in it which can be used by Plug-Ins as a parent window in order to integrate with ModelCenter closer and to get favorites. Currently only supports C++ Plug-Ins. + + + + + + +**Parameters**: + +* **name**: The programmatic name of the plug-in. This is used to store favorites and settings uniquely. +* **title**: The title to put on the frame +* **reserved**: Reserved, must be blank +* **plugIn**: An IDispatch to the plug-in, used to get at the to/from string to use with favorites. +* **showFavorites**:
+* **defaultHeight**: The default height of the frame. +* **defaultWidth**: The default width of the frame. +* **minimumHeight**: The minimum allowed height of the frame. +* **minimumWidth**: The minimum allowed width of the frame. + + +**Returns**: + +
+ + + +**Parameters**: + +* BSTR **name** +* BSTR **title** +* BSTR **reserved** +* LPDISPATCH **plugIn** +* _[optional]_ VARIANT **showFavorites** +* _[optional]_ VARIANT **defaultHeight** +* _[optional]_ VARIANT **defaultWidth** +* _[optional]_ VARIANT **minimumHeight** +* _[optional]_ VARIANT **minimumWidth** + +**Return type**: long + + +### Function moveComponent + +![][public] + +``` +void ModelCenter::IModelCenter::moveComponent(BSTR component, BSTR parent, [optional]VARIANT index) +``` + + + +Moves the component to the parent at the given index. + + + + + + +**Parameters**: + +* **component**: The component to move. +* **parent**: Owning object of the component. +* **index**: Position in the parent. + + + +**Parameters**: + +* BSTR **component** +* BSTR **parent** +* _[optional]_ VARIANT **index** + +**Return type**: void + + +### Function setAssemblyStyle + +![][public] + +``` +void ModelCenter::IModelCenter::setAssemblyStyle(BSTR assemblyName, AssemblyStyle style, [optional]VARIANT width, [optional]VARIANT height) +``` + + + +Sets the assembly style of the component (collapse, expanded, N^2, etc). + + + + + + +**Parameters**: + +* **assemblyName**: The assembly the style will be set. +* **style**:
+* **width**:
+* **height**:
+ + + +**Parameters**: + +* BSTR **assemblyName** +* [AssemblyStyle](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625) **style** +* _[optional]_ VARIANT **width** +* _[optional]_ VARIANT **height** + +**Return type**: void + + +### Function getAssemblyStyle + +![][public] + +``` +AssemblyStyle ModelCenter::IModelCenter::getAssemblyStyle(BSTR assemblyName, int *width, int *height) +``` + + + +Gets the style of the assembly (Collapsed, expanded, N^2, etc). + + + + + + +**Parameters**: + +* **assemblyName**: The assembly to retrieve. +* **width**:
+* **height**:
+ + +**Returns**: + +AssemblyStyle + + + +**Parameters**: + +* BSTR **assemblyName** +* int * **width** +* int * **height** + +**Return type**: [AssemblyStyle](namespaceModelCenter.md#namespaceModelCenter_1a91c424f9204166f9d85ca1d04b1cf625) + + +### Function getAssembly + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::getAssembly(BSTR name) +``` + + + +Gets the assembly by the given name. + + + + + + +**Parameters**: + +* **name**: The name of the assembly. + + +**Returns**: + +IDispatch* to an [IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) object. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: IDispatch * + + +### Function createAndInitComponent + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::createAndInitComponent(BSTR serverPath, BSTR name, BSTR parent, BSTR initString, [optional]VARIANT xPos, [optional]VARIANT yPos) +``` + + + +Creates a new component and initializes it from string data. + + + + + + +?> This method can only be invoked on plug-ins which support IComponentPlugin.fromString(). Furthermore, it should only be used when you know exactly the format that is expected by the component's fromString() method. It is designed to be used from plug-ins in third-party software which need to initialize a matching component to connect to that software in the model.
+
+Ideally, both the plug-in for the third-party software and the ModelCenter component will share the same codebase, so you can generate the configuration string from the same code which you will use to process it later. Mismatch between formats will almost certainly cause this method to fail. + + +**Parameters**: + +* **serverPath**: The server path, e.g. "mcre:\\localhost\block". You can get examples of server paths by looking at the component properties for existing [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) components. +* **name**: The name of the new component. +* **parent**: The parent component. +* **initString**: The initialization string for the component. If NULL, the behavior of this function is identical to [createComponent()](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1aa1c2ba41e8aeff2bc97408fd6d5e8832). +* **xPos**: The X position. +* **yPos**: The Y position. + + +**Returns**: + +The newly created [IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) object + + + +**Parameters**: + +* BSTR **serverPath** +* BSTR **name** +* BSTR **parent** +* BSTR **initString** +* _[optional]_ VARIANT **xPos** +* _[optional]_ VARIANT **yPos** + +**Return type**: IDispatch * + + +### Function getLicensingPath + +![][public] + +``` +BSTR ModelCenter::IModelCenter::getLicensingPath() +``` + + + +Gets the licensing path used by ModelCenter. By default the path is the base ModelCenter install directory. + + + + + + +**Returns**: + + + +**Return type**: BSTR + + +### Function getMacroScript + +![][public] + +``` +BSTR ModelCenter::IModelCenter::getMacroScript(BSTR macroName) +``` + + + +Gets a macro script + + + + + + +?> This method is not safe for use from a component in parallel mode and will throw an exception if used in such a manner. + + +**Parameters**: + +* **macroName**: The name of the macro. + + +**Returns**: + +A string representing the macro script. + + + +**Parameters**: + +* BSTR **macroName** + +**Return type**: BSTR + + +### Function setMacroScript + +![][public] + +``` +void ModelCenter::IModelCenter::setMacroScript(BSTR macroName, BSTR script) +``` + + + +Sets a macro script + + + + + + +?> This method is not safe for use from a component in parallel mode and will throw an exception if used in such a manner. + + +**Parameters**: + +* **macroName**: The name of the macro. +* **script**: The script text. + + + +**Parameters**: + +* BSTR **macroName** +* BSTR **script** + +**Return type**: void + + +### Function getMacroScriptLanguage + +![][public] + +``` +BSTR ModelCenter::IModelCenter::getMacroScriptLanguage(BSTR macroName) +``` + + + +Gets a macro script language + + + + + + +?> This method is not safe for use from a component in parallel mode and will throw an exception if used in such a manner. + + +**Parameters**: + +* **macroName**: The name of the macro. + + +**Returns**: + +A string representing the macro script language. + + + +**Parameters**: + +* BSTR **macroName** + +**Return type**: BSTR + + +### Function setMacroScriptLanguage + +![][public] + +``` +void ModelCenter::IModelCenter::setMacroScriptLanguage(BSTR macroName, BSTR language) +``` + + + +Sets the language for a macro script + + + + + + +?> This method is not safe for use from a component in parallel mode and will throw an exception if used in such a manner. + + +**Parameters**: + +* **macroName**: The name of the macro. +* **language**: The macro script language. + + + +**Parameters**: + +* BSTR **macroName** +* BSTR **language** + +**Return type**: void + + +### Function addNewMacro + +![][public] + +``` +void ModelCenter::IModelCenter::addNewMacro(BSTR macroName, boolean isAppMacro) +``` + + + +Adds a new macro + + + + + + +**Parameters**: + +* **macroName**: The name of the macro to show in the editor. +* **isAppMacro**: If true, the new macro will be an application macro. Otherwise, the new macro will be a model macro. + + + +**Parameters**: + +* BSTR **macroName** +* boolean **isAppMacro** + +**Return type**: void + + +### Function launchMacroEditor + +![][public] + +``` +void ModelCenter::IModelCenter::launchMacroEditor(BSTR macroName) +``` + + + +Launches the macro editor tool, and show the macro script corresponding to macroName + + + + + + +**Parameters**: + +* **macroName**: the name of the macro to show in the editor. Just show the editor if the argument is null, or is not a valid macro name. + + + +**Parameters**: + +* BSTR **macroName** + +**Return type**: void + + +### Function startGUIMode + +![][public] + +``` +void ModelCenter::IModelCenter::startGUIMode([optional]VARIANT showDialogs) +``` + + + +THIS FUNCTION IS A BETA CAPABILITY + + + + + +Normally when invoked via COM, [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) is in "server" mode and it hides all GUI and dialogs. This method can be invoked immediately after instantiating the [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) object to cause the GUI to be displayed.
+ + + + + + +Calling this method at any other time than immediately after creating the [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) object is NOT SUPPORTED. Strange behavior or even crashes will likely ensue if it is called at any other time. + + + + + +Once this method is invoked, [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) may pop up GUI dialogs requiring user interaction at any time. This means your script may hang indefinitely if a user is not there to click through. For example, if a component fails to load on model load, the user would be prompted with the failed component dialog and the [loadModel()](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab57546e9e718895bbdfa25bc1b7d1e9d) api function would hang until the user answered the dialog. + + + + + + +**Parameters**: + +* **showDialogs**: Boolean, that if true, will allow showing of startup dialogs such as the 'Recover Trade Study' dialog or 'Welcome to [ModelCenter](namespaceModelCenter.md#namespaceModelCenter)' dialog. + + + +**Parameters**: + +* _[optional]_ VARIANT **showDialogs** + +**Return type**: void + + +### Function getNumUnitCategories + +![][public] + +``` +long ModelCenter::IModelCenter::getNumUnitCategories() +``` + + + +Returns the number of unit categories in the [IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) object. + + + + + + +**Returns**: + +The number for unit categories, or -1 if there is an error. + + + +**Return type**: long + + +### Function getUnitCategoryName + +![][public] + +``` +BSTR ModelCenter::IModelCenter::getUnitCategoryName(long index) +``` + + + +Returns the name of the category of a unit. + + + + + + +**Parameters**: + +* **index**: Index of the unit. + + +**Returns**: + +The name of the category, or empty string if there is an error. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + + +### Function getNumUnits + +![][public] + +``` +long ModelCenter::IModelCenter::getNumUnits(BSTR category) +``` + + + +Returns the number of units inside a specified category. + + + + + + +**Parameters**: + +* **category**: Specified category of units. + + +**Returns**: + +The number of units, or -1 if there is an error. + + + +**Parameters**: + +* BSTR **category** + +**Return type**: long + + +### Function getUnitName + +![][public] + +``` +BSTR ModelCenter::IModelCenter::getUnitName(BSTR category, long index) +``` + + + +Gets the name of the unit. + + + + + + +**Parameters**: + +* **category**: Category to retrieve the unit. +* **index**: Index of the element in the category. + + +**Returns**: + +The name of the unit, or empty string if there is an error. + + + +**Parameters**: + +* BSTR **category** +* long **index** + +**Return type**: BSTR + + +### Function createTradeStudy + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::createTradeStudy(BSTR type, [optional]VARIANT setup) +``` + + + +Launches the specified trade study. + + + + + + +**Parameters**: + +* **type**: The string identifier for the trade study that should be started. +* **setup**: The setup string. + + +**Returns**: + +An IDispatch* to the trade study object. + + + +**Parameters**: + +* BSTR **type** +* _[optional]_ VARIANT **setup** + +**Return type**: IDispatch * + + +### Function getNetworkLocations + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::getNetworkLocations() +``` + + + +Return a reference to the Network Locations object + + + + + + +**Returns**: + +An IDispatch* to the [INetworkLocations](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations) object. + + + +**Return type**: IDispatch * + + +### Function saveVersionedModel + +![][public] + +``` +void ModelCenter::IModelCenter::saveVersionedModel(VersionStatus versionStatus, BSTR checkinMessage) +``` + + + +Saves the current Model. + + + + + + +**Parameters**: + +* **versionStatus**: how to go about versioning the model (and its submodels) +* **checkinMessage**: check-in message to be associated with the model (and its submodels) + + + +**Parameters**: + +* [VersionStatus](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0) **versionStatus** +* BSTR **checkinMessage** + +**Return type**: void + + +### Function saveVersionedModelAs + +![][public] + +``` +void ModelCenter::IModelCenter::saveVersionedModelAs(BSTR fileName, VersionStatus versionStatus, BSTR checkinMessage) +``` + + + +Saves the current Model to a specified file. + + + + + + +**Parameters**: + +* **fileName**: Path to save the Model in. +* **versionStatus**: how to go about versioning the submodel (and its submodels) +* **checkinMessage**: check-in message to be associated with the model (and its submodels) + + + +**Parameters**: + +* BSTR **fileName** +* [VersionStatus](namespaceModelCenter.md#namespaceModelCenter_1a1abdd6ad1a16bfaa9539e9a1ccc3c1a0) **versionStatus** +* BSTR **checkinMessage** + +**Return type**: void + + +### Function getVariableMetaData + +![][public] + +``` +LPDISPATCH ModelCenter::IModelCenter::getVariableMetaData(BSTR name) +``` + + + +Get metadata from a variable. Throws an exception if the variable is not found. +**Parameters**: + +* **name**: the full name of the variable + + +**Returns**: + +the metadata, in the form of an IDHVariable (from [PHXDATAHISTORYLib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib)) + + + +**Parameters**: + +* BSTR **name** + +**Return type**: LPDISPATCH + + +### Function dumpComDebug + +![][public] + +``` +void ModelCenter::IModelCenter::dumpComDebug() +``` + + + +Dump COM debug information to TRACE(); only has an effect in debug builds. + + + +**Return type**: void + + +### Function showFileBrowseDialog + +![][public] + +``` +BSTR ModelCenter::IModelCenter::showFileBrowseDialog(BSTR title, [optional]VARIANT filters, [optional]VARIANT initialUri, [optional]VARIANT hwnd) +``` + + + +Displays file selection for loading dialog and returns URI of selected file. +**Parameters**: + +* **title**: title of dialog window +* **filters**: array of file type filters +* **initialUri**: initialUri to use in dialog +* **hwnd**: the window handle to which to parent the dialog + + +**Returns**: + +URI of selected file, or empty string if none selected + + + +**Parameters**: + +* BSTR **title** +* _[optional]_ VARIANT **filters** +* _[optional]_ VARIANT **initialUri** +* _[optional]_ VARIANT **hwnd** + +**Return type**: BSTR + + +### Function showFileSaveDialog + +![][public] + +``` +BSTR ModelCenter::IModelCenter::showFileSaveDialog(BSTR title, int *selectedFilter, [optional]VARIANT initialFilename, [optional]VARIANT filters, [optional]VARIANT initialUri, [optional]VARIANT hwnd) +``` + + + +Displays file selection for saving dialog and returns URI of selected file. +**Parameters**: + +* **title**: title of dialog window +* **selectedFilter**: the number of the filter selected +* **initialFilename**: the filename to populate the save dialog with +* **filters**: array of file type filters +* **initialUri**: initialUri to use in dialog +* **hwnd**: the window handle to which to parent the dialog + + +**Returns**: + +URI of selected file, or empty string if none selected + + + +**Parameters**: + +* BSTR **title** +* int * **selectedFilter** +* _[optional]_ VARIANT **initialFilename** +* _[optional]_ VARIANT **filters** +* _[optional]_ VARIANT **initialUri** +* _[optional]_ VARIANT **hwnd** + +**Return type**: BSTR + + +### Function setLoginCallback + +![][public] + +``` +void ModelCenter::IModelCenter::setLoginCallback(IDispatch *callback) +``` + + + +Sets the login callback to use for authentication. +**Parameters**: + +* **callback**: callback to use + + + +**Parameters**: + +* IDispatch * **callback** + +**Return type**: void + + +### Function createDataHistoryVariable + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::createDataHistoryVariable() +``` + + + +Create an IDHVariable object. + + + +**Return type**: IDispatch * + + +### Function getRunOnlyMode + +![][public] + +``` +boolean ModelCenter::IModelCenter::getRunOnlyMode() +``` + + + +Gets the status of [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) being in Run-Only Mode. + + + + + + +**Returns**: + +true if [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) is in Run-Only Mode; otherwise, false + + + +**Return type**: boolean + + +### Function setRunOnlyMode + +![][public] + +``` +void ModelCenter::IModelCenter::setRunOnlyMode(boolean shouldBeInRunOnly) +``` + + + +Sets the status of [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) being in Run-Only Mode to the specified value. + + + + + +Note: This function can only be called if it is the first function to be called on a new [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) object; otherwise, it will throw an exception. This is to ensure that the correct [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) license is checked out. + + + + + + +**Parameters**: + +* **shouldBeInRunOnly**: true if [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) should be in Run-Only Mode; otherwise, false + + + +**Parameters**: + +* boolean **shouldBeInRunOnly** + +**Return type**: void + + +### Function createDataExplorer + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::createDataExplorer(BSTR tradeStudyType, BSTR setup) +``` + + + +Creates a new Data Explorer. This documentation assumes you're creating it for a trade study; if you're not you can pass almost anything in for tradeStudyType or setup. + + + + + + +**Parameters**: + +* **tradeStudyType**: Registry ID of the Plug-In. This is obtained by calling the [getRegID ](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel_1ac0dd856b24d06484c6ded0aba0199016) method of the IAddToModel* object that is passed into the Plug-In's construct method. +* **setup**: A string that is generated from the Plug-In's "toString" method that can be restored later by the Plug-In's "fromString" method. + + +**Returns**: + +IDispatch* to an [PHXDATAEXPLORERLib::\_DPHXDataExplorer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer) object. + + + +**Parameters**: + +* BSTR **tradeStudyType** +* BSTR **setup** + +**Return type**: IDispatch * + + +### Function getFileSystemInfo + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::getFileSystemInfo(BSTR url) +``` + + + +Gets the FileSystemInfo for a given URL. + + + + + + +**Parameters**: + +* **url**: the url for which to load a file system info + + + +**Parameters**: + +* BSTR **url** + +**Return type**: IDispatch * + + +### Function SAFEARRAY + +![][public] + +``` +ModelCenter::IModelCenter::SAFEARRAY(BSTR) getTradeStudyFilters() +``` + + + +Returns an array containing a list of FileDialog filters for [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) trade study files. +**Returns**: + +SAFEARRAY of filters for use in FileDialog of the files used by trade studies + + + +**Parameters**: + +* BSTR + +**Return type**: + + +### Function saveTradeStudy + +![][public] + +``` +void ModelCenter::IModelCenter::saveTradeStudy(BSTR uri, int format, LPDISPATCH dataExplorer) +``` + + + +Save the trade study currently loaded in the DataExplorer to the given URI. It will overwrite the file if it exists. Note: Saving in pxt/pxtz formats will only save legacy plots and not the new plot types. Use tstudy(TS_FORMAT_TSTUDY) format to save all plots. +**Parameters**: + +* **uri**: the uri to write the trade study to +* **format**: the file format to be used when saving the trade study. Must be set to TS_FORMAT_TSTUDY. See [TradeStudyFormat](namespaceModelCenter.md#namespaceModelCenter_1af45bfe44662b4647910a30bb0ba41dca) enumeration. +* **dataExplorer**: the data explorer from which to take trade study data + + + +**Parameters**: + +* BSTR **uri** +* int **format** +* LPDISPATCH **dataExplorer** + +**Return type**: void + + +### Function getDataCollectorForDataExplorer + +![][public] + +``` +IDispatch * ModelCenter::IModelCenter::getDataCollectorForDataExplorer(LPDISPATCH dataExplorer) +``` + + + +Retrieves a pointer to the Data Collector for the specified Data Explorer. + + + + + + +**Parameters**: + +* **dataExplorerPtr**: The Data Explorer pointer for which to retrieve a Data Collector + + +**Returns**: + +IDispatch* to the [IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) object for the specified Data Explorer + + + +**Parameters**: + +* LPDISPATCH **dataExplorer** + +**Return type**: IDispatch * + + +### Function launchDataCollectorPlugIn + +![][public] + +``` +void ModelCenter::IModelCenter::launchDataCollectorPlugIn(BSTR plugInName, LPDISPATCH dataExplorer) +``` + + + +Launches a specific Data Collector PlugIn, by name, on the specified Data Explorer. + + + + + + +**Parameters**: + +* **plugInName**: The name of the Data Collector PlugIn to be launched +* **dataExplorer**: The Data Explorer for which to launch the PlugIn + + + +**Parameters**: + +* BSTR **plugInName** +* LPDISPATCH **dataExplorer** + +**Return type**: void + + +### Function guiLoadFile + +![][public] + +``` +boolean ModelCenter::IModelCenter::guiLoadFile(BSTR fileName) +``` + + + +Loads a file in "GUI" mode, that is, unlike loadFile(...), will produce a prompt to the user to verify whether or not any currently opened model should be saved prior to loading the given file. + + + + + + +**Parameters**: + +* **fileName**: Path of the file to load. + + +**Return values**: + +* **true**: if the save was not canceled +* **false**: if the save was canceled + + + +**Parameters**: + +* BSTR **fileName** + +**Return type**: boolean + + +### Function guiSaveModel + +![][public] + +``` +void ModelCenter::IModelCenter::guiSaveModel() +``` + + + +Saves the currently open file in "GUI" mode; unlike saveModel, this can pop up a save dialog (if the file has not already been saved). It will use [ModelCenter](namespaceModelCenter.md#namespaceModelCenter)'s logic to determine what to do about versioned files. + + + +**Return type**: void + + +### Function getMacroTimeout + +![][public] + +``` +double ModelCenter::IModelCenter::getMacroTimeout(BSTR macroName) +``` + + + +Gets a macro's timeout. + + + + + + +?> This method is not safe for use from a component in parallel mode and will throw an exception if used in such a manner. + + +**Parameters**: + +* **macroName**: The name of the macro. + + +**Returns**: + +Number of seconds to allow a script to run before canceling it; -1 indicates no timeout. + + + +**Parameters**: + +* BSTR **macroName** + +**Return type**: double + + +### Function setMacroTimeout + +![][public] + +``` +void ModelCenter::IModelCenter::setMacroTimeout(BSTR macroName, double timeout) +``` + + + +Sets a macro's timeout. + + + + + + +?> This method is not safe for use from a component in parallel mode and will throw an exception if used in such a manner. + + +**Parameters**: + +* **macroName**: The name of the macro. +* **timeout**: The number of seconds to allow a script to run before canceling it; -1 indicates no timeout. + + + +**Parameters**: + +* BSTR **macroName** +* double **timeout** + +**Return type**: void + + +### Function guiCloseAllMultiplexers + +![][public] + +``` +boolean ModelCenter::IModelCenter::guiCloseAllMultiplexers() +``` + + + +Attempts to close the DataExplorers of all vizualization multiplexers. +**Returns**: + +true if the user allowed all multiplexers to close. + + + +**Return type**: boolean + +## Private functions + + +### Function setAlternateParentFrame + +![][private] + +``` +void ModelCenter::IModelCenter::setAlternateParentFrame(long hwnd) +``` + + + + + + + +**Parameters**: + +* long **hwnd** + +**Return type**: void + + +### Function destroyPlugInFrame + +![][private] + +``` +void ModelCenter::IModelCenter::destroyPlugInFrame(long hwnd) +``` + + + + + + + +**Parameters**: + +* long **hwnd** + +**Return type**: void + + +### Function showPlugInFrame + +![][private] + +``` +void ModelCenter::IModelCenter::showPlugInFrame(long hwnd) +``` + + + + + + + +**Parameters**: + +* long **hwnd** + +**Return type**: void + + +### Function hidePlugInFrame + +![][private] + +``` +void ModelCenter::IModelCenter::hidePlugInFrame(long hwnd) +``` + + + + + + + +**Parameters**: + +* long **hwnd** + +**Return type**: void + + +### Function setIconPlugInFrame + +![][private] + +``` +void ModelCenter::IModelCenter::setIconPlugInFrame(long hwnd, BSTR iconFile) +``` + + + + + + + +**Parameters**: + +* long **hwnd** +* BSTR **iconFile** + +**Return type**: void + + +### Function launchHTMLViewer + +![][private] + +``` +long ModelCenter::IModelCenter::launchHTMLViewer(BSTR url, boolean popup) +``` + + + + + + + +**Parameters**: + +* BSTR **url** +* boolean **popup** + +**Return type**: long + + +### Function runAntFile + +![][private] + +``` +void ModelCenter::IModelCenter::runAntFile(BSTR fileName) +``` + + + + + + + +**Parameters**: + +* BSTR **fileName** + +**Return type**: void + + +### Function getGlobalParameters + +![][private] + +``` +IDispatch * ModelCenter::IModelCenter::getGlobalParameters() +``` + + + + + + + +**Return type**: IDispatch * + + +### Function closeHTMLViewer + +![][private] + +``` +boolean ModelCenter::IModelCenter::closeHTMLViewer(long hwnd) +``` + + + + + + + +**Parameters**: + +* long **hwnd** + +**Return type**: boolean + + +### Function HTMLViewerWaitForClose + +![][private] + +``` +void ModelCenter::IModelCenter::HTMLViewerWaitForClose(long hwnd) +``` + + + + + + + +**Parameters**: + +* long **hwnd** + +**Return type**: void + + +### Function HTMLViewerGetMyHWND + +![][private] + +``` +long ModelCenter::IModelCenter::HTMLViewerGetMyHWND() +``` + + + + + + + +**Return type**: long + + +### Function getActiveJobManager + +![][private] + +``` +IDispatch * ModelCenter::IModelCenter::getActiveJobManager() +``` + + + + + + + +**Return type**: IDispatch * + + +### Function getPreference + +![][private] + +``` +VARIANT ModelCenter::IModelCenter::getPreference(BSTR pref) +``` + + + +Gets preference value for the given key (pref). Note: Parses preference value in following order: Bool -> long -> double -> string +**Parameters**: + +* **preference**: (key) value to get value for + + +**Returns**: + +preference value as a variant.
+ + + +**Parameters**: + +* BSTR **pref** + +**Return type**: VARIANT + + +### Function internalLicensing + +![][private] + +``` +void ModelCenter::IModelCenter::internalLicensing(BSTR, long) +``` + + + + + + + +**Parameters**: + +* BSTR +* long + +**Return type**: void + + +### Function transformAVPoint + +![][private] + +``` +void ModelCenter::IModelCenter::transformAVPoint(int x, int y, boolean screen, VARIANT *tx, VARIANT *ty) +``` + + + + + + + +**Parameters**: + +* int **x** +* int **y** +* boolean **screen** +* VARIANT * **tx** +* VARIANT * **ty** + +**Return type**: void + + +### Function parallelInstance + +![][private] + +``` +IDispatch * ModelCenter::IModelCenter::parallelInstance() +``` + + + + + + + +**Return type**: IDispatch * + + +### Function unAssociatedInstance + +![][private] + +``` +IDispatch * ModelCenter::IModelCenter::unAssociatedInstance() +``` + + + + + + + +**Return type**: IDispatch * + + +### Function configureLogging + +![][private] + +``` +void ModelCenter::IModelCenter::configureLogging(boolean enableLogging) +``` + + + +Configures the [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) logger, currently used for testing. + + + + + + +**Parameters**: + +* **enableLogging**: Set to true to enable the logger. + + + +**Parameters**: + +* boolean **enableLogging** + +**Return type**: void + + +### Function setXMLExtension + +![][private] + +``` +void ModelCenter::IModelCenter::setXMLExtension(BSTR xml) +``` + + + +Adds the XML as an XML extension node to the model file. + + + + + + +**Parameters**: + +* **xml**: The XML string. + + + +**Parameters**: + +* BSTR **xml** + +**Return type**: void + + +### Function getXMLExtension + +![][private] + +``` +BSTR ModelCenter::IModelCenter::getXMLExtension(BSTR nodeName, BSTR attributeName, BSTR attributeValue) +``` + + + +Gets an XML extension node from the model file that matches the specified query. + + + + + + +**Parameters**: + +* **nodeName**: Name of the XML root tag. +* **attributeName**: Name of a distinguishing attribute for the XML tag. +* **attributeValue**: Value of the attribute. + + +**Returns**: + +
+ + + +**Parameters**: + +* BSTR **nodeName** +* BSTR **attributeName** +* BSTR **attributeValue** + +**Return type**: BSTR + + +### Function setPreference + +![][private] + +``` +void ModelCenter::IModelCenter::setPreference(BSTR pref, BSTR value) +``` + + + + + + + +**Parameters**: + +* BSTR **pref** +* BSTR **value** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1INetworkLocations.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1INetworkLocations.md index cd8787ff70..c59cb765fa 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1INetworkLocations.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1INetworkLocations.md @@ -1,122 +1,121 @@ - -# Interface ModelCenter::INetworkLocations - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5062) - - - -Caches network location credentials and fetches them when needed to avoid reauthentication when accessing a previously accessed network. - -## Members - -* [add](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations_1a86769591b49fd0bf2ce90bfd45c24bdf) -* [exists](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations_1a6e6cf7b365025116e67b9ddd575b10b1) -* [removeAddress](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations_1aa7869edab5e7d597c67804e2d5dcf561) - -## Public functions - - -### Function add - -![][public] - -``` -void ModelCenter::INetworkLocations::add(BSTR address, BSTR username, BSTR password) -``` - - - -Add the specified network location to the list. - - - - - - -**Parameters**: - -* **address**: the location to add (string form of a URI) -* **username**: the username to use for logging into this location -* **password**: the password to use for logging into this location - - - -**Parameters**: - -* BSTR **address** -* BSTR **username** -* BSTR **password** - -**Return type**: void - - -### Function exists - -![][public] - -``` -boolean ModelCenter::INetworkLocations::exists(BSTR address) -``` - - - -Is the specified location in the list of network locations? - - - - - - -**Parameters**: - -* **address**: The location to be checked on. - - -**Returns**: - -True if the address exists, else false. - - - -**Parameters**: - -* BSTR **address** - -**Return type**: boolean - - -### Function removeAddress - -![][public] - -``` -void ModelCenter::INetworkLocations::removeAddress(BSTR address) -``` - - - -Remove the specified network location to the list. - - - - - - -**Parameters**: - -* **address**: the location to remove - - - -**Parameters**: - -* BSTR **address** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::INetworkLocations + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5062) + + + +Caches network location credentials and fetches them when needed to avoid reauthentication when accessing a previously accessed network. + +## Members + +* [add](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations_1a86769591b49fd0bf2ce90bfd45c24bdf) +* [exists](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations_1a6e6cf7b365025116e67b9ddd575b10b1) +* [removeAddress](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations_1aa7869edab5e7d597c67804e2d5dcf561) + +## Public functions + + +### Function add + +![][public] + +``` +void ModelCenter::INetworkLocations::add(BSTR address, BSTR username, BSTR password) +``` + + + +Add the specified network location to the list. + + + + + + +**Parameters**: + +* **address**: the location to add (string form of a URI) +* **username**: the username to use for logging into this location +* **password**: the password to use for logging into this location + + + +**Parameters**: + +* BSTR **address** +* BSTR **username** +* BSTR **password** + +**Return type**: void + + +### Function exists + +![][public] + +``` +boolean ModelCenter::INetworkLocations::exists(BSTR address) +``` + + + +Is the specified location in the list of network locations? + + + + + + +**Parameters**: + +* **address**: The location to be checked on. + + +**Returns**: + +True if the address exists, else false. + + + +**Parameters**: + +* BSTR **address** + +**Return type**: boolean + + +### Function removeAddress + +![][public] + +``` +void ModelCenter::INetworkLocations::removeAddress(BSTR address) +``` + + + +Remove the specified network location to the list. + + + + + + +**Parameters**: + +* **address**: the location to remove + + + +**Parameters**: + +* BSTR **address** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IObjectVariable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IObjectVariable.md index 472fabd43f..7ccb1deb36 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IObjectVariable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IObjectVariable.md @@ -1,2639 +1,2638 @@ - -# Interface ModelCenter::IObjectVariable - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 2115) - - - -COM Instance. - -**Inherits from**: - -* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) - -## Members - -* [callMethod](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ab1c0d770f00a0c466eacecda838b3850) -* [deleteAllMembers](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a763852aed64e16a58160d166c8addd23) -* [deleteMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a30200ac90fd4115c2eb6c5641a77eddb) -* [dependentLinks](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af52780ea6b4984f40b16c8c072e1b005) -* [dependents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ae106e94dca5f19c46ed9f82c67772660) -* [description](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a73b60bd367cc0e6783f9e5ad0bf96811) -* [directDependents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af1b4238d92307aa3586b4f7070e497be) -* [directPrecedents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aac5eb818fb62f131d6ecb13fd3f6aa34) -* [fromFile](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a5e4a925c2918b6ac9da355b2287e3d04) -* [fromString](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aca195574fffbfac6577eb4b0d54f3dd8) -* [fromXML](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a4697fd5d09c8ade51e7a905a4202e5e9) -* [getArrayMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a5dc9de363afe0659af36716807543b05) -* [getArrayMemberAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a24b1cc73d5868b9e8a3014209689d088) -* [getArrayMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a13f1700a491d9f13070a854092887b20) -* [getArrayMemberValueAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7b6b51c7f0eb9a262d1ba0a2bf831368) -* [getClassURL](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7cd400b4cd38cacd370b5c2b6246375c) -* [getFileExtension](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a610338503721a3cd0992fa5af793b718) -* [getFileName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a8f71ab194f3468c084aea4beca2c43b9) -* [getFullName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7d1acdd7a964ceb7d189c87a19e9bcb3) -* [getIsBinary](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1afaad0639d6eeb9543d9ead12e9164094) -* [getMemberDescription](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1abb5cd702a72b774a9b93a50c1a4a4270) -* [getMemberDimensions](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac7ead6acd3c9f25b85e9670c396babbe) -* [getMemberEnumAliases](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ae8008b1c066e802a5838dfdc9775785d) -* [getMemberEnumValues](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a58394bc10f092128be001e36d890c0be) -* [getMemberLength](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acc1266cc18716f9973ec60f57c4a657d) -* [getMemberList](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a06be37e0fa407f4197aff2e534f61eb7) -* [getMemberLowerBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1afd9fba6ca47b0bf5fc48a2d210654d1c) -* [getMemberNumDimensions](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a558bd8128469e74dacaae9236e57eed0) -* [getMemberProperty](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac9fe0949b94f5f8243a2b783ed2a65b1) -* [getMemberType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa0e74d911fa3c06e65ae0061bb0a1740) -* [getMemberUnits](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa893e48f7214f7b0c31f5628c16ebb0a) -* [getMemberUpperBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acbf0879d4bf1acfaf7cac4f32ef9df0e) -* [getMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7143a8eed8b14b1b6b7772e82f472cd8) -* [getMemberValueAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a75f4995da0954629b58243f202e1681e) -* [getMetadata](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6fe6bbfed4b08df8c9f9a4c86cb49ca5) -* [getMethodList](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1ad90418c9d492ed35dbb1d20943035e) -* [getName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1ec0c0bce4884b2c8c1decf29f4d5b86) -* [getType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a40cc49ff4f6fd51695549d4ad32a4384) -* [hasChanged](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a221928e7f8f5b8f5ff309f6e768a8d96) -* [hasMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1b153917fd978107a15c2b2283d9f1a0) -* [hasMemberLowerBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a2870271930867129b9102eec3c778b28) -* [hasMemberUpperBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac291b12d8f349c09c18162cda4299a4a) -* [hide](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a70d41ee491cb94eaa45dd1e3e6c805c9) -* [invalidate](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aff411bdfa6a95ccc904878f1ffecba6b) -* [isInput](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1adb2ffa6d382f3874d63cab8c53f956c6) -* [isInputToComponent](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aff062edf68ee2b0ff7db9b81cba0899a) -* [isInputToModel](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa0e5a61596a334437a407396c4a38e44) -* [isNonStrictType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac232ce8558a68f9f27661644fbcee3b8) -* [isNumericMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a068348508497bc740975b56559316baf) -* [isValid](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a88a80a771329337246e883b3ce034400) -* [OwningComponent](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a2cd4745b4fe97b79d205b876bd91835d) -* [precedentLinks](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a25a478d55d4855cdbf4f8753b6cd6062) -* [precedents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a8c987c7df5766ca31115f25ce36f1f91) -* [reinitialize](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a481f787db359b10b814f9ff279bb1471) -* [setArrayMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a667cf875a43fda4c97325c3734ef9ed1) -* [setArrayMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1adc14eb60074b51d08f58f5f080f830b3) -* [setFileExtension](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ab1a52e485c1d4c0384d17dca0a2f74be) -* [setFileName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6824345c22985533b8e284b84e1c83f0) -* [setIsBinary](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ad6f0e0cc2595b7a2726f8d38ec573e2e) -* [setMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6cef469cbdd030f510d7bb51e686c257) -* [setMemberDescription](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7f78fbf9eec449dd61dd06f9d18cbfd6) -* [setMemberDimensions](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a4e889147b9f6274163e2ede028fbf1b5) -* [setMemberEnumAliases](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a18bf5de57cd2d0343bb90267608621d8) -* [setMemberEnumValues](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa2399f22fd7fc4daf9687fab4e4e512a) -* [setMemberLength](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aec74047ec9cf7e9b93b0b4509da57f15) -* [setMemberLowerBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1af9965da5833253a2234df86f677093) -* [setMemberProperty](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a15c71dd9da7797408006e31677e9901f) -* [setMemberUnits](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a033310bf93afceacc24f097ce738a135) -* [setMemberUpperBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac86c323427541c659a79974e19ad2692) -* [setMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a44df8b08cf7cb9cf6d1a5b72136d5f52) -* [setMetadata](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1d611e44da36abed0a41c6f688344841) -* [toFile](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6bd774581876d61cdeaf9637e470b0fe) -* [toFileAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a4904889be1812816c742b23763d0229e) -* [toString](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acc675e2c9045387d4ceb956d7d7d9f70) -* [toStringAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af042cdd3c4908daa767f6b0dce043e75) -* [toXML](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a9e16b89241b7593088803ace922f5ced) -* [validate](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a56e476d33f05ee8b4faa077396704fa6) -* [value](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a778d71ffd4daf5160b2594672b0cb7c8) - -## Properties - - -### Property hasChanged - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IObjectVariable::hasChanged -``` - - - - - - - -**Return type**: boolean - - -### Property hide - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IObjectVariable::hide -``` - - - - - - - -**Return type**: boolean - - -### Property OwningComponent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IObjectVariable::OwningComponent -``` - - - - - - - -**Return type**: LPDISPATCH - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IObjectVariable::value -``` - - - -Value of the variable. - - - -**Return type**: BSTR - - -### Property description - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IObjectVariable::description -``` - - - -The description of the variable. - - - -**Return type**: BSTR - -## Public functions - - -### Function isValid - -![][public] - -``` -boolean ModelCenter::IObjectVariable::isValid() -``` - - - -Returns whether or not the variable is valid. - - - - - - -**Returns**: - -True if variable is valid. False if the variable is not valid. - - - -**Return type**: boolean - -**Reimplements**: [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) - - -### Function validate - -![][public] - -``` -void ModelCenter::IObjectVariable::validate() -``` - - - -Validates the variable by running the component if needed. - - - -**Return type**: void - -**Reimplements**: [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IObjectVariable::getName() -``` - - - -Gets the name of the variable. - - - - - - -**Returns**: - -The name of the variable. - - - -**Return type**: BSTR - -**Reimplements**: [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IObjectVariable::getFullName() -``` - - - -Gets the full ModelCenter path of the variable. - - - - - - -**Returns**: - -The full ModelCenter path of the variable. - - - -**Return type**: BSTR - -**Reimplements**: [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IObjectVariable::getType() -``` - - - -Gets the type of the variable. - - - - - - -**Returns**: - -The type of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) - - -### Function isInput - -![][public] - -``` -boolean ModelCenter::IObjectVariable::isInput() -``` - - - -Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa0e5a61596a334437a407396c4a38e44). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) - - -### Function toString - -![][public] - -``` -BSTR ModelCenter::IObjectVariable::toString() -``` - - - -Converts the variable value to a string, validating the variable if necessary. - - - - - - -**Returns**: - -The value of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) - - -### Function fromString - -![][public] - -``` -void ModelCenter::IObjectVariable::fromString(BSTR value) -``` - - - -Sets the value of the variable from the specified string. - - - - - - -**Parameters**: - -* **value**: New value. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - -**Reimplements**: [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) - - -### Function toStringAbsolute - -![][public] - -``` -BSTR ModelCenter::IObjectVariable::toStringAbsolute() -``` - - - -Converts the value of the variable to a string. - - - - - - -**Returns**: - -The value of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IObjectVariable::invalidate() -``` - - - -Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. - - - -**Return type**: void - -**Reimplements**: [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) - - -### Function directPrecedents - -![][public] - -``` -LPDISPATCH ModelCenter::IObjectVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) - - -### Function directDependents - -![][public] - -``` -LPDISPATCH ModelCenter::IObjectVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) - - -### Function precedentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IObjectVariable::precedentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) - - -### Function dependentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IObjectVariable::dependentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) - - -### Function precedents - -![][public] - -``` -LPDISPATCH ModelCenter::IObjectVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) - - -### Function dependents - -![][public] - -``` -LPDISPATCH ModelCenter::IObjectVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) - - -### Function isInputToComponent - -![][public] - -``` -boolean ModelCenter::IObjectVariable::isInputToComponent() -``` - - - -Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) - - -### Function isInputToModel - -![][public] - -``` -boolean ModelCenter::IObjectVariable::isInputToModel() -``` - - - -Checks whether or not the variable is an input. A linked input returns false (Output). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) - - -### Function setMetadata - -![][public] - -``` -void ModelCenter::IObjectVariable::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) -``` - - - -Sets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata specifier used to store the data. -* **type**:
-* **value**:
-* **access**:
-* **archive**:
- - - -**Parameters**: - -* BSTR **name** -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** -* VARIANT **value** -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** -* boolean **archive** - -**Return type**: void - -**Reimplements**: [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) - - -### Function getMetadata - -![][public] - -``` -VARIANT ModelCenter::IObjectVariable::getMetadata(BSTR name) -``` - - - -Gets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata key name. - - -**Returns**: - -Metadata value. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -**Reimplements**: [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) - - -### Function getClassURL - -![][public] - -``` -BSTR ModelCenter::IObjectVariable::getClassURL() -``` - - - -Gets the class URL. - - - - - - -**Returns**: - -The URL for the class. - - - -**Return type**: BSTR - - -### Function getMemberValue - -![][public] - -``` -VARIANT ModelCenter::IObjectVariable::getMemberValue(BSTR member) -``` - - - -Gets the value of a member. - - - - - - -**Parameters**: - -* **member**: Member index; (e.g., member1, grp1.member1, member1[1], member1[1,2]). - - -**Returns**: - -The value of the member. - - - -**Parameters**: - -* BSTR **member** - -**Return type**: VARIANT - - -### Function getMemberValueAbsolute - -![][public] - -``` -VARIANT ModelCenter::IObjectVariable::getMemberValueAbsolute(BSTR member) -``` - - - -Gets the value of a member without validating the variable. - - - - - - -**Parameters**: - -* **member**: Name of the member. - - -**Returns**: - -The value of the member. - - - -**Parameters**: - -* BSTR **member** - -**Return type**: VARIANT - - -### Function setMemberValue - -![][public] - -``` -void ModelCenter::IObjectVariable::setMemberValue(BSTR member, BSTR value) -``` - - - -Sets the value of a member. - - - - - - -**Parameters**: - -* **member**: Name of the member. -* **value**: The value of the member. - - - -**Parameters**: - -* BSTR **member** -* BSTR **value** - -**Return type**: void - - -### Function setMember - -![][public] - -``` -void ModelCenter::IObjectVariable::setMember(BSTR member, BSTR value, BSTR type) -``` - - - -Sets the value of a member. A new member will be created if the member does not exist or the current type is not the same as the type specified. - - - - - - -**Parameters**: - -* **member**: Name of the member. -* **value**: The value of the member. -* **type**: Type of the member. - - - -**Parameters**: - -* BSTR **member** -* BSTR **value** -* BSTR **type** - -**Return type**: void - - -### Function deleteMember - -![][public] - -``` -void ModelCenter::IObjectVariable::deleteMember(BSTR member) -``` - - - -Delete a member for non-strict type object. An error will be thrown for strict types - - - - - - -**Parameters**: - -* **member**: Member index. - - - -**Parameters**: - -* BSTR **member** - -**Return type**: void - - -### Function deleteAllMembers - -![][public] - -``` -void ModelCenter::IObjectVariable::deleteAllMembers() -``` - - - -Delete all members for non-strict type object. An error will be thrown for strict types. - - - -**Return type**: void - - -### Function callMethod - -![][public] - -``` -VARIANT ModelCenter::IObjectVariable::callMethod(BSTR method) -``` - - - -Call a method and return a value (primitive or array of primitives) if any. - - - - - - -**Parameters**: - -* **method**: Name of the method. - - -**Returns**: - -Value of the method. - - - -**Parameters**: - -* BSTR **method** - -**Return type**: VARIANT - - -### Function isNonStrictType - -![][public] - -``` -boolean ModelCenter::IObjectVariable::isNonStrictType() -``` - - - -Check whether a class is a non-strict type. - - - - - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Return type**: boolean - - -### Function toXML - -![][public] - -``` -BSTR ModelCenter::IObjectVariable::toXML() -``` - - - -Return an XML representation of the object. - - - - - - -**Returns**: - -An XML representation of the object. - - - -**Return type**: BSTR - - -### Function fromXML - -![][public] - -``` -void ModelCenter::IObjectVariable::fromXML(BSTR str) -``` - - - -Update the object from an XML string. - - - - - - -**Parameters**: - -* **str**: Content of an object in XML format. - - - -**Parameters**: - -* BSTR **str** - -**Return type**: void - - -### Function hasMember - -![][public] - -``` -boolean ModelCenter::IObjectVariable::hasMember(BSTR member) -``` - - - -Check if a member exists. - - - - - - -**Parameters**: - -* **member**: Name of the member. - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Parameters**: - -* BSTR **member** - -**Return type**: boolean - - -### Function isNumericMember - -![][public] - -``` -boolean ModelCenter::IObjectVariable::isNumericMember(BSTR member) -``` - - - -Check if a member is a numeric type. - - - - - - -**Parameters**: - -* **member**: Name of the member. - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Parameters**: - -* BSTR **member** - -**Return type**: boolean - - -### Function reinitialize - -![][public] - -``` -void ModelCenter::IObjectVariable::reinitialize() -``` - - - -Reinitialize the object using the current class type. - - - -**Return type**: void - - -### Function getMemberLength - -![][public] - -``` -long ModelCenter::IObjectVariable::getMemberLength(BSTR member, [optional] VARIANT dim) -``` - - - -Get length of an array member. - - - - - - -**Parameters**: - -* **member**: Name of the member. -* **dim**: Dimension id of the array member. - - -**Returns**: - -The length of the array member. - - - -**Parameters**: - -* BSTR **member** -* _[optional]_ VARIANT **dim** - -**Return type**: long - - -### Function setMemberLength - -![][public] - -``` -void ModelCenter::IObjectVariable::setMemberLength(BSTR member, long length, [optional] VARIANT dim) -``` - - - -Set length of an array member. - - - - - - -**Parameters**: - -* **member**: Name of the member. -* **length**: Length of the array. -* **dim**: Dimension id of the array member. - - - -**Parameters**: - -* BSTR **member** -* long **length** -* _[optional]_ VARIANT **dim** - -**Return type**: void - - -### Function setMemberDimensions - -![][public] - -``` -void ModelCenter::IObjectVariable::setMemberDimensions(BSTR member, long d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Set dimension of an array member. - - - - - - -**Parameters**: - -* **member**: Name of the member. -* **d1**: length of the 1st dimension. -* **d2**: length of the 2nd dimension. -* **d3**: length of the 3rd dimension. -* **d4**: length of the 4th dimension. -* **d5**: length of the 5th dimension. -* **d6**: length of the 6th dimension. -* **d7**: length of the 7th dimension. -* **d8**: length of the 8th dimension. -* **d9**: length of the 9th dimension. -* **d10**: length of the 10th dimension. - - - -**Parameters**: - -* BSTR **member** -* long **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: void - - -### Function getMemberNumDimensions - -![][public] - -``` -long ModelCenter::IObjectVariable::getMemberNumDimensions(BSTR member) -``` - - - -Get number of dimensions of an array member. - - - - - - -**Parameters**: - -* **member**: Name of the member. - - -**Returns**: - -The number of dimensions of an array member. - - - -**Parameters**: - -* BSTR **member** - -**Return type**: long - - -### Function getMemberDimensions - -![][public] - -``` -VARIANT ModelCenter::IObjectVariable::getMemberDimensions(BSTR member) -``` - - - -Get dimensions and size of an array member. - - - - - - -**Parameters**: - -* **member**: Name of the member. - - -**Returns**: - -The number of demensions of the member. - - - -**Parameters**: - -* BSTR **member** - -**Return type**: VARIANT - - -### Function getMemberType - -![][public] - -``` -BSTR ModelCenter::IObjectVariable::getMemberType(BSTR member) -``` - - - -Get type of the member. - - - - - - -**Parameters**: - -* **member**: Name of the member. - - -**Returns**: - -The type of the member. - - - -**Parameters**: - -* BSTR **member** - -**Return type**: BSTR - - -### Function hasMemberLowerBound - -![][public] - -``` -boolean ModelCenter::IObjectVariable::hasMemberLowerBound(BSTR member) -``` - - - -Check if a member has lower bound defined. - - - - - - -**Parameters**: - -* **member**: Name of the member. - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Parameters**: - -* BSTR **member** - -**Return type**: boolean - - -### Function hasMemberUpperBound - -![][public] - -``` -boolean ModelCenter::IObjectVariable::hasMemberUpperBound(BSTR member) -``` - - - -Check if a member has upper bound defined. - - - - - - -**Parameters**: - -* **member**: Name of the member. - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Parameters**: - -* BSTR **member** - -**Return type**: boolean - - -### Function getMemberLowerBound - -![][public] - -``` -double ModelCenter::IObjectVariable::getMemberLowerBound(BSTR member) -``` - - - -Get lowerBound of a member. - - - - - - -**Parameters**: - -* **member**: Name of the member. - - -**Returns**: - -The lowerBound of the member. - - - -**Parameters**: - -* BSTR **member** - -**Return type**: double - - -### Function setMemberLowerBound - -![][public] - -``` -void ModelCenter::IObjectVariable::setMemberLowerBound(BSTR member, double lowerBound) -``` - - - -Set lowerBound of the member. - - - - - - -**Parameters**: - -* **member**: Name of the member. -* **lowerBound**: The lower bound - - - -**Parameters**: - -* BSTR **member** -* double **lowerBound** - -**Return type**: void - - -### Function getMemberUpperBound - -![][public] - -``` -double ModelCenter::IObjectVariable::getMemberUpperBound(BSTR member) -``` - - - -Get upperBound of the member. - - - - - - -**Parameters**: - -* **member**: Name of the member. - - -**Returns**: - -The upperBlound of the member. - - - -**Parameters**: - -* BSTR **member** - -**Return type**: double - - -### Function setMemberUpperBound - -![][public] - -``` -void ModelCenter::IObjectVariable::setMemberUpperBound(BSTR member, double upperBound) -``` - - - -Set upperBound of the member. - - - - - - -**Parameters**: - -* **member**: Name of the member. -* **upperBound**: The upper bound. - - - -**Parameters**: - -* BSTR **member** -* double **upperBound** - -**Return type**: void - - -### Function getMemberEnumValues - -![][public] - -``` -BSTR ModelCenter::IObjectVariable::getMemberEnumValues(BSTR member) -``` - - - -Get enum values of the member. - - - - - - -**Parameters**: - -* **member**: Name of the member. - - -**Returns**: - -The enum values of the member. - - - -**Parameters**: - -* BSTR **member** - -**Return type**: BSTR - - -### Function setMemberEnumValues - -![][public] - -``` -void ModelCenter::IObjectVariable::setMemberEnumValues(BSTR member, BSTR enumValues) -``` - - - -Set enum values of the member. - - - - - - -**Parameters**: - -* **member**: Name of the member. -* **enumValues**: Enumerated values as a comma separated string. - - - -**Parameters**: - -* BSTR **member** -* BSTR **enumValues** - -**Return type**: void - - -### Function getMemberEnumAliases - -![][public] - -``` -BSTR ModelCenter::IObjectVariable::getMemberEnumAliases(BSTR member) -``` - - - -Get enum aliases of the member. - - - - - - -**Parameters**: - -* **member**: Name of the member. - - -**Returns**: - -The enum aliases of the member. - - - -**Parameters**: - -* BSTR **member** - -**Return type**: BSTR - - -### Function setMemberEnumAliases - -![][public] - -``` -void ModelCenter::IObjectVariable::setMemberEnumAliases(BSTR member, BSTR enumAliases) -``` - - - -Set enum aliases of the member. - - - - - - -**Parameters**: - -* **member**: Name of the member. -* **enumAliases**: Enumerated aliases as a comma separated string. - - - -**Parameters**: - -* BSTR **member** -* BSTR **enumAliases** - -**Return type**: void - - -### Function getMemberDescription - -![][public] - -``` -BSTR ModelCenter::IObjectVariable::getMemberDescription(BSTR member) -``` - - - -Get description of the member. - - - - - - -**Parameters**: - -* **member**: Name of the member. - - -**Returns**: - -The description of the member. - - - -**Parameters**: - -* BSTR **member** - -**Return type**: BSTR - - -### Function setMemberDescription - -![][public] - -``` -void ModelCenter::IObjectVariable::setMemberDescription(BSTR member, BSTR description) -``` - - - -Set description of the member. - - - - - - -**Parameters**: - -* **member**: Name of the member. -* **description**: The description. - - - -**Parameters**: - -* BSTR **member** -* BSTR **description** - -**Return type**: void - - -### Function getMemberUnits - -![][public] - -``` -BSTR ModelCenter::IObjectVariable::getMemberUnits(BSTR member) -``` - - - -Get units of the member. - - - - - - -**Parameters**: - -* **member**: Name of the member. - - -**Returns**: - -The units of the member. - - - -**Parameters**: - -* BSTR **member** - -**Return type**: BSTR - - -### Function setMemberUnits - -![][public] - -``` -void ModelCenter::IObjectVariable::setMemberUnits(BSTR member, BSTR units) -``` - - - -Set units of the member. - - - - - - -**Parameters**: - -* **member**: Name of the member. -* **units**: The units. - - - -**Parameters**: - -* BSTR **member** -* BSTR **units** - -**Return type**: void - - -### Function getMemberProperty - -![][public] - -``` -BSTR ModelCenter::IObjectVariable::getMemberProperty(BSTR member, BSTR propertyName) -``` - - - -Get value of a property of the member. - - - - - - -**Parameters**: - -* **member**: Name of the member. -* **propertyName**: Name of the property. - - -**Returns**: - -The value of the property of the member.
- - - -**Parameters**: - -* BSTR **member** -* BSTR **propertyName** - -**Return type**: BSTR - - -### Function setMemberProperty - -![][public] - -``` -void ModelCenter::IObjectVariable::setMemberProperty(BSTR member, BSTR propertyName, BSTR propertyValue) -``` - - - -Set value of a property of the member. - - - - - - -**Parameters**: - -* **member**: Name of the member. -* **propertyName**: Name of the property. -* **propertyValue**: Value of the property. - - - -**Parameters**: - -* BSTR **member** -* BSTR **propertyName** -* BSTR **propertyValue** - -**Return type**: void - - -### Function getMemberList - -![][public] - -``` -VARIANT ModelCenter::IObjectVariable::getMemberList(BSTR member) -``` - - - -Get a list of child members. - - - - - - -**Parameters**: - -* **member**: Name of the member. - - -**Returns**: - -The list of child members. - - - -**Parameters**: - -* BSTR **member** - -**Return type**: VARIANT - - -### Function getMethodList - -![][public] - -``` -VARIANT ModelCenter::IObjectVariable::getMethodList() -``` - - - -Get a list of methods. - - - - - - -**Returns**: - -The list of methods. - - - -**Return type**: VARIANT - - -### Function toFile - -![][public] - -``` -void ModelCenter::IObjectVariable::toFile(BSTR member, BSTR fileName, VARIANT encoding) -``` - - - -Write a file member to a file. - - - - - - -**Parameters**: - -* **member**: Name of the member -* **fileName**: Destination file name. -* **encoding**: File encoding to be used (e.g., utf8, binary, ascii). ascii is assumed if empty. - - - -**Parameters**: - -* BSTR **member** -* BSTR **fileName** -* VARIANT **encoding** - -**Return type**: void - - -### Function fromFile - -![][public] - -``` -void ModelCenter::IObjectVariable::fromFile(BSTR member, BSTR fileName) -``` - - - -Load a file into a file member. - - - - - - -**Parameters**: - -* **member**: Name of the member. -* **fileName**: Source file name. - - - -**Parameters**: - -* BSTR **member** -* BSTR **fileName** - -**Return type**: void - - -### Function toFileAbsolute - -![][public] - -``` -void ModelCenter::IObjectVariable::toFileAbsolute(BSTR member, BSTR fileName, VARIANT encoding) -``` - - - -Write a file member to a file without validating the variable. - - - - - - -**Parameters**: - -* **member**: Name of the member -* **fileName**: Destination file name. -* **encoding**: File encoding to be used (e.g., utf8, binary, ascii). ascii is assumed if empty. - - - -**Parameters**: - -* BSTR **member** -* BSTR **fileName** -* VARIANT **encoding** - -**Return type**: void - - -### Function getIsBinary - -![][public] - -``` -boolean ModelCenter::IObjectVariable::getIsBinary(BSTR member) -``` - - - -Gets the user set binary property of the file. File variables are either binary or ASCII. - - - - - - -**Parameters**: - -* **member**: Name of the member. - - -**Returns**: - -True if the binary property of the file is true, else false. - - - -**Parameters**: - -* BSTR **member** - -**Return type**: boolean - - -### Function setIsBinary - -![][public] - -``` -void ModelCenter::IObjectVariable::setIsBinary(BSTR member, boolean isBinary) -``` - - - -Sets the binary property of the file object. File variables are either binary or ASCII. - - - - - - -**Parameters**: - -* **member**: Name of the member. -* **isBinary**: Value for the binary property. - - - -**Parameters**: - -* BSTR **member** -* boolean **isBinary** - -**Return type**: void - - -### Function getFileName - -![][public] - -``` -BSTR ModelCenter::IObjectVariable::getFileName(BSTR member) -``` - - - -Get the file name of a file member. - - - - - - -**Parameters**: - -* **member**: Name of the member. - - -**Returns**: - -The name of the file. - - - -**Parameters**: - -* BSTR **member** - -**Return type**: BSTR - - -### Function setFileName - -![][public] - -``` -void ModelCenter::IObjectVariable::setFileName(BSTR member, BSTR fileName) -``` - - - -Sets the file name of the file object. Also sets the file extension if given in the name. - - - - - - -**Parameters**: - -* **member**: Name of the member. -* **fileName**: The name of the file. - - - -**Parameters**: - -* BSTR **member** -* BSTR **fileName** - -**Return type**: void - - -### Function getFileExtension - -![][public] - -``` -BSTR ModelCenter::IObjectVariable::getFileExtension(BSTR member) -``` - - - -Gets the file extension of an object file, which may be empty. - - - - - - -**Parameters**: - -* **member**: Name of the member. - - -**Returns**: - -The file extension, or empty string if no extension exists. - - - -**Parameters**: - -* BSTR **member** - -**Return type**: BSTR - - -### Function setFileExtension - -![][public] - -``` -void ModelCenter::IObjectVariable::setFileExtension(BSTR member, BSTR fileExtension) -``` - - - -Sets the file extension of the object file. The method adds the preceding '.' if excluded. - - - - - - -**Parameters**: - -* **member**: Name of the member. -* **fileExtension**: The value of the new file extension. - - - -**Parameters**: - -* BSTR **member** -* BSTR **fileExtension** - -**Return type**: void - - -### Function getArrayMemberValueAbsolute - -![][public] - -``` -VARIANT ModelCenter::IObjectVariable::getArrayMemberValueAbsolute(BSTR member, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Get value of array member without validating the variable. - - - - - - -**Parameters**: - -* **member**: Member name. -* **d1**: index in the 1st dimension (0-based index) -* **d2**: index in the 2nd dimension (0-based index) -* **d3**: index in the 3rd dimension (0-based index) -* **d4**: index in the 4th dimension (0-based index) -* **d5**: index in the 5th dimension (0-based index) -* **d6**: index in the 6th dimension (0-based index) -* **d7**: index in the 7th dimension (0-based index) -* **d8**: index in the 8th dimension (0-based index) -* **d9**: index in the 9th dimension (0-based index) -* **d10**: index in the 10th dimension (0-based index) - - -**Returns**: - -Value of the array element. - - - -**Parameters**: - -* BSTR **member** -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: VARIANT - - -### Function getArrayMemberValue - -![][public] - -``` -VARIANT ModelCenter::IObjectVariable::getArrayMemberValue(BSTR member, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Get value of array member. - - - - - - -**Parameters**: - -* **member**: Member name. -* **d1**: index in the 1st dimension (0-based index) -* **d2**: index in the 2nd dimension (0-based index) -* **d3**: index in the 3rd dimension (0-based index) -* **d4**: index in the 4th dimension (0-based index) -* **d5**: index in the 5th dimension (0-based index) -* **d6**: index in the 6th dimension (0-based index) -* **d7**: index in the 7th dimension (0-based index) -* **d8**: index in the 8th dimension (0-based index) -* **d9**: index in the 9th dimension (0-based index) -* **d10**: index in the 10th dimension (0-based index) - - -**Returns**: - -Value of the array element. - - - -**Parameters**: - -* BSTR **member** -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: VARIANT - - -### Function setArrayMemberValue - -![][public] - -``` -void ModelCenter::IObjectVariable::setArrayMemberValue(BSTR member, BSTR value, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Set value of an array member. - - - - - - -**Parameters**: - -* **member**: Name of the member. -* **value**: Value to be set. -* **d1**: index in the 1st dimension (0-based index) -* **d2**: index in the 2nd dimension (0-based index) -* **d3**: index in the 3rd dimension (0-based index) -* **d4**: index in the 4th dimension (0-based index) -* **d5**: index in the 5th dimension (0-based index) -* **d6**: index in the 6th dimension (0-based index) -* **d7**: index in the 7th dimension (0-based index) -* **d8**: index in the 8th dimension (0-based index) -* **d9**: index in the 9th dimension (0-based index) -* **d10**: index in the 10th dimension (0-based index) - - - -**Parameters**: - -* BSTR **member** -* BSTR **value** -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: void - - -### Function getArrayMemberAbsolute - -![][public] - -``` -VARIANT ModelCenter::IObjectVariable::getArrayMemberAbsolute(BSTR member) -``` - - - -Get values of an array member as a variant of safe array without validating the variable. - - - - - - -**Parameters**: - -* **member**: Member name. - - -**Returns**: - -Array values (variant of safe array). - - - -**Parameters**: - -* BSTR **member** - -**Return type**: VARIANT - - -### Function getArrayMember - -![][public] - -``` -VARIANT ModelCenter::IObjectVariable::getArrayMember(BSTR member) -``` - - - -Get values of an array member as a variant of safe array. - - - - - - -**Parameters**: - -* **member**: Member name. - - -**Returns**: - -Array values (variant of safe array). - - - -**Parameters**: - -* BSTR **member** - -**Return type**: VARIANT - - -### Function setArrayMember - -![][public] - -``` -void ModelCenter::IObjectVariable::setArrayMember(BSTR member, VARIANT array) -``` - - - -Set values of an array member from a safe array. Create an array member if the member does not exist or is a different type. - - - - - - -**Parameters**: - -* **member**: Member name. -* **array**: Values to be set (Variant of a safe array). - - - -**Parameters**: - -* BSTR **member** -* VARIANT **array** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IObjectVariable + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 2115) + + + +COM Instance. + +**Inherits from**: + +* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) + +## Members + +* [callMethod](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ab1c0d770f00a0c466eacecda838b3850) +* [deleteAllMembers](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a763852aed64e16a58160d166c8addd23) +* [deleteMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a30200ac90fd4115c2eb6c5641a77eddb) +* [dependentLinks](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af52780ea6b4984f40b16c8c072e1b005) +* [dependents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ae106e94dca5f19c46ed9f82c67772660) +* [description](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a73b60bd367cc0e6783f9e5ad0bf96811) +* [directDependents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af1b4238d92307aa3586b4f7070e497be) +* [directPrecedents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aac5eb818fb62f131d6ecb13fd3f6aa34) +* [fromFile](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a5e4a925c2918b6ac9da355b2287e3d04) +* [fromString](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aca195574fffbfac6577eb4b0d54f3dd8) +* [fromXML](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a4697fd5d09c8ade51e7a905a4202e5e9) +* [getArrayMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a5dc9de363afe0659af36716807543b05) +* [getArrayMemberAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a24b1cc73d5868b9e8a3014209689d088) +* [getArrayMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a13f1700a491d9f13070a854092887b20) +* [getArrayMemberValueAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7b6b51c7f0eb9a262d1ba0a2bf831368) +* [getClassURL](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7cd400b4cd38cacd370b5c2b6246375c) +* [getFileExtension](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a610338503721a3cd0992fa5af793b718) +* [getFileName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a8f71ab194f3468c084aea4beca2c43b9) +* [getFullName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7d1acdd7a964ceb7d189c87a19e9bcb3) +* [getIsBinary](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1afaad0639d6eeb9543d9ead12e9164094) +* [getMemberDescription](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1abb5cd702a72b774a9b93a50c1a4a4270) +* [getMemberDimensions](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac7ead6acd3c9f25b85e9670c396babbe) +* [getMemberEnumAliases](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ae8008b1c066e802a5838dfdc9775785d) +* [getMemberEnumValues](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a58394bc10f092128be001e36d890c0be) +* [getMemberLength](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acc1266cc18716f9973ec60f57c4a657d) +* [getMemberList](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a06be37e0fa407f4197aff2e534f61eb7) +* [getMemberLowerBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1afd9fba6ca47b0bf5fc48a2d210654d1c) +* [getMemberNumDimensions](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a558bd8128469e74dacaae9236e57eed0) +* [getMemberProperty](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac9fe0949b94f5f8243a2b783ed2a65b1) +* [getMemberType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa0e74d911fa3c06e65ae0061bb0a1740) +* [getMemberUnits](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa893e48f7214f7b0c31f5628c16ebb0a) +* [getMemberUpperBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acbf0879d4bf1acfaf7cac4f32ef9df0e) +* [getMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7143a8eed8b14b1b6b7772e82f472cd8) +* [getMemberValueAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a75f4995da0954629b58243f202e1681e) +* [getMetadata](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6fe6bbfed4b08df8c9f9a4c86cb49ca5) +* [getMethodList](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1ad90418c9d492ed35dbb1d20943035e) +* [getName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1ec0c0bce4884b2c8c1decf29f4d5b86) +* [getType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a40cc49ff4f6fd51695549d4ad32a4384) +* [hasChanged](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a221928e7f8f5b8f5ff309f6e768a8d96) +* [hasMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1b153917fd978107a15c2b2283d9f1a0) +* [hasMemberLowerBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a2870271930867129b9102eec3c778b28) +* [hasMemberUpperBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac291b12d8f349c09c18162cda4299a4a) +* [hide](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a70d41ee491cb94eaa45dd1e3e6c805c9) +* [invalidate](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aff411bdfa6a95ccc904878f1ffecba6b) +* [isInput](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1adb2ffa6d382f3874d63cab8c53f956c6) +* [isInputToComponent](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aff062edf68ee2b0ff7db9b81cba0899a) +* [isInputToModel](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa0e5a61596a334437a407396c4a38e44) +* [isNonStrictType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac232ce8558a68f9f27661644fbcee3b8) +* [isNumericMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a068348508497bc740975b56559316baf) +* [isValid](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a88a80a771329337246e883b3ce034400) +* [OwningComponent](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a2cd4745b4fe97b79d205b876bd91835d) +* [precedentLinks](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a25a478d55d4855cdbf4f8753b6cd6062) +* [precedents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a8c987c7df5766ca31115f25ce36f1f91) +* [reinitialize](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a481f787db359b10b814f9ff279bb1471) +* [setArrayMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a667cf875a43fda4c97325c3734ef9ed1) +* [setArrayMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1adc14eb60074b51d08f58f5f080f830b3) +* [setFileExtension](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ab1a52e485c1d4c0384d17dca0a2f74be) +* [setFileName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6824345c22985533b8e284b84e1c83f0) +* [setIsBinary](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ad6f0e0cc2595b7a2726f8d38ec573e2e) +* [setMember](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6cef469cbdd030f510d7bb51e686c257) +* [setMemberDescription](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7f78fbf9eec449dd61dd06f9d18cbfd6) +* [setMemberDimensions](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a4e889147b9f6274163e2ede028fbf1b5) +* [setMemberEnumAliases](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a18bf5de57cd2d0343bb90267608621d8) +* [setMemberEnumValues](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa2399f22fd7fc4daf9687fab4e4e512a) +* [setMemberLength](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aec74047ec9cf7e9b93b0b4509da57f15) +* [setMemberLowerBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1af9965da5833253a2234df86f677093) +* [setMemberProperty](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a15c71dd9da7797408006e31677e9901f) +* [setMemberUnits](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a033310bf93afceacc24f097ce738a135) +* [setMemberUpperBound](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ac86c323427541c659a79974e19ad2692) +* [setMemberValue](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a44df8b08cf7cb9cf6d1a5b72136d5f52) +* [setMetadata](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1d611e44da36abed0a41c6f688344841) +* [toFile](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6bd774581876d61cdeaf9637e470b0fe) +* [toFileAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a4904889be1812816c742b23763d0229e) +* [toString](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acc675e2c9045387d4ceb956d7d7d9f70) +* [toStringAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af042cdd3c4908daa767f6b0dce043e75) +* [toXML](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a9e16b89241b7593088803ace922f5ced) +* [validate](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a56e476d33f05ee8b4faa077396704fa6) +* [value](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a778d71ffd4daf5160b2594672b0cb7c8) + +## Properties + + +### Property hasChanged + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IObjectVariable::hasChanged +``` + + + + + + + +**Return type**: boolean + + +### Property hide + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IObjectVariable::hide +``` + + + + + + + +**Return type**: boolean + + +### Property OwningComponent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IObjectVariable::OwningComponent +``` + + + + + + + +**Return type**: LPDISPATCH + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IObjectVariable::value +``` + + + +Value of the variable. + + + +**Return type**: BSTR + + +### Property description + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IObjectVariable::description +``` + + + +The description of the variable. + + + +**Return type**: BSTR + +## Public functions + + +### Function isValid + +![][public] + +``` +boolean ModelCenter::IObjectVariable::isValid() +``` + + + +Returns whether or not the variable is valid. + + + + + + +**Returns**: + +True if variable is valid. False if the variable is not valid. + + + +**Return type**: boolean + +**Reimplements**: [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) + + +### Function validate + +![][public] + +``` +void ModelCenter::IObjectVariable::validate() +``` + + + +Validates the variable by running the component if needed. + + + +**Return type**: void + +**Reimplements**: [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IObjectVariable::getName() +``` + + + +Gets the name of the variable. + + + + + + +**Returns**: + +The name of the variable. + + + +**Return type**: BSTR + +**Reimplements**: [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IObjectVariable::getFullName() +``` + + + +Gets the full ModelCenter path of the variable. + + + + + + +**Returns**: + +The full ModelCenter path of the variable. + + + +**Return type**: BSTR + +**Reimplements**: [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IObjectVariable::getType() +``` + + + +Gets the type of the variable. + + + + + + +**Returns**: + +The type of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) + + +### Function isInput + +![][public] + +``` +boolean ModelCenter::IObjectVariable::isInput() +``` + + + +Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa0e5a61596a334437a407396c4a38e44). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) + + +### Function toString + +![][public] + +``` +BSTR ModelCenter::IObjectVariable::toString() +``` + + + +Converts the variable value to a string, validating the variable if necessary. + + + + + + +**Returns**: + +The value of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) + + +### Function fromString + +![][public] + +``` +void ModelCenter::IObjectVariable::fromString(BSTR value) +``` + + + +Sets the value of the variable from the specified string. + + + + + + +**Parameters**: + +* **value**: New value. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + +**Reimplements**: [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) + + +### Function toStringAbsolute + +![][public] + +``` +BSTR ModelCenter::IObjectVariable::toStringAbsolute() +``` + + + +Converts the value of the variable to a string. + + + + + + +**Returns**: + +The value of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IObjectVariable::invalidate() +``` + + + +Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. + + + +**Return type**: void + +**Reimplements**: [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) + + +### Function directPrecedents + +![][public] + +``` +LPDISPATCH ModelCenter::IObjectVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) + + +### Function directDependents + +![][public] + +``` +LPDISPATCH ModelCenter::IObjectVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) + + +### Function precedentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IObjectVariable::precedentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) + + +### Function dependentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IObjectVariable::dependentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) + + +### Function precedents + +![][public] + +``` +LPDISPATCH ModelCenter::IObjectVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) + + +### Function dependents + +![][public] + +``` +LPDISPATCH ModelCenter::IObjectVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) + + +### Function isInputToComponent + +![][public] + +``` +boolean ModelCenter::IObjectVariable::isInputToComponent() +``` + + + +Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) + + +### Function isInputToModel + +![][public] + +``` +boolean ModelCenter::IObjectVariable::isInputToModel() +``` + + + +Checks whether or not the variable is an input. A linked input returns false (Output). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) + + +### Function setMetadata + +![][public] + +``` +void ModelCenter::IObjectVariable::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) +``` + + + +Sets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata specifier used to store the data. +* **type**:
+* **value**:
+* **access**:
+* **archive**:
+ + + +**Parameters**: + +* BSTR **name** +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** +* VARIANT **value** +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** +* boolean **archive** + +**Return type**: void + +**Reimplements**: [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) + + +### Function getMetadata + +![][public] + +``` +VARIANT ModelCenter::IObjectVariable::getMetadata(BSTR name) +``` + + + +Gets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata key name. + + +**Returns**: + +Metadata value. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +**Reimplements**: [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) + + +### Function getClassURL + +![][public] + +``` +BSTR ModelCenter::IObjectVariable::getClassURL() +``` + + + +Gets the class URL. + + + + + + +**Returns**: + +The URL for the class. + + + +**Return type**: BSTR + + +### Function getMemberValue + +![][public] + +``` +VARIANT ModelCenter::IObjectVariable::getMemberValue(BSTR member) +``` + + + +Gets the value of a member. + + + + + + +**Parameters**: + +* **member**: Member index; (e.g., member1, grp1.member1, member1[1], member1[1,2]). + + +**Returns**: + +The value of the member. + + + +**Parameters**: + +* BSTR **member** + +**Return type**: VARIANT + + +### Function getMemberValueAbsolute + +![][public] + +``` +VARIANT ModelCenter::IObjectVariable::getMemberValueAbsolute(BSTR member) +``` + + + +Gets the value of a member without validating the variable. + + + + + + +**Parameters**: + +* **member**: Name of the member. + + +**Returns**: + +The value of the member. + + + +**Parameters**: + +* BSTR **member** + +**Return type**: VARIANT + + +### Function setMemberValue + +![][public] + +``` +void ModelCenter::IObjectVariable::setMemberValue(BSTR member, BSTR value) +``` + + + +Sets the value of a member. + + + + + + +**Parameters**: + +* **member**: Name of the member. +* **value**: The value of the member. + + + +**Parameters**: + +* BSTR **member** +* BSTR **value** + +**Return type**: void + + +### Function setMember + +![][public] + +``` +void ModelCenter::IObjectVariable::setMember(BSTR member, BSTR value, BSTR type) +``` + + + +Sets the value of a member. A new member will be created if the member does not exist or the current type is not the same as the type specified. + + + + + + +**Parameters**: + +* **member**: Name of the member. +* **value**: The value of the member. +* **type**: Type of the member. + + + +**Parameters**: + +* BSTR **member** +* BSTR **value** +* BSTR **type** + +**Return type**: void + + +### Function deleteMember + +![][public] + +``` +void ModelCenter::IObjectVariable::deleteMember(BSTR member) +``` + + + +Delete a member for non-strict type object. An error will be thrown for strict types + + + + + + +**Parameters**: + +* **member**: Member index. + + + +**Parameters**: + +* BSTR **member** + +**Return type**: void + + +### Function deleteAllMembers + +![][public] + +``` +void ModelCenter::IObjectVariable::deleteAllMembers() +``` + + + +Delete all members for non-strict type object. An error will be thrown for strict types. + + + +**Return type**: void + + +### Function callMethod + +![][public] + +``` +VARIANT ModelCenter::IObjectVariable::callMethod(BSTR method) +``` + + + +Call a method and return a value (primitive or array of primitives) if any. + + + + + + +**Parameters**: + +* **method**: Name of the method. + + +**Returns**: + +Value of the method. + + + +**Parameters**: + +* BSTR **method** + +**Return type**: VARIANT + + +### Function isNonStrictType + +![][public] + +``` +boolean ModelCenter::IObjectVariable::isNonStrictType() +``` + + + +Check whether a class is a non-strict type. + + + + + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Return type**: boolean + + +### Function toXML + +![][public] + +``` +BSTR ModelCenter::IObjectVariable::toXML() +``` + + + +Return an XML representation of the object. + + + + + + +**Returns**: + +An XML representation of the object. + + + +**Return type**: BSTR + + +### Function fromXML + +![][public] + +``` +void ModelCenter::IObjectVariable::fromXML(BSTR str) +``` + + + +Update the object from an XML string. + + + + + + +**Parameters**: + +* **str**: Content of an object in XML format. + + + +**Parameters**: + +* BSTR **str** + +**Return type**: void + + +### Function hasMember + +![][public] + +``` +boolean ModelCenter::IObjectVariable::hasMember(BSTR member) +``` + + + +Check if a member exists. + + + + + + +**Parameters**: + +* **member**: Name of the member. + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Parameters**: + +* BSTR **member** + +**Return type**: boolean + + +### Function isNumericMember + +![][public] + +``` +boolean ModelCenter::IObjectVariable::isNumericMember(BSTR member) +``` + + + +Check if a member is a numeric type. + + + + + + +**Parameters**: + +* **member**: Name of the member. + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Parameters**: + +* BSTR **member** + +**Return type**: boolean + + +### Function reinitialize + +![][public] + +``` +void ModelCenter::IObjectVariable::reinitialize() +``` + + + +Reinitialize the object using the current class type. + + + +**Return type**: void + + +### Function getMemberLength + +![][public] + +``` +long ModelCenter::IObjectVariable::getMemberLength(BSTR member, [optional] VARIANT dim) +``` + + + +Get length of an array member. + + + + + + +**Parameters**: + +* **member**: Name of the member. +* **dim**: Dimension id of the array member. + + +**Returns**: + +The length of the array member. + + + +**Parameters**: + +* BSTR **member** +* _[optional]_ VARIANT **dim** + +**Return type**: long + + +### Function setMemberLength + +![][public] + +``` +void ModelCenter::IObjectVariable::setMemberLength(BSTR member, long length, [optional] VARIANT dim) +``` + + + +Set length of an array member. + + + + + + +**Parameters**: + +* **member**: Name of the member. +* **length**: Length of the array. +* **dim**: Dimension id of the array member. + + + +**Parameters**: + +* BSTR **member** +* long **length** +* _[optional]_ VARIANT **dim** + +**Return type**: void + + +### Function setMemberDimensions + +![][public] + +``` +void ModelCenter::IObjectVariable::setMemberDimensions(BSTR member, long d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Set dimension of an array member. + + + + + + +**Parameters**: + +* **member**: Name of the member. +* **d1**: length of the 1st dimension. +* **d2**: length of the 2nd dimension. +* **d3**: length of the 3rd dimension. +* **d4**: length of the 4th dimension. +* **d5**: length of the 5th dimension. +* **d6**: length of the 6th dimension. +* **d7**: length of the 7th dimension. +* **d8**: length of the 8th dimension. +* **d9**: length of the 9th dimension. +* **d10**: length of the 10th dimension. + + + +**Parameters**: + +* BSTR **member** +* long **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: void + + +### Function getMemberNumDimensions + +![][public] + +``` +long ModelCenter::IObjectVariable::getMemberNumDimensions(BSTR member) +``` + + + +Get number of dimensions of an array member. + + + + + + +**Parameters**: + +* **member**: Name of the member. + + +**Returns**: + +The number of dimensions of an array member. + + + +**Parameters**: + +* BSTR **member** + +**Return type**: long + + +### Function getMemberDimensions + +![][public] + +``` +VARIANT ModelCenter::IObjectVariable::getMemberDimensions(BSTR member) +``` + + + +Get dimensions and size of an array member. + + + + + + +**Parameters**: + +* **member**: Name of the member. + + +**Returns**: + +The number of demensions of the member. + + + +**Parameters**: + +* BSTR **member** + +**Return type**: VARIANT + + +### Function getMemberType + +![][public] + +``` +BSTR ModelCenter::IObjectVariable::getMemberType(BSTR member) +``` + + + +Get type of the member. + + + + + + +**Parameters**: + +* **member**: Name of the member. + + +**Returns**: + +The type of the member. + + + +**Parameters**: + +* BSTR **member** + +**Return type**: BSTR + + +### Function hasMemberLowerBound + +![][public] + +``` +boolean ModelCenter::IObjectVariable::hasMemberLowerBound(BSTR member) +``` + + + +Check if a member has lower bound defined. + + + + + + +**Parameters**: + +* **member**: Name of the member. + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Parameters**: + +* BSTR **member** + +**Return type**: boolean + + +### Function hasMemberUpperBound + +![][public] + +``` +boolean ModelCenter::IObjectVariable::hasMemberUpperBound(BSTR member) +``` + + + +Check if a member has upper bound defined. + + + + + + +**Parameters**: + +* **member**: Name of the member. + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Parameters**: + +* BSTR **member** + +**Return type**: boolean + + +### Function getMemberLowerBound + +![][public] + +``` +double ModelCenter::IObjectVariable::getMemberLowerBound(BSTR member) +``` + + + +Get lowerBound of a member. + + + + + + +**Parameters**: + +* **member**: Name of the member. + + +**Returns**: + +The lowerBound of the member. + + + +**Parameters**: + +* BSTR **member** + +**Return type**: double + + +### Function setMemberLowerBound + +![][public] + +``` +void ModelCenter::IObjectVariable::setMemberLowerBound(BSTR member, double lowerBound) +``` + + + +Set lowerBound of the member. + + + + + + +**Parameters**: + +* **member**: Name of the member. +* **lowerBound**: The lower bound + + + +**Parameters**: + +* BSTR **member** +* double **lowerBound** + +**Return type**: void + + +### Function getMemberUpperBound + +![][public] + +``` +double ModelCenter::IObjectVariable::getMemberUpperBound(BSTR member) +``` + + + +Get upperBound of the member. + + + + + + +**Parameters**: + +* **member**: Name of the member. + + +**Returns**: + +The upperBlound of the member. + + + +**Parameters**: + +* BSTR **member** + +**Return type**: double + + +### Function setMemberUpperBound + +![][public] + +``` +void ModelCenter::IObjectVariable::setMemberUpperBound(BSTR member, double upperBound) +``` + + + +Set upperBound of the member. + + + + + + +**Parameters**: + +* **member**: Name of the member. +* **upperBound**: The upper bound. + + + +**Parameters**: + +* BSTR **member** +* double **upperBound** + +**Return type**: void + + +### Function getMemberEnumValues + +![][public] + +``` +BSTR ModelCenter::IObjectVariable::getMemberEnumValues(BSTR member) +``` + + + +Get enum values of the member. + + + + + + +**Parameters**: + +* **member**: Name of the member. + + +**Returns**: + +The enum values of the member. + + + +**Parameters**: + +* BSTR **member** + +**Return type**: BSTR + + +### Function setMemberEnumValues + +![][public] + +``` +void ModelCenter::IObjectVariable::setMemberEnumValues(BSTR member, BSTR enumValues) +``` + + + +Set enum values of the member. + + + + + + +**Parameters**: + +* **member**: Name of the member. +* **enumValues**: Enumerated values as a comma separated string. + + + +**Parameters**: + +* BSTR **member** +* BSTR **enumValues** + +**Return type**: void + + +### Function getMemberEnumAliases + +![][public] + +``` +BSTR ModelCenter::IObjectVariable::getMemberEnumAliases(BSTR member) +``` + + + +Get enum aliases of the member. + + + + + + +**Parameters**: + +* **member**: Name of the member. + + +**Returns**: + +The enum aliases of the member. + + + +**Parameters**: + +* BSTR **member** + +**Return type**: BSTR + + +### Function setMemberEnumAliases + +![][public] + +``` +void ModelCenter::IObjectVariable::setMemberEnumAliases(BSTR member, BSTR enumAliases) +``` + + + +Set enum aliases of the member. + + + + + + +**Parameters**: + +* **member**: Name of the member. +* **enumAliases**: Enumerated aliases as a comma separated string. + + + +**Parameters**: + +* BSTR **member** +* BSTR **enumAliases** + +**Return type**: void + + +### Function getMemberDescription + +![][public] + +``` +BSTR ModelCenter::IObjectVariable::getMemberDescription(BSTR member) +``` + + + +Get description of the member. + + + + + + +**Parameters**: + +* **member**: Name of the member. + + +**Returns**: + +The description of the member. + + + +**Parameters**: + +* BSTR **member** + +**Return type**: BSTR + + +### Function setMemberDescription + +![][public] + +``` +void ModelCenter::IObjectVariable::setMemberDescription(BSTR member, BSTR description) +``` + + + +Set description of the member. + + + + + + +**Parameters**: + +* **member**: Name of the member. +* **description**: The description. + + + +**Parameters**: + +* BSTR **member** +* BSTR **description** + +**Return type**: void + + +### Function getMemberUnits + +![][public] + +``` +BSTR ModelCenter::IObjectVariable::getMemberUnits(BSTR member) +``` + + + +Get units of the member. + + + + + + +**Parameters**: + +* **member**: Name of the member. + + +**Returns**: + +The units of the member. + + + +**Parameters**: + +* BSTR **member** + +**Return type**: BSTR + + +### Function setMemberUnits + +![][public] + +``` +void ModelCenter::IObjectVariable::setMemberUnits(BSTR member, BSTR units) +``` + + + +Set units of the member. + + + + + + +**Parameters**: + +* **member**: Name of the member. +* **units**: The units. + + + +**Parameters**: + +* BSTR **member** +* BSTR **units** + +**Return type**: void + + +### Function getMemberProperty + +![][public] + +``` +BSTR ModelCenter::IObjectVariable::getMemberProperty(BSTR member, BSTR propertyName) +``` + + + +Get value of a property of the member. + + + + + + +**Parameters**: + +* **member**: Name of the member. +* **propertyName**: Name of the property. + + +**Returns**: + +The value of the property of the member.
+ + + +**Parameters**: + +* BSTR **member** +* BSTR **propertyName** + +**Return type**: BSTR + + +### Function setMemberProperty + +![][public] + +``` +void ModelCenter::IObjectVariable::setMemberProperty(BSTR member, BSTR propertyName, BSTR propertyValue) +``` + + + +Set value of a property of the member. + + + + + + +**Parameters**: + +* **member**: Name of the member. +* **propertyName**: Name of the property. +* **propertyValue**: Value of the property. + + + +**Parameters**: + +* BSTR **member** +* BSTR **propertyName** +* BSTR **propertyValue** + +**Return type**: void + + +### Function getMemberList + +![][public] + +``` +VARIANT ModelCenter::IObjectVariable::getMemberList(BSTR member) +``` + + + +Get a list of child members. + + + + + + +**Parameters**: + +* **member**: Name of the member. + + +**Returns**: + +The list of child members. + + + +**Parameters**: + +* BSTR **member** + +**Return type**: VARIANT + + +### Function getMethodList + +![][public] + +``` +VARIANT ModelCenter::IObjectVariable::getMethodList() +``` + + + +Get a list of methods. + + + + + + +**Returns**: + +The list of methods. + + + +**Return type**: VARIANT + + +### Function toFile + +![][public] + +``` +void ModelCenter::IObjectVariable::toFile(BSTR member, BSTR fileName, VARIANT encoding) +``` + + + +Write a file member to a file. + + + + + + +**Parameters**: + +* **member**: Name of the member +* **fileName**: Destination file name. +* **encoding**: File encoding to be used (e.g., utf8, binary, ascii). ascii is assumed if empty. + + + +**Parameters**: + +* BSTR **member** +* BSTR **fileName** +* VARIANT **encoding** + +**Return type**: void + + +### Function fromFile + +![][public] + +``` +void ModelCenter::IObjectVariable::fromFile(BSTR member, BSTR fileName) +``` + + + +Load a file into a file member. + + + + + + +**Parameters**: + +* **member**: Name of the member. +* **fileName**: Source file name. + + + +**Parameters**: + +* BSTR **member** +* BSTR **fileName** + +**Return type**: void + + +### Function toFileAbsolute + +![][public] + +``` +void ModelCenter::IObjectVariable::toFileAbsolute(BSTR member, BSTR fileName, VARIANT encoding) +``` + + + +Write a file member to a file without validating the variable. + + + + + + +**Parameters**: + +* **member**: Name of the member +* **fileName**: Destination file name. +* **encoding**: File encoding to be used (e.g., utf8, binary, ascii). ascii is assumed if empty. + + + +**Parameters**: + +* BSTR **member** +* BSTR **fileName** +* VARIANT **encoding** + +**Return type**: void + + +### Function getIsBinary + +![][public] + +``` +boolean ModelCenter::IObjectVariable::getIsBinary(BSTR member) +``` + + + +Gets the user set binary property of the file. File variables are either binary or ASCII. + + + + + + +**Parameters**: + +* **member**: Name of the member. + + +**Returns**: + +True if the binary property of the file is true, else false. + + + +**Parameters**: + +* BSTR **member** + +**Return type**: boolean + + +### Function setIsBinary + +![][public] + +``` +void ModelCenter::IObjectVariable::setIsBinary(BSTR member, boolean isBinary) +``` + + + +Sets the binary property of the file object. File variables are either binary or ASCII. + + + + + + +**Parameters**: + +* **member**: Name of the member. +* **isBinary**: Value for the binary property. + + + +**Parameters**: + +* BSTR **member** +* boolean **isBinary** + +**Return type**: void + + +### Function getFileName + +![][public] + +``` +BSTR ModelCenter::IObjectVariable::getFileName(BSTR member) +``` + + + +Get the file name of a file member. + + + + + + +**Parameters**: + +* **member**: Name of the member. + + +**Returns**: + +The name of the file. + + + +**Parameters**: + +* BSTR **member** + +**Return type**: BSTR + + +### Function setFileName + +![][public] + +``` +void ModelCenter::IObjectVariable::setFileName(BSTR member, BSTR fileName) +``` + + + +Sets the file name of the file object. Also sets the file extension if given in the name. + + + + + + +**Parameters**: + +* **member**: Name of the member. +* **fileName**: The name of the file. + + + +**Parameters**: + +* BSTR **member** +* BSTR **fileName** + +**Return type**: void + + +### Function getFileExtension + +![][public] + +``` +BSTR ModelCenter::IObjectVariable::getFileExtension(BSTR member) +``` + + + +Gets the file extension of an object file, which may be empty. + + + + + + +**Parameters**: + +* **member**: Name of the member. + + +**Returns**: + +The file extension, or empty string if no extension exists. + + + +**Parameters**: + +* BSTR **member** + +**Return type**: BSTR + + +### Function setFileExtension + +![][public] + +``` +void ModelCenter::IObjectVariable::setFileExtension(BSTR member, BSTR fileExtension) +``` + + + +Sets the file extension of the object file. The method adds the preceding '.' if excluded. + + + + + + +**Parameters**: + +* **member**: Name of the member. +* **fileExtension**: The value of the new file extension. + + + +**Parameters**: + +* BSTR **member** +* BSTR **fileExtension** + +**Return type**: void + + +### Function getArrayMemberValueAbsolute + +![][public] + +``` +VARIANT ModelCenter::IObjectVariable::getArrayMemberValueAbsolute(BSTR member, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Get value of array member without validating the variable. + + + + + + +**Parameters**: + +* **member**: Member name. +* **d1**: index in the 1st dimension (0-based index) +* **d2**: index in the 2nd dimension (0-based index) +* **d3**: index in the 3rd dimension (0-based index) +* **d4**: index in the 4th dimension (0-based index) +* **d5**: index in the 5th dimension (0-based index) +* **d6**: index in the 6th dimension (0-based index) +* **d7**: index in the 7th dimension (0-based index) +* **d8**: index in the 8th dimension (0-based index) +* **d9**: index in the 9th dimension (0-based index) +* **d10**: index in the 10th dimension (0-based index) + + +**Returns**: + +Value of the array element. + + + +**Parameters**: + +* BSTR **member** +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: VARIANT + + +### Function getArrayMemberValue + +![][public] + +``` +VARIANT ModelCenter::IObjectVariable::getArrayMemberValue(BSTR member, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Get value of array member. + + + + + + +**Parameters**: + +* **member**: Member name. +* **d1**: index in the 1st dimension (0-based index) +* **d2**: index in the 2nd dimension (0-based index) +* **d3**: index in the 3rd dimension (0-based index) +* **d4**: index in the 4th dimension (0-based index) +* **d5**: index in the 5th dimension (0-based index) +* **d6**: index in the 6th dimension (0-based index) +* **d7**: index in the 7th dimension (0-based index) +* **d8**: index in the 8th dimension (0-based index) +* **d9**: index in the 9th dimension (0-based index) +* **d10**: index in the 10th dimension (0-based index) + + +**Returns**: + +Value of the array element. + + + +**Parameters**: + +* BSTR **member** +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: VARIANT + + +### Function setArrayMemberValue + +![][public] + +``` +void ModelCenter::IObjectVariable::setArrayMemberValue(BSTR member, BSTR value, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Set value of an array member. + + + + + + +**Parameters**: + +* **member**: Name of the member. +* **value**: Value to be set. +* **d1**: index in the 1st dimension (0-based index) +* **d2**: index in the 2nd dimension (0-based index) +* **d3**: index in the 3rd dimension (0-based index) +* **d4**: index in the 4th dimension (0-based index) +* **d5**: index in the 5th dimension (0-based index) +* **d6**: index in the 6th dimension (0-based index) +* **d7**: index in the 7th dimension (0-based index) +* **d8**: index in the 8th dimension (0-based index) +* **d9**: index in the 9th dimension (0-based index) +* **d10**: index in the 10th dimension (0-based index) + + + +**Parameters**: + +* BSTR **member** +* BSTR **value** +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: void + + +### Function getArrayMemberAbsolute + +![][public] + +``` +VARIANT ModelCenter::IObjectVariable::getArrayMemberAbsolute(BSTR member) +``` + + + +Get values of an array member as a variant of safe array without validating the variable. + + + + + + +**Parameters**: + +* **member**: Member name. + + +**Returns**: + +Array values (variant of safe array). + + + +**Parameters**: + +* BSTR **member** + +**Return type**: VARIANT + + +### Function getArrayMember + +![][public] + +``` +VARIANT ModelCenter::IObjectVariable::getArrayMember(BSTR member) +``` + + + +Get values of an array member as a variant of safe array. + + + + + + +**Parameters**: + +* **member**: Member name. + + +**Returns**: + +Array values (variant of safe array). + + + +**Parameters**: + +* BSTR **member** + +**Return type**: VARIANT + + +### Function setArrayMember + +![][public] + +``` +void ModelCenter::IObjectVariable::setArrayMember(BSTR member, VARIANT array) +``` + + + +Set values of an array member from a safe array. Create an array member if the member does not exist or is a different type. + + + + + + +**Parameters**: + +* **member**: Member name. +* **array**: Values to be set (Variant of a safe array). + + + +**Parameters**: + +* BSTR **member** +* VARIANT **array** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IPHXFormat.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IPHXFormat.md index e30cba51d8..fc2e164db1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IPHXFormat.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IPHXFormat.md @@ -1,340 +1,339 @@ - -# Interface ModelCenter::IPHXFormat - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6131) - - - -Allows you to do custom formatting the same way ModelCenter does. - - - - - -Example: ``` -Dim formatter -Set formatter=app.getFormatter("# ?/2") -MsgBox formatter.doubleToString(12.5) -``` - -## Members - -* [doubleToEditableString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a596665cb30835ccad7c6df17afffd8bd) -* [doubleToString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1afdb6c65e615c3d5176129b51a1d44318) -* [getFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a6c3566f301404af75e38676198a8bf1e) -* [longToEditableString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a2d5f201c8a8166ffeca606bac90d4b3d) -* [longToString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a175332e4916d1d86855b1b707831e308) -* [setFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1aa34d6054f4542a34efb60a961ad78519) -* [stringToDouble](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a2576f20eaa4ec6133a734ea09d86130a) -* [stringToLong](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a9e0774cef531d24731ac6c320cfd837c) -* [stringToString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1ac1b65cffaf6712d53e58935e3c1592c9) - -## Public functions - - -### Function setFormat - -![][public] - -``` -void ModelCenter::IPHXFormat::setFormat(BSTR format) -``` - - - -Sets the format string to use in this object. Formats accepted are a sub-set of available formats from Excel. The easiest way to generate these is to load up ModelCenter and select "Format Variable" on some variable. The dialog will allow you to graphically choose a format and then will show you the correct format string to use in the lower left corner. You may pass in the empty string to mean "General". - - - - - - -**Parameters**: - -* **format**: The format string to use. - - - -**Parameters**: - -* BSTR **format** - -**Return type**: void - - -### Function stringToLong - -![][public] - -``` -long ModelCenter::IPHXFormat::stringToLong(BSTR str) -``` - - - -Takes a formatted string and converts it to a long (integer). The string must be in the correct format for style being used. - - - - - - -**Parameters**: - -* **str**: The formatted string. - - -**Returns**: - -The value of the string. - - - -**Parameters**: - -* BSTR **str** - -**Return type**: long - - -### Function stringToDouble - -![][public] - -``` -double ModelCenter::IPHXFormat::stringToDouble(BSTR str) -``` - - - -Takes a formatted string and converts it to a double (real number). The string must be in the correct format for the style being used. For example, if percentage is being used, "1%" will convert to 0.01. - - - - - - -**Parameters**: - -* **str**: The formatted string. - - -**Returns**: - -The value of the string. - - - -**Parameters**: - -* BSTR **str** - -**Return type**: double - - -### Function longToString - -![][public] - -``` -BSTR ModelCenter::IPHXFormat::longToString(long val) -``` - - - -Takes a long (integer) and converts it to a formatted string. - - - - - - -**Parameters**: - -* **val**: The long number to format. - - -**Returns**: - -The formatted string. - - - -**Parameters**: - -* long **val** - -**Return type**: BSTR - - -### Function doubleToString - -![][public] - -``` -BSTR ModelCenter::IPHXFormat::doubleToString(double val) -``` - - - -Takes a double (real number) and converts it to a formatted string. - - - - - - -**Parameters**: - -* **val**: The double number to format. - - -**Returns**: - -The formatted string. - - - -**Parameters**: - -* double **val** - -**Return type**: BSTR - - -### Function getFormat - -![][public] - -``` -BSTR ModelCenter::IPHXFormat::getFormat() -``` - - - -Returns the current format style being used in this object. - - - - - - -**Returns**: - -
- - - -**Return type**: BSTR - - -### Function stringToString - -![][public] - -``` -BSTR ModelCenter::IPHXFormat::stringToString(BSTR str) -``` - - - -Converts an unformatted string into a formatted string. - - - - - - -**Parameters**: - -* **str**: The unformatted string. - - -**Returns**: - -The formatted string. - - - -**Parameters**: - -* BSTR **str** - -**Return type**: BSTR - - -### Function longToEditableString - -![][public] - -``` -BSTR ModelCenter::IPHXFormat::longToEditableString(long val) -``` - - - -Converts a long to its formatted string representation but with full precision for editing. - - - - - - -**Parameters**: - -* **val**: The long number to format. - - -**Returns**: - -The formatted string. - - - -**Parameters**: - -* long **val** - -**Return type**: BSTR - - -### Function doubleToEditableString - -![][public] - -``` -BSTR ModelCenter::IPHXFormat::doubleToEditableString(double val) -``` - - - -Converts a double to its formatted string representation but with full precision for editing. - - - - - - -**Parameters**: - -* **val**: The double number to format. - - -**Returns**: - -The formatted string. - - - -**Parameters**: - -* double **val** - -**Return type**: BSTR - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IPHXFormat + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6131) + + + +Allows you to do custom formatting the same way ModelCenter does. + + + + + +Example: ``` +Dim formatter +Set formatter=app.getFormatter("# ?/2") +MsgBox formatter.doubleToString(12.5) +``` + +## Members + +* [doubleToEditableString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a596665cb30835ccad7c6df17afffd8bd) +* [doubleToString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1afdb6c65e615c3d5176129b51a1d44318) +* [getFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a6c3566f301404af75e38676198a8bf1e) +* [longToEditableString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a2d5f201c8a8166ffeca606bac90d4b3d) +* [longToString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a175332e4916d1d86855b1b707831e308) +* [setFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1aa34d6054f4542a34efb60a961ad78519) +* [stringToDouble](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a2576f20eaa4ec6133a734ea09d86130a) +* [stringToLong](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1a9e0774cef531d24731ac6c320cfd837c) +* [stringToString](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat_1ac1b65cffaf6712d53e58935e3c1592c9) + +## Public functions + + +### Function setFormat + +![][public] + +``` +void ModelCenter::IPHXFormat::setFormat(BSTR format) +``` + + + +Sets the format string to use in this object. Formats accepted are a sub-set of available formats from Excel. The easiest way to generate these is to load up ModelCenter and select "Format Variable" on some variable. The dialog will allow you to graphically choose a format and then will show you the correct format string to use in the lower left corner. You may pass in the empty string to mean "General". + + + + + + +**Parameters**: + +* **format**: The format string to use. + + + +**Parameters**: + +* BSTR **format** + +**Return type**: void + + +### Function stringToLong + +![][public] + +``` +long ModelCenter::IPHXFormat::stringToLong(BSTR str) +``` + + + +Takes a formatted string and converts it to a long (integer). The string must be in the correct format for style being used. + + + + + + +**Parameters**: + +* **str**: The formatted string. + + +**Returns**: + +The value of the string. + + + +**Parameters**: + +* BSTR **str** + +**Return type**: long + + +### Function stringToDouble + +![][public] + +``` +double ModelCenter::IPHXFormat::stringToDouble(BSTR str) +``` + + + +Takes a formatted string and converts it to a double (real number). The string must be in the correct format for the style being used. For example, if percentage is being used, "1%" will convert to 0.01. + + + + + + +**Parameters**: + +* **str**: The formatted string. + + +**Returns**: + +The value of the string. + + + +**Parameters**: + +* BSTR **str** + +**Return type**: double + + +### Function longToString + +![][public] + +``` +BSTR ModelCenter::IPHXFormat::longToString(long val) +``` + + + +Takes a long (integer) and converts it to a formatted string. + + + + + + +**Parameters**: + +* **val**: The long number to format. + + +**Returns**: + +The formatted string. + + + +**Parameters**: + +* long **val** + +**Return type**: BSTR + + +### Function doubleToString + +![][public] + +``` +BSTR ModelCenter::IPHXFormat::doubleToString(double val) +``` + + + +Takes a double (real number) and converts it to a formatted string. + + + + + + +**Parameters**: + +* **val**: The double number to format. + + +**Returns**: + +The formatted string. + + + +**Parameters**: + +* double **val** + +**Return type**: BSTR + + +### Function getFormat + +![][public] + +``` +BSTR ModelCenter::IPHXFormat::getFormat() +``` + + + +Returns the current format style being used in this object. + + + + + + +**Returns**: + +
+ + + +**Return type**: BSTR + + +### Function stringToString + +![][public] + +``` +BSTR ModelCenter::IPHXFormat::stringToString(BSTR str) +``` + + + +Converts an unformatted string into a formatted string. + + + + + + +**Parameters**: + +* **str**: The unformatted string. + + +**Returns**: + +The formatted string. + + + +**Parameters**: + +* BSTR **str** + +**Return type**: BSTR + + +### Function longToEditableString + +![][public] + +``` +BSTR ModelCenter::IPHXFormat::longToEditableString(long val) +``` + + + +Converts a long to its formatted string representation but with full precision for editing. + + + + + + +**Parameters**: + +* **val**: The long number to format. + + +**Returns**: + +The formatted string. + + + +**Parameters**: + +* long **val** + +**Return type**: BSTR + + +### Function doubleToEditableString + +![][public] + +``` +BSTR ModelCenter::IPHXFormat::doubleToEditableString(double val) +``` + + + +Converts a double to its formatted string representation but with full precision for editing. + + + + + + +**Parameters**: + +* **val**: The double number to format. + + +**Returns**: + +The formatted string. + + + +**Parameters**: + +* double **val** + +**Return type**: BSTR + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IRefArrayProp.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IRefArrayProp.md index 3d2ea117df..9006c10f86 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IRefArrayProp.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IRefArrayProp.md @@ -1,156 +1,155 @@ - -# Interface ModelCenter::IRefArrayProp - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5103) - - - -COM Instance. - -## Members - -* [description](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a0b98819f11c5c2e7c916a4e629199d48) -* [enumValues](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a2b488ae83e3f61e8f0924b781b0fac1a) -* [getName](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a625e640f8adae51bd6f65a88c7f67299) -* [getType](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a60190ee41cfbc6624a138dba5c790d00) -* [isInput](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a6a71677c0367f53bb39861474c8ce11e) -* [title](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1aaa7d8507dbf83d2cad6eea2266fa98fb) - -## Properties - - -### Property enumValues - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IRefArrayProp::enumValues -``` - - - -Enumerated values of the reference array property. - - - -**Return type**: BSTR - - -### Property isInput - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IRefArrayProp::isInput -``` - - - -Enumerated values of the reference array property. - - - -**Return type**: boolean - - -### Property title - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IRefArrayProp::title -``` - - - -Title of the reference array property. - - - -**Return type**: BSTR - - -### Property description - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IRefArrayProp::description -``` - - - -Description of the reference array property. - - - -**Return type**: BSTR - -## Public functions - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IRefArrayProp::getName() -``` - - - -Name of the reference array property. - - - - - - -**Returns**: - -The name of the reference array property. - - - -**Return type**: BSTR - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IRefArrayProp::getType() -``` - - - -Type of the reference array property. - - - - - - -**Returns**: - -The type of the reference array property. - - - -**Return type**: BSTR - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IRefArrayProp + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5103) + + + +COM Instance. + +## Members + +* [description](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a0b98819f11c5c2e7c916a4e629199d48) +* [enumValues](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a2b488ae83e3f61e8f0924b781b0fac1a) +* [getName](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a625e640f8adae51bd6f65a88c7f67299) +* [getType](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a60190ee41cfbc6624a138dba5c790d00) +* [isInput](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1a6a71677c0367f53bb39861474c8ce11e) +* [title](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp_1aaa7d8507dbf83d2cad6eea2266fa98fb) + +## Properties + + +### Property enumValues + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IRefArrayProp::enumValues +``` + + + +Enumerated values of the reference array property. + + + +**Return type**: BSTR + + +### Property isInput + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IRefArrayProp::isInput +``` + + + +Enumerated values of the reference array property. + + + +**Return type**: boolean + + +### Property title + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IRefArrayProp::title +``` + + + +Title of the reference array property. + + + +**Return type**: BSTR + + +### Property description + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IRefArrayProp::description +``` + + + +Description of the reference array property. + + + +**Return type**: BSTR + +## Public functions + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IRefArrayProp::getName() +``` + + + +Name of the reference array property. + + + + + + +**Returns**: + +The name of the reference array property. + + + +**Return type**: BSTR + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IRefArrayProp::getType() +``` + + + +Type of the reference array property. + + + + + + +**Returns**: + +The type of the reference array property. + + + +**Return type**: BSTR + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IRefProp.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IRefProp.md index e29a06e3ab..1978acd4b7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IRefProp.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IRefProp.md @@ -1,144 +1,143 @@ - -# Interface ModelCenter::IRefProp - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5442) - - - -COM Instance. - -## Members - -* [description](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1ade4ceb94fec2ee5eab541cce187b1eb3) -* [enumValues](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1a11d289581d9118de3f3a86d7d643fb85) -* [getName](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1a2b2ac899757c8dbd31a9c38b6d08f2c2) -* [getType](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1aa05642b60b5a5e44e9954c130d4686e1) -* [isInput](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1a0a8ec20895618292855526596a534f06) -* [title](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1ad9f9fdbe48e40c42f7d80eb57b072ae7) - -## Properties - - -### Property enumValues - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IRefProp::enumValues -``` - - - -Enumerated values of the reference property. - - - -**Return type**: BSTR - - -### Property isInput - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IRefProp::isInput -``` - - - -Whether or not the reference property is an input. - - - -**Return type**: boolean - - -### Property title - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IRefProp::title -``` - - - -Title of the reference property. - - - -**Return type**: BSTR - - -### Property description - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IRefProp::description -``` - - - -Description of the reference property. - - - -**Return type**: BSTR - -## Public functions - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IRefProp::getName() -``` - - - -Name of the reference property. -**Returns**: - -The name of the reference property. - - - -**Return type**: BSTR - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IRefProp::getType() -``` - - - -Type of the reference property. -**Returns**: - -The type of the reference property. - - - -**Return type**: BSTR - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IRefProp + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5442) + + + +COM Instance. + +## Members + +* [description](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1ade4ceb94fec2ee5eab541cce187b1eb3) +* [enumValues](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1a11d289581d9118de3f3a86d7d643fb85) +* [getName](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1a2b2ac899757c8dbd31a9c38b6d08f2c2) +* [getType](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1aa05642b60b5a5e44e9954c130d4686e1) +* [isInput](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1a0a8ec20895618292855526596a534f06) +* [title](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp_1ad9f9fdbe48e40c42f7d80eb57b072ae7) + +## Properties + + +### Property enumValues + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IRefProp::enumValues +``` + + + +Enumerated values of the reference property. + + + +**Return type**: BSTR + + +### Property isInput + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IRefProp::isInput +``` + + + +Whether or not the reference property is an input. + + + +**Return type**: boolean + + +### Property title + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IRefProp::title +``` + + + +Title of the reference property. + + + +**Return type**: BSTR + + +### Property description + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IRefProp::description +``` + + + +Description of the reference property. + + + +**Return type**: BSTR + +## Public functions + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IRefProp::getName() +``` + + + +Name of the reference property. +**Returns**: + +The name of the reference property. + + + +**Return type**: BSTR + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IRefProp::getType() +``` + + + +Type of the reference property. +**Returns**: + +The type of the reference property. + + + +**Return type**: BSTR + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IReferenceArray.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IReferenceArray.md index 0cbdc41e5c..ba42c45407 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IReferenceArray.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IReferenceArray.md @@ -1,1496 +1,1495 @@ - -# Interface ModelCenter::IReferenceArray - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5149) - - - -COM Instance. - -**Inherits from**: - -* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) - -## Members - -* [autoGrow](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a74f194b29d46aacb12b7d4c445df729b) -* [autoSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aca63a47369d69cbbf53532286b64a611) -* [createRefProp](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9e2914c70c8c77002c0dbc502cdfa056) -* [dependentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1add9bd8c41cd4a5c77f7e762768b441a5) -* [dependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a7a3b136537fb09914b87b5997b937df0) -* [directDependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a862a4306dbf867e3db316d9547cea277) -* [directPrecedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aa8041fca418266f2bee129804654abab) -* [fromString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9cb9dab871b4e86ed66fb53cc5473ebd) -* [fromStringEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2a286a07b606f7e90ac4e1d281a49d38) -* [getDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a83abe70ccf5e8a0a582748d84e3d7956) -* [getFullName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a44ebe17869a3b1b95568ea46299a9f3f) -* [getLength](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad88eff947daa184ab953839666729ae5) -* [getMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac6becc1bb1c5206e972c266164f838ca) -* [getName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a282d98574e8d65d85c9908b6799321b7) -* [getRefPropValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aecab78945a16a827081638609b48318d) -* [getRefPropValueAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a76d1cee0ac71a9682e7ff9af6df9cf77) -* [getSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a3d171136e0b219dd4e2d0d1b4bb9aa1f) -* [getType](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac3c3f33a239fe1182da434d7570346df) -* [getValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a32db352eed1650697f8b164546ea3eeb) -* [getValueAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9233b22b8ad38b1abf30bc68d543d789) -* [hasChanged](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a32bab88b29119d84a6429364fd651411) -* [hide](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a35c7c4ee97058e1636c56d4863c58e00) -* [invalidate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a56ea1d83eb42dda4a7c06b6fbbf6ffd5) -* [isInput](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ae7e5c76cfd592a71fc7e5785c7cf6394) -* [isInputToComponent](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a317b7b47fa55798e212c426b4ac8f014) -* [isInputToModel](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2d16dbc50ee0f77d5ca99b8a600e5023) -* [isValid](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a366cf132edcae4c78ff3c3c29d81ad03) -* [length](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af118bdf4b120050d6700a7ceae7f5bec) -* [numDimensions](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a05a8f727001f8d1794bc33960736fd18) -* [OwningComponent](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a4b37dc07f0e626f6b833b772d57b06a3) -* [precedentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a084d49d02b9ff5812166721fcdc86018) -* [precedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aea1973c58e45bafe3aeea797b91a4f6b) -* [reference](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a60216339479fb364f7e97cb5d9ea0b66) -* [reference](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1acd5c00c533970d30757f90445ec376cd) -* [referencedVariable](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1abb922c879568308b8c074165d596777e) -* [referencedVariables](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad2c0541925f15b29800a9e924916615a) -* [setDimensions](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a3526172d364bb842ab3bc25f1cedf31b) -* [setLength](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2cfaecd2a821841d414f0d9ac505659f) -* [setMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a31e14e94dd9316f40bf963a9da9939f7) -* [setRefPropValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a93e2bd4cf0f592ca8ec2a626fbd57432) -* [setSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b7b41ca5463a86aecb2368d73464c0e) -* [setValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a8ef388f09dd24fd704b46a7446016951) -* [size](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a0ec169188c7e660a32e9a3bc6792d26f) -* [toString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aaa37debc6216a5419715e0c542555850) -* [toStringAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a1a0ecbbccb3fe3404c79976e9f07b8db) -* [toStringAbsoluteEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aac2b33985ad310362db7c8c878096ae8) -* [toStringEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1af2ff697565c81552d49c0237cfc89ef7) -* [validate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1af1dd28c351fcda3e3fea31facbd4fca3) -* [value](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad9e0cf09c5c40b6272808d3ba83489ba) -* [value](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a902f599bd7fe0bed1c5f1f51a49e291e) - -## Properties - - -### Property hasChanged - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IReferenceArray::hasChanged -``` - - - - - - - -**Return type**: boolean - - -### Property hide - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IReferenceArray::hide -``` - - - - - - - -**Return type**: boolean - - -### Property OwningComponent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IReferenceArray::OwningComponent -``` - - - - - - - -**Return type**: LPDISPATCH - - -### Property size - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IReferenceArray::size -``` - - - - - - - -**Return type**: long - - -### Property numDimensions - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IReferenceArray::numDimensions -``` - - - - - - - -**Return type**: long - - -### Property autoGrow - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IReferenceArray::autoGrow -``` - - - -Whether or not the reference array is set to automatically grow. - - - -**Return type**: boolean - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5224) - -``` -long ModelCenter::IReferenceArray::value -``` - - - -Value of an array element. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -
- - - -**Return type**: long - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5231) - -``` -double ModelCenter::IReferenceArray::value( long index)(long index) -``` - - - -Value of an array element. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). -* **newValue**:
- - - -**Return type**: double - - -### Property reference - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5239) - -``` -long ModelCenter::IReferenceArray::reference -``` - - - -Reference of an array element. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -
- - - -**Return type**: long - - -### Property reference - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5246) - -``` -BSTR ModelCenter::IReferenceArray::reference( long index)(long index) -``` - - - -Reference of an array element. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). -* **newValue**:
- - - -**Return type**: BSTR - - -### Property referencedVariables - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5307) - -``` -long ModelCenter::IReferenceArray::referencedVariables -``` - - - -Gets the reference variables of the index element of the array. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The references variables of the element. - - - -**Return type**: long - - -### Property referencedVariable - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5316) - -``` -long ModelCenter::IReferenceArray::referencedVariable -``` - - - -Gets the reference variable of the index element of the array. Convenience method for if the indexed variable only has one reference. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The reference variable of the index element. - - - -**Return type**: long - -## Public functions - - -### Function isValid - -![][public] - -``` -boolean ModelCenter::IReferenceArray::isValid() -``` - - - -Finds out whether or not the array is valid. - - - - - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Return type**: boolean - -**Reimplements**: [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) - - -### Function validate - -![][public] - -``` -void ModelCenter::IReferenceArray::validate() -``` - - - -Causes the array to validate itself. - - - -**Return type**: void - -**Reimplements**: [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IReferenceArray::getName() -``` - - - -Gets the name of the array. - - - - - - -**Returns**: - -The name of the array. - - - -**Return type**: BSTR - -**Reimplements**: [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IReferenceArray::getFullName() -``` - - - -Gets the full ModelCenter path of the array. - - - - - - -**Returns**: - -The full ModelCenter path of the array. - - - -**Return type**: BSTR - -**Reimplements**: [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IReferenceArray::getType() -``` - - - -Gets the type of the array. - - - - - - -**Returns**: - -The type of the array as a string. - - - -**Return type**: BSTR - -**Reimplements**: [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) - - -### Function isInput - -![][public] - -``` -boolean ModelCenter::IReferenceArray::isInput() -``` - - - -Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2d16dbc50ee0f77d5ca99b8a600e5023). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) - - -### Function toString - -![][public] - -``` -BSTR ModelCenter::IReferenceArray::toString() -``` - - - -Converts the array to a string, validating the array if necessary. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. - - - - - - -**Returns**: - -The converted string value of the array. - - - -**Return type**: BSTR - -**Reimplements**: [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) - - -### Function fromString - -![][public] - -``` -void ModelCenter::IReferenceArray::fromString(BSTR value) -``` - - - -Sets the value of the array from a specified string. For 1D arrays, the specification is of the form '1,2,3'.
-For nD arrays, the specification is of the form 'bounds[2,2,2] {1,2,3,4,5,6,7,8}'.
-String arrays may optionally have the elements quoted in the form 'bounds[2,3] {"a", "b,c", "d", "", "e", "f"}' - - - - - - -**Parameters**: - -* **value**: New value. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - -**Reimplements**: [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) - - -### Function toStringAbsolute - -![][public] - -``` -BSTR ModelCenter::IReferenceArray::toStringAbsolute() -``` - - - -Converts the array to a string. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. - - - - - - -**Returns**: - -The converted string value of the array. - - - -**Return type**: BSTR - -**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IReferenceArray::invalidate() -``` - - - -Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. - - - -**Return type**: void - -**Reimplements**: [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) - - -### Function directPrecedents - -![][public] - -``` -LPDISPATCH ModelCenter::IReferenceArray::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) - - -### Function directDependents - -![][public] - -``` -LPDISPATCH ModelCenter::IReferenceArray::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) - - -### Function precedentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IReferenceArray::precedentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) - - -### Function dependentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IReferenceArray::dependentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) - - -### Function precedents - -![][public] - -``` -LPDISPATCH ModelCenter::IReferenceArray::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) - - -### Function dependents - -![][public] - -``` -LPDISPATCH ModelCenter::IReferenceArray::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) - - -### Function isInputToComponent - -![][public] - -``` -boolean ModelCenter::IReferenceArray::isInputToComponent() -``` - - - -Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) - - -### Function isInputToModel - -![][public] - -``` -boolean ModelCenter::IReferenceArray::isInputToModel() -``` - - - -Checks whether or not the variable is an input. A linked input returns false (Output). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) - - -### Function setMetadata - -![][public] - -``` -void ModelCenter::IReferenceArray::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) -``` - - - -Sets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata specifier used to store the data. -* **type**:
-* **value**:
-* **access**:
-* **archive**:
- - - -**Parameters**: - -* BSTR **name** -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** -* VARIANT **value** -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** -* boolean **archive** - -**Return type**: void - -**Reimplements**: [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) - - -### Function getMetadata - -![][public] - -``` -VARIANT ModelCenter::IReferenceArray::getMetadata(BSTR name) -``` - - - -Gets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata key name. - - -**Returns**: - -Metadata value. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -**Reimplements**: [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) - - -### Function toStringEx - -![][public] - -``` -BSTR ModelCenter::IReferenceArray::toStringEx(long index) -``` - - - -Converts the value of an array element to a string, validating the array if necessary. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The value of the element as a string. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - -**Reimplements**: [toStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a37c622ae9f50579f714ce98c0379cd98) - - -### Function fromStringEx - -![][public] - -``` -void ModelCenter::IReferenceArray::fromStringEx(BSTR value, long index) -``` - - - -Sets the value of an array element from a specified string. - - - - - - -**Parameters**: - -* **value**: New value. -* **index**: Index of the array element (0-based index). - - - -**Parameters**: - -* BSTR **value** -* long **index** - -**Return type**: void - -**Reimplements**: [fromStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad23f4082662c464be07251d6d1695a2d) - - -### Function toStringAbsoluteEx - -![][public] - -``` -BSTR ModelCenter::IReferenceArray::toStringAbsoluteEx(long index) -``` - - - -Converts the value of an array element to a string. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The value of the element as a string. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - -**Reimplements**: [toStringAbsoluteEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a2e3041440581aab716c684fe88d2ee87) - - -### Function getLength - -![][public] - -``` -long ModelCenter::IReferenceArray::getLength([optional] VARIANT dim) -``` - - - -Get the length of the n'th dimension of the array. - - - - - - -**Parameters**: - -* **dim**: Dimension of the array to query. This uses a 0 based index, so 0 will give you the first dimension, 1 the second, etc. If omitted, gives the first dimension - - -**Returns**: - -Length(size) of the array. - - - -**Parameters**: - -* _[optional]_ VARIANT **dim** - -**Return type**: long - -**Reimplements**: [getLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) - - -### Function setLength - -![][public] - -``` -void ModelCenter::IReferenceArray::setLength(long length, [optional] VARIANT dim) -``` - - - -Sets the length of the n'th dimension of the array - - - - - - -**Parameters**: - -* **length**: New length of the n'th dimension of the array -* **dim**: The dimension to set. This uses a 0 based index, so 0 will set the first dimension, 1 the second, etc. If omitted, sets the first dimension - - - -**Parameters**: - -* long **length** -* _[optional]_ VARIANT **dim** - -**Return type**: void - -**Reimplements**: [setLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) - - -### Function setDimensions - -![][public] - -``` -void ModelCenter::IReferenceArray::setDimensions(long d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Sets the number of dimensions of an array and the length of each dimension in one call. An array initializes to 0 length. If any dimension of the array has 0 length, the whole array contains no data. You must set the array size before filling in values unless you are using the setArray() call. - - - - - - -**Parameters**: - -* **d1**: length of the 1st dimension of the array -* **d2**: length of the 2nd dimension of the array. If omitted, the array is 1 dimensional -* **d3**: length of the 3rd dimension of the array. If omitted, the array is 2 dimensional -* **d4**: length of the 4th dimension of the array. If omitted, the array is 3 dimensional -* **d5**: length of the 5th dimension of the array. If omitted, the array is 4 dimensional -* **d6**: length of the 6th dimension of the array. If omitted, the array is 5 dimensional -* **d7**: length of the 7th dimension of the array. If omitted, the array is 6 dimensional -* **d8**: length of the 8th dimension of the array. If omitted, the array is 7 dimensional -* **d9**: length of the 9th dimension of the array. If omitted, the array is 8 dimensional -* **d10**: length of the 10th dimension of the array. If omitted, the array is 9 dimensional - - - -**Parameters**: - -* long **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: void - -**Reimplements**: [setDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) - - -### Function getValue - -![][public] - -``` -double ModelCenter::IReferenceArray::getValue(int index) -``` - - - -Gets the value of an array element. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The value. - - - -**Parameters**: - -* int **index** - -**Return type**: double - - -### Function setValue - -![][public] - -``` -double ModelCenter::IReferenceArray::setValue(double value, int index) -``` - - - -Sets the value of an array element. - - - - - - -**Parameters**: - -* **value**: New value. -* **index**: Index of the array element (0-based index). - - -**Returns**: - -
- - - -**Parameters**: - -* double **value** -* int **index** - -**Return type**: double - - -### Function createRefProp - -![][public] - -``` -IDispatch * ModelCenter::IReferenceArray::createRefProp(BSTR name, BSTR type) -``` - - - -Creates a reference property for the array. - - - - - - -**Parameters**: - -* **name**: Name of the reference property. -* **type**: Type of reference property to create.
- Allowed types are: double, long, boolean, and string. - - -**Returns**: - -IDispatch* to an [IRefArrayProp](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp) object. - - - -**Parameters**: - -* BSTR **name** -* BSTR **type** - -**Return type**: IDispatch * - - -### Function getRefPropValue - -![][public] - -``` -VARIANT ModelCenter::IReferenceArray::getRefPropValue(BSTR name, int index) -``` - - - -Gets the value of a specified reference property for an element in the array. - - - - - - -**Parameters**: - -* **name**: Name of the reference property. -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The value as a variant. - - - -**Parameters**: - -* BSTR **name** -* int **index** - -**Return type**: VARIANT - - -### Function setRefPropValue - -![][public] - -``` -void ModelCenter::IReferenceArray::setRefPropValue(BSTR name, int index, BSTR value) -``` - - - -Sets the value of a specified reference property for an element in the array. - - - - - - -**Parameters**: - -* **name**: Name of the reference property. -* **index**: Index of the array element (0-based index). -* **value**: New value. - - - -**Parameters**: - -* BSTR **name** -* int **index** -* BSTR **value** - -**Return type**: void - - -### Function getRefPropValueAbsolute - -![][public] - -``` -VARIANT ModelCenter::IReferenceArray::getRefPropValueAbsolute(BSTR name, int index) -``` - - - -Gets the value of a specified reference property for an element in the array without running to validate. - - - - - - -**Parameters**: - -* **name**: Name of the reference property. -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The value as a variant. - - - -**Parameters**: - -* BSTR **name** -* int **index** - -**Return type**: VARIANT - - -### Function getValueAbsolute - -![][public] - -``` -double ModelCenter::IReferenceArray::getValueAbsolute(int index) -``` - - - -gets the value of the variable at a specific location without validating. - - - - - - -**Parameters**: - -* **index**: The array element index (0-based index). - - -**Returns**: - -The reference value. - - - -**Parameters**: - -* int **index** - -**Return type**: double - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IReferenceArray + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5149) + + + +COM Instance. + +**Inherits from**: + +* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) + +## Members + +* [autoGrow](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a74f194b29d46aacb12b7d4c445df729b) +* [autoSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aca63a47369d69cbbf53532286b64a611) +* [createRefProp](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9e2914c70c8c77002c0dbc502cdfa056) +* [dependentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1add9bd8c41cd4a5c77f7e762768b441a5) +* [dependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a7a3b136537fb09914b87b5997b937df0) +* [directDependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a862a4306dbf867e3db316d9547cea277) +* [directPrecedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aa8041fca418266f2bee129804654abab) +* [fromString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9cb9dab871b4e86ed66fb53cc5473ebd) +* [fromStringEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2a286a07b606f7e90ac4e1d281a49d38) +* [getDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a83abe70ccf5e8a0a582748d84e3d7956) +* [getFullName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a44ebe17869a3b1b95568ea46299a9f3f) +* [getLength](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad88eff947daa184ab953839666729ae5) +* [getMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac6becc1bb1c5206e972c266164f838ca) +* [getName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a282d98574e8d65d85c9908b6799321b7) +* [getRefPropValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aecab78945a16a827081638609b48318d) +* [getRefPropValueAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a76d1cee0ac71a9682e7ff9af6df9cf77) +* [getSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a3d171136e0b219dd4e2d0d1b4bb9aa1f) +* [getType](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac3c3f33a239fe1182da434d7570346df) +* [getValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a32db352eed1650697f8b164546ea3eeb) +* [getValueAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9233b22b8ad38b1abf30bc68d543d789) +* [hasChanged](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a32bab88b29119d84a6429364fd651411) +* [hide](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a35c7c4ee97058e1636c56d4863c58e00) +* [invalidate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a56ea1d83eb42dda4a7c06b6fbbf6ffd5) +* [isInput](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ae7e5c76cfd592a71fc7e5785c7cf6394) +* [isInputToComponent](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a317b7b47fa55798e212c426b4ac8f014) +* [isInputToModel](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2d16dbc50ee0f77d5ca99b8a600e5023) +* [isValid](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a366cf132edcae4c78ff3c3c29d81ad03) +* [length](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af118bdf4b120050d6700a7ceae7f5bec) +* [numDimensions](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a05a8f727001f8d1794bc33960736fd18) +* [OwningComponent](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a4b37dc07f0e626f6b833b772d57b06a3) +* [precedentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a084d49d02b9ff5812166721fcdc86018) +* [precedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aea1973c58e45bafe3aeea797b91a4f6b) +* [reference](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a60216339479fb364f7e97cb5d9ea0b66) +* [reference](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1acd5c00c533970d30757f90445ec376cd) +* [referencedVariable](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1abb922c879568308b8c074165d596777e) +* [referencedVariables](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad2c0541925f15b29800a9e924916615a) +* [setDimensions](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a3526172d364bb842ab3bc25f1cedf31b) +* [setLength](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2cfaecd2a821841d414f0d9ac505659f) +* [setMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a31e14e94dd9316f40bf963a9da9939f7) +* [setRefPropValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a93e2bd4cf0f592ca8ec2a626fbd57432) +* [setSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b7b41ca5463a86aecb2368d73464c0e) +* [setValue](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a8ef388f09dd24fd704b46a7446016951) +* [size](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a0ec169188c7e660a32e9a3bc6792d26f) +* [toString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aaa37debc6216a5419715e0c542555850) +* [toStringAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a1a0ecbbccb3fe3404c79976e9f07b8db) +* [toStringAbsoluteEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aac2b33985ad310362db7c8c878096ae8) +* [toStringEx](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1af2ff697565c81552d49c0237cfc89ef7) +* [validate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1af1dd28c351fcda3e3fea31facbd4fca3) +* [value](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ad9e0cf09c5c40b6272808d3ba83489ba) +* [value](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a902f599bd7fe0bed1c5f1f51a49e291e) + +## Properties + + +### Property hasChanged + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IReferenceArray::hasChanged +``` + + + + + + + +**Return type**: boolean + + +### Property hide + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IReferenceArray::hide +``` + + + + + + + +**Return type**: boolean + + +### Property OwningComponent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IReferenceArray::OwningComponent +``` + + + + + + + +**Return type**: LPDISPATCH + + +### Property size + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IReferenceArray::size +``` + + + + + + + +**Return type**: long + + +### Property numDimensions + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IReferenceArray::numDimensions +``` + + + + + + + +**Return type**: long + + +### Property autoGrow + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IReferenceArray::autoGrow +``` + + + +Whether or not the reference array is set to automatically grow. + + + +**Return type**: boolean + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5224) + +``` +long ModelCenter::IReferenceArray::value +``` + + + +Value of an array element. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +
+ + + +**Return type**: long + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5231) + +``` +double ModelCenter::IReferenceArray::value( long index)(long index) +``` + + + +Value of an array element. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). +* **newValue**:
+ + + +**Return type**: double + + +### Property reference + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5239) + +``` +long ModelCenter::IReferenceArray::reference +``` + + + +Reference of an array element. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +
+ + + +**Return type**: long + + +### Property reference + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5246) + +``` +BSTR ModelCenter::IReferenceArray::reference( long index)(long index) +``` + + + +Reference of an array element. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). +* **newValue**:
+ + + +**Return type**: BSTR + + +### Property referencedVariables + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5307) + +``` +long ModelCenter::IReferenceArray::referencedVariables +``` + + + +Gets the reference variables of the index element of the array. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The references variables of the element. + + + +**Return type**: long + + +### Property referencedVariable + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5316) + +``` +long ModelCenter::IReferenceArray::referencedVariable +``` + + + +Gets the reference variable of the index element of the array. Convenience method for if the indexed variable only has one reference. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The reference variable of the index element. + + + +**Return type**: long + +## Public functions + + +### Function isValid + +![][public] + +``` +boolean ModelCenter::IReferenceArray::isValid() +``` + + + +Finds out whether or not the array is valid. + + + + + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Return type**: boolean + +**Reimplements**: [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) + + +### Function validate + +![][public] + +``` +void ModelCenter::IReferenceArray::validate() +``` + + + +Causes the array to validate itself. + + + +**Return type**: void + +**Reimplements**: [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IReferenceArray::getName() +``` + + + +Gets the name of the array. + + + + + + +**Returns**: + +The name of the array. + + + +**Return type**: BSTR + +**Reimplements**: [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IReferenceArray::getFullName() +``` + + + +Gets the full ModelCenter path of the array. + + + + + + +**Returns**: + +The full ModelCenter path of the array. + + + +**Return type**: BSTR + +**Reimplements**: [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IReferenceArray::getType() +``` + + + +Gets the type of the array. + + + + + + +**Returns**: + +The type of the array as a string. + + + +**Return type**: BSTR + +**Reimplements**: [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) + + +### Function isInput + +![][public] + +``` +boolean ModelCenter::IReferenceArray::isInput() +``` + + + +Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2d16dbc50ee0f77d5ca99b8a600e5023). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) + + +### Function toString + +![][public] + +``` +BSTR ModelCenter::IReferenceArray::toString() +``` + + + +Converts the array to a string, validating the array if necessary. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. + + + + + + +**Returns**: + +The converted string value of the array. + + + +**Return type**: BSTR + +**Reimplements**: [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) + + +### Function fromString + +![][public] + +``` +void ModelCenter::IReferenceArray::fromString(BSTR value) +``` + + + +Sets the value of the array from a specified string. For 1D arrays, the specification is of the form '1,2,3'.
+For nD arrays, the specification is of the form 'bounds[2,2,2] {1,2,3,4,5,6,7,8}'.
+String arrays may optionally have the elements quoted in the form 'bounds[2,3] {"a", "b,c", "d", "", "e", "f"}' + + + + + + +**Parameters**: + +* **value**: New value. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + +**Reimplements**: [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) + + +### Function toStringAbsolute + +![][public] + +``` +BSTR ModelCenter::IReferenceArray::toStringAbsolute() +``` + + + +Converts the array to a string. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. + + + + + + +**Returns**: + +The converted string value of the array. + + + +**Return type**: BSTR + +**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IReferenceArray::invalidate() +``` + + + +Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. + + + +**Return type**: void + +**Reimplements**: [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) + + +### Function directPrecedents + +![][public] + +``` +LPDISPATCH ModelCenter::IReferenceArray::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) + + +### Function directDependents + +![][public] + +``` +LPDISPATCH ModelCenter::IReferenceArray::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) + + +### Function precedentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IReferenceArray::precedentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) + + +### Function dependentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IReferenceArray::dependentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) + + +### Function precedents + +![][public] + +``` +LPDISPATCH ModelCenter::IReferenceArray::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) + + +### Function dependents + +![][public] + +``` +LPDISPATCH ModelCenter::IReferenceArray::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) + + +### Function isInputToComponent + +![][public] + +``` +boolean ModelCenter::IReferenceArray::isInputToComponent() +``` + + + +Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) + + +### Function isInputToModel + +![][public] + +``` +boolean ModelCenter::IReferenceArray::isInputToModel() +``` + + + +Checks whether or not the variable is an input. A linked input returns false (Output). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) + + +### Function setMetadata + +![][public] + +``` +void ModelCenter::IReferenceArray::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) +``` + + + +Sets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata specifier used to store the data. +* **type**:
+* **value**:
+* **access**:
+* **archive**:
+ + + +**Parameters**: + +* BSTR **name** +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** +* VARIANT **value** +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** +* boolean **archive** + +**Return type**: void + +**Reimplements**: [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) + + +### Function getMetadata + +![][public] + +``` +VARIANT ModelCenter::IReferenceArray::getMetadata(BSTR name) +``` + + + +Gets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata key name. + + +**Returns**: + +Metadata value. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +**Reimplements**: [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) + + +### Function toStringEx + +![][public] + +``` +BSTR ModelCenter::IReferenceArray::toStringEx(long index) +``` + + + +Converts the value of an array element to a string, validating the array if necessary. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The value of the element as a string. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + +**Reimplements**: [toStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a37c622ae9f50579f714ce98c0379cd98) + + +### Function fromStringEx + +![][public] + +``` +void ModelCenter::IReferenceArray::fromStringEx(BSTR value, long index) +``` + + + +Sets the value of an array element from a specified string. + + + + + + +**Parameters**: + +* **value**: New value. +* **index**: Index of the array element (0-based index). + + + +**Parameters**: + +* BSTR **value** +* long **index** + +**Return type**: void + +**Reimplements**: [fromStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad23f4082662c464be07251d6d1695a2d) + + +### Function toStringAbsoluteEx + +![][public] + +``` +BSTR ModelCenter::IReferenceArray::toStringAbsoluteEx(long index) +``` + + + +Converts the value of an array element to a string. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The value of the element as a string. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + +**Reimplements**: [toStringAbsoluteEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a2e3041440581aab716c684fe88d2ee87) + + +### Function getLength + +![][public] + +``` +long ModelCenter::IReferenceArray::getLength([optional] VARIANT dim) +``` + + + +Get the length of the n'th dimension of the array. + + + + + + +**Parameters**: + +* **dim**: Dimension of the array to query. This uses a 0 based index, so 0 will give you the first dimension, 1 the second, etc. If omitted, gives the first dimension + + +**Returns**: + +Length(size) of the array. + + + +**Parameters**: + +* _[optional]_ VARIANT **dim** + +**Return type**: long + +**Reimplements**: [getLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) + + +### Function setLength + +![][public] + +``` +void ModelCenter::IReferenceArray::setLength(long length, [optional] VARIANT dim) +``` + + + +Sets the length of the n'th dimension of the array + + + + + + +**Parameters**: + +* **length**: New length of the n'th dimension of the array +* **dim**: The dimension to set. This uses a 0 based index, so 0 will set the first dimension, 1 the second, etc. If omitted, sets the first dimension + + + +**Parameters**: + +* long **length** +* _[optional]_ VARIANT **dim** + +**Return type**: void + +**Reimplements**: [setLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) + + +### Function setDimensions + +![][public] + +``` +void ModelCenter::IReferenceArray::setDimensions(long d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Sets the number of dimensions of an array and the length of each dimension in one call. An array initializes to 0 length. If any dimension of the array has 0 length, the whole array contains no data. You must set the array size before filling in values unless you are using the setArray() call. + + + + + + +**Parameters**: + +* **d1**: length of the 1st dimension of the array +* **d2**: length of the 2nd dimension of the array. If omitted, the array is 1 dimensional +* **d3**: length of the 3rd dimension of the array. If omitted, the array is 2 dimensional +* **d4**: length of the 4th dimension of the array. If omitted, the array is 3 dimensional +* **d5**: length of the 5th dimension of the array. If omitted, the array is 4 dimensional +* **d6**: length of the 6th dimension of the array. If omitted, the array is 5 dimensional +* **d7**: length of the 7th dimension of the array. If omitted, the array is 6 dimensional +* **d8**: length of the 8th dimension of the array. If omitted, the array is 7 dimensional +* **d9**: length of the 9th dimension of the array. If omitted, the array is 8 dimensional +* **d10**: length of the 10th dimension of the array. If omitted, the array is 9 dimensional + + + +**Parameters**: + +* long **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: void + +**Reimplements**: [setDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) + + +### Function getValue + +![][public] + +``` +double ModelCenter::IReferenceArray::getValue(int index) +``` + + + +Gets the value of an array element. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The value. + + + +**Parameters**: + +* int **index** + +**Return type**: double + + +### Function setValue + +![][public] + +``` +double ModelCenter::IReferenceArray::setValue(double value, int index) +``` + + + +Sets the value of an array element. + + + + + + +**Parameters**: + +* **value**: New value. +* **index**: Index of the array element (0-based index). + + +**Returns**: + +
+ + + +**Parameters**: + +* double **value** +* int **index** + +**Return type**: double + + +### Function createRefProp + +![][public] + +``` +IDispatch * ModelCenter::IReferenceArray::createRefProp(BSTR name, BSTR type) +``` + + + +Creates a reference property for the array. + + + + + + +**Parameters**: + +* **name**: Name of the reference property. +* **type**: Type of reference property to create.
+ Allowed types are: double, long, boolean, and string. + + +**Returns**: + +IDispatch* to an [IRefArrayProp](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp) object. + + + +**Parameters**: + +* BSTR **name** +* BSTR **type** + +**Return type**: IDispatch * + + +### Function getRefPropValue + +![][public] + +``` +VARIANT ModelCenter::IReferenceArray::getRefPropValue(BSTR name, int index) +``` + + + +Gets the value of a specified reference property for an element in the array. + + + + + + +**Parameters**: + +* **name**: Name of the reference property. +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The value as a variant. + + + +**Parameters**: + +* BSTR **name** +* int **index** + +**Return type**: VARIANT + + +### Function setRefPropValue + +![][public] + +``` +void ModelCenter::IReferenceArray::setRefPropValue(BSTR name, int index, BSTR value) +``` + + + +Sets the value of a specified reference property for an element in the array. + + + + + + +**Parameters**: + +* **name**: Name of the reference property. +* **index**: Index of the array element (0-based index). +* **value**: New value. + + + +**Parameters**: + +* BSTR **name** +* int **index** +* BSTR **value** + +**Return type**: void + + +### Function getRefPropValueAbsolute + +![][public] + +``` +VARIANT ModelCenter::IReferenceArray::getRefPropValueAbsolute(BSTR name, int index) +``` + + + +Gets the value of a specified reference property for an element in the array without running to validate. + + + + + + +**Parameters**: + +* **name**: Name of the reference property. +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The value as a variant. + + + +**Parameters**: + +* BSTR **name** +* int **index** + +**Return type**: VARIANT + + +### Function getValueAbsolute + +![][public] + +``` +double ModelCenter::IReferenceArray::getValueAbsolute(int index) +``` + + + +gets the value of the variable at a specific location without validating. + + + + + + +**Parameters**: + +* **index**: The array element index (0-based index). + + +**Returns**: + +The reference value. + + + +**Parameters**: + +* int **index** + +**Return type**: double + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IReferenceVariable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IReferenceVariable.md index d16c207009..2b2aec32b8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IReferenceVariable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IReferenceVariable.md @@ -1,962 +1,961 @@ - -# Interface ModelCenter::IReferenceVariable - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5335) - - - -COM Instance. - -**Inherits from**: - -* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) - -## Members - -* [createRefProp](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0063ff442e879a9ca2986bc63eb9adc7) -* [dependentLinks](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a4c704741da375408b052eeddc6ed90dc) -* [dependents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aceffce4238d22a19c211658f675491ee) -* [directDependents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a24fa52bf29a92c4f1d6a79e2991e9ae5) -* [directPrecedents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0e11aede2642dd050f0c5254a36b4a71) -* [fromString](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa52a8fe2a76861302ee8ab0f8f3a614c) -* [getFullName](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3e427b90dbf2f763c2486cdd774c2d49) -* [getMetadata](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a122afef9ff20a0de02d08ab41eb4e5bb) -* [getName](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa01b77111d4a975cc12ca3e0a16d845b) -* [getRefPropValue](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ad90bbc18df836afc454157bd06523d75) -* [getRefPropValueAbsolute](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ae45fa34070d38d9de3593d815e86b1fc) -* [getType](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ab946d679180e3e65433c8b4b2d61d39e) -* [hasChanged](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0f4d80365facbc0cfea5745f131e9d10) -* [hide](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a598cb6023fcbcb265cc44618529c3040) -* [invalidate](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3a460ef81527173ce0c272d2bdf69da6) -* [isInput](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa61fe715fadff86e98c35d4bf6aa16e0) -* [isInputToComponent](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ac551ae6997c725cbb3ef71bd6217f89a) -* [isInputToModel](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ad8a6169868d4d186b658946403eae2ab) -* [isValid](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1adbc66e2276350867c0b977bf5cf192cf) -* [OwningComponent](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a853702bf341480c261b01988dfd15513) -* [precedentLinks](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ac4f846dce2494b7c4a9b8482af321c96) -* [precedents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ae2d07bb6bf73c064a1a492bb6ff2806a) -* [reference](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1abfacc6a5417c7fab810ac6e34a885657) -* [referencedVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3ae2ecb1742ecac66cec298a6d2cd011) -* [referencedVariables](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a21758071b908ac4fe720dffdafe75592) -* [setMetadata](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1afee8a9cb2ea3d6728cacba4aeaa9ff7a) -* [setRefPropValue](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1af41e2e8abdbc5959543416e21bc73793) -* [toString](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a6675d6a6451c20b11b43ad594af28bcc) -* [toStringAbsolute](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a510fd4577f2a29cf0fef6d1c8fe43c94) -* [validate](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a16aec4b64f98c5dfb3f66c497691e447) -* [value](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a2e307144f16d81645b5ce2cc30b01ae3) - -## Properties - - -### Property hasChanged - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IReferenceVariable::hasChanged -``` - - - - - - - -**Return type**: boolean - - -### Property hide - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IReferenceVariable::hide -``` - - - - - - - -**Return type**: boolean - - -### Property OwningComponent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IReferenceVariable::OwningComponent -``` - - - - - - - -**Return type**: LPDISPATCH - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -double ModelCenter::IReferenceVariable::value -``` - - - -Value of the variable. - - - -**Return type**: double - - -### Property reference - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IReferenceVariable::reference -``` - - - -Reference of the variable. - - - -**Return type**: BSTR - - -### Property referencedVariables - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IReferenceVariable::referencedVariables -``` - - - -Gets the referenced variables. - - - -**Return type**: VARIANT - - -### Property referencedVariable - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IReferenceVariable::referencedVariable -``` - - - -Gets the referenced variable. Convenience method for if there is only one reference. - - - -**Return type**: VARIANT - -## Public functions - - -### Function isValid - -![][public] - -``` -boolean ModelCenter::IReferenceVariable::isValid() -``` - - - -Returns whether or not the variable is valid. - - - - - - -**Returns**: - -True if variable is valid. False if the variable is not valid. - - - -**Return type**: boolean - -**Reimplements**: [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) - - -### Function validate - -![][public] - -``` -void ModelCenter::IReferenceVariable::validate() -``` - - - -Validates the variable by running the component if needed. - - - -**Return type**: void - -**Reimplements**: [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IReferenceVariable::getName() -``` - - - -Gets the name of the variable. - - - - - - -**Returns**: - -The name of the variable. - - - -**Return type**: BSTR - -**Reimplements**: [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IReferenceVariable::getFullName() -``` - - - -Gets the full ModelCenter path of the variable. - - - - - - -**Returns**: - -The full ModelCenter path of the variable. - - - -**Return type**: BSTR - -**Reimplements**: [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IReferenceVariable::getType() -``` - - - -Gets the type of the variable. - - - - - - -**Returns**: - -The type of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) - - -### Function isInput - -![][public] - -``` -boolean ModelCenter::IReferenceVariable::isInput() -``` - - - -Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ad8a6169868d4d186b658946403eae2ab). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) - - -### Function toString - -![][public] - -``` -BSTR ModelCenter::IReferenceVariable::toString() -``` - - - -Converts the variable value to a string, validating the variable if necessary. - - - - - - -**Returns**: - -The value of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) - - -### Function fromString - -![][public] - -``` -void ModelCenter::IReferenceVariable::fromString(BSTR value) -``` - - - -Sets the value of the variable from the specified string. - - - - - - -**Parameters**: - -* **value**: New value. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - -**Reimplements**: [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) - - -### Function toStringAbsolute - -![][public] - -``` -BSTR ModelCenter::IReferenceVariable::toStringAbsolute() -``` - - - -Converts the value of the variable to a string. - - - - - - -**Returns**: - -The value of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IReferenceVariable::invalidate() -``` - - - -Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. - - - -**Return type**: void - -**Reimplements**: [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) - - -### Function directPrecedents - -![][public] - -``` -LPDISPATCH ModelCenter::IReferenceVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) - - -### Function directDependents - -![][public] - -``` -LPDISPATCH ModelCenter::IReferenceVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) - - -### Function precedentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IReferenceVariable::precedentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) - - -### Function dependentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IReferenceVariable::dependentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) - - -### Function precedents - -![][public] - -``` -LPDISPATCH ModelCenter::IReferenceVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) - - -### Function dependents - -![][public] - -``` -LPDISPATCH ModelCenter::IReferenceVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) - - -### Function isInputToComponent - -![][public] - -``` -boolean ModelCenter::IReferenceVariable::isInputToComponent() -``` - - - -Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) - - -### Function isInputToModel - -![][public] - -``` -boolean ModelCenter::IReferenceVariable::isInputToModel() -``` - - - -Checks whether or not the variable is an input. A linked input returns false (Output). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) - - -### Function setMetadata - -![][public] - -``` -void ModelCenter::IReferenceVariable::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) -``` - - - -Sets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata specifier used to store the data. -* **type**:
-* **value**:
-* **access**:
-* **archive**:
- - - -**Parameters**: - -* BSTR **name** -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** -* VARIANT **value** -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** -* boolean **archive** - -**Return type**: void - -**Reimplements**: [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) - - -### Function getMetadata - -![][public] - -``` -VARIANT ModelCenter::IReferenceVariable::getMetadata(BSTR name) -``` - - - -Gets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata key name. - - -**Returns**: - -Metadata value. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -**Reimplements**: [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) - - -### Function createRefProp - -![][public] - -``` -IDispatch * ModelCenter::IReferenceVariable::createRefProp(BSTR name, BSTR type) -``` - - - -Creates a reference property for the variable. - - - - - - -**Parameters**: - -* **name**: Name of the reference property. -* **type**: Type of reference property to create.
- Allowed types are: double, long, boolean, and string. - - -**Returns**: - -IDispatch* to an [IRefProp](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp) object. - - - -**Parameters**: - -* BSTR **name** -* BSTR **type** - -**Return type**: IDispatch * - - -### Function getRefPropValue - -![][public] - -``` -VARIANT ModelCenter::IReferenceVariable::getRefPropValue(BSTR name) -``` - - - -Gets the value of a specified reference property for the variable. - - - - - - -**Parameters**: - -* **name**: Name of the reference property. - - -**Returns**: - -The value as a variant. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - - -### Function setRefPropValue - -![][public] - -``` -void ModelCenter::IReferenceVariable::setRefPropValue(BSTR name, BSTR value) -``` - - - -Sets the value of a specified reference property for the variable. - - - - - - -**Parameters**: - -* **name**: Name of the reference property. -* **value**: New value. - - - -**Parameters**: - -* BSTR **name** -* BSTR **value** - -**Return type**: void - - -### Function getRefPropValueAbsolute - -![][public] - -``` -VARIANT ModelCenter::IReferenceVariable::getRefPropValueAbsolute(BSTR name) -``` - - - -Gets the value of a specified reference property for the variable, without validating first. - - - - - - -**Parameters**: - -* **name**: Name of the reference property. - - -**Returns**: - -The value as a variant. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IReferenceVariable + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5335) + + + +COM Instance. + +**Inherits from**: + +* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) + +## Members + +* [createRefProp](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0063ff442e879a9ca2986bc63eb9adc7) +* [dependentLinks](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a4c704741da375408b052eeddc6ed90dc) +* [dependents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aceffce4238d22a19c211658f675491ee) +* [directDependents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a24fa52bf29a92c4f1d6a79e2991e9ae5) +* [directPrecedents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0e11aede2642dd050f0c5254a36b4a71) +* [fromString](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa52a8fe2a76861302ee8ab0f8f3a614c) +* [getFullName](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3e427b90dbf2f763c2486cdd774c2d49) +* [getMetadata](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a122afef9ff20a0de02d08ab41eb4e5bb) +* [getName](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa01b77111d4a975cc12ca3e0a16d845b) +* [getRefPropValue](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ad90bbc18df836afc454157bd06523d75) +* [getRefPropValueAbsolute](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ae45fa34070d38d9de3593d815e86b1fc) +* [getType](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ab946d679180e3e65433c8b4b2d61d39e) +* [hasChanged](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0f4d80365facbc0cfea5745f131e9d10) +* [hide](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a598cb6023fcbcb265cc44618529c3040) +* [invalidate](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3a460ef81527173ce0c272d2bdf69da6) +* [isInput](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa61fe715fadff86e98c35d4bf6aa16e0) +* [isInputToComponent](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ac551ae6997c725cbb3ef71bd6217f89a) +* [isInputToModel](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ad8a6169868d4d186b658946403eae2ab) +* [isValid](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1adbc66e2276350867c0b977bf5cf192cf) +* [OwningComponent](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a853702bf341480c261b01988dfd15513) +* [precedentLinks](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ac4f846dce2494b7c4a9b8482af321c96) +* [precedents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ae2d07bb6bf73c064a1a492bb6ff2806a) +* [reference](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1abfacc6a5417c7fab810ac6e34a885657) +* [referencedVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3ae2ecb1742ecac66cec298a6d2cd011) +* [referencedVariables](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a21758071b908ac4fe720dffdafe75592) +* [setMetadata](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1afee8a9cb2ea3d6728cacba4aeaa9ff7a) +* [setRefPropValue](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1af41e2e8abdbc5959543416e21bc73793) +* [toString](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a6675d6a6451c20b11b43ad594af28bcc) +* [toStringAbsolute](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a510fd4577f2a29cf0fef6d1c8fe43c94) +* [validate](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a16aec4b64f98c5dfb3f66c497691e447) +* [value](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a2e307144f16d81645b5ce2cc30b01ae3) + +## Properties + + +### Property hasChanged + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IReferenceVariable::hasChanged +``` + + + + + + + +**Return type**: boolean + + +### Property hide + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IReferenceVariable::hide +``` + + + + + + + +**Return type**: boolean + + +### Property OwningComponent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IReferenceVariable::OwningComponent +``` + + + + + + + +**Return type**: LPDISPATCH + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +double ModelCenter::IReferenceVariable::value +``` + + + +Value of the variable. + + + +**Return type**: double + + +### Property reference + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IReferenceVariable::reference +``` + + + +Reference of the variable. + + + +**Return type**: BSTR + + +### Property referencedVariables + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IReferenceVariable::referencedVariables +``` + + + +Gets the referenced variables. + + + +**Return type**: VARIANT + + +### Property referencedVariable + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IReferenceVariable::referencedVariable +``` + + + +Gets the referenced variable. Convenience method for if there is only one reference. + + + +**Return type**: VARIANT + +## Public functions + + +### Function isValid + +![][public] + +``` +boolean ModelCenter::IReferenceVariable::isValid() +``` + + + +Returns whether or not the variable is valid. + + + + + + +**Returns**: + +True if variable is valid. False if the variable is not valid. + + + +**Return type**: boolean + +**Reimplements**: [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) + + +### Function validate + +![][public] + +``` +void ModelCenter::IReferenceVariable::validate() +``` + + + +Validates the variable by running the component if needed. + + + +**Return type**: void + +**Reimplements**: [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IReferenceVariable::getName() +``` + + + +Gets the name of the variable. + + + + + + +**Returns**: + +The name of the variable. + + + +**Return type**: BSTR + +**Reimplements**: [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IReferenceVariable::getFullName() +``` + + + +Gets the full ModelCenter path of the variable. + + + + + + +**Returns**: + +The full ModelCenter path of the variable. + + + +**Return type**: BSTR + +**Reimplements**: [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IReferenceVariable::getType() +``` + + + +Gets the type of the variable. + + + + + + +**Returns**: + +The type of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) + + +### Function isInput + +![][public] + +``` +boolean ModelCenter::IReferenceVariable::isInput() +``` + + + +Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ad8a6169868d4d186b658946403eae2ab). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) + + +### Function toString + +![][public] + +``` +BSTR ModelCenter::IReferenceVariable::toString() +``` + + + +Converts the variable value to a string, validating the variable if necessary. + + + + + + +**Returns**: + +The value of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) + + +### Function fromString + +![][public] + +``` +void ModelCenter::IReferenceVariable::fromString(BSTR value) +``` + + + +Sets the value of the variable from the specified string. + + + + + + +**Parameters**: + +* **value**: New value. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + +**Reimplements**: [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) + + +### Function toStringAbsolute + +![][public] + +``` +BSTR ModelCenter::IReferenceVariable::toStringAbsolute() +``` + + + +Converts the value of the variable to a string. + + + + + + +**Returns**: + +The value of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IReferenceVariable::invalidate() +``` + + + +Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. + + + +**Return type**: void + +**Reimplements**: [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) + + +### Function directPrecedents + +![][public] + +``` +LPDISPATCH ModelCenter::IReferenceVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) + + +### Function directDependents + +![][public] + +``` +LPDISPATCH ModelCenter::IReferenceVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) + + +### Function precedentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IReferenceVariable::precedentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) + + +### Function dependentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IReferenceVariable::dependentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) + + +### Function precedents + +![][public] + +``` +LPDISPATCH ModelCenter::IReferenceVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) + + +### Function dependents + +![][public] + +``` +LPDISPATCH ModelCenter::IReferenceVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) + + +### Function isInputToComponent + +![][public] + +``` +boolean ModelCenter::IReferenceVariable::isInputToComponent() +``` + + + +Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) + + +### Function isInputToModel + +![][public] + +``` +boolean ModelCenter::IReferenceVariable::isInputToModel() +``` + + + +Checks whether or not the variable is an input. A linked input returns false (Output). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) + + +### Function setMetadata + +![][public] + +``` +void ModelCenter::IReferenceVariable::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) +``` + + + +Sets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata specifier used to store the data. +* **type**:
+* **value**:
+* **access**:
+* **archive**:
+ + + +**Parameters**: + +* BSTR **name** +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** +* VARIANT **value** +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** +* boolean **archive** + +**Return type**: void + +**Reimplements**: [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) + + +### Function getMetadata + +![][public] + +``` +VARIANT ModelCenter::IReferenceVariable::getMetadata(BSTR name) +``` + + + +Gets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata key name. + + +**Returns**: + +Metadata value. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +**Reimplements**: [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) + + +### Function createRefProp + +![][public] + +``` +IDispatch * ModelCenter::IReferenceVariable::createRefProp(BSTR name, BSTR type) +``` + + + +Creates a reference property for the variable. + + + + + + +**Parameters**: + +* **name**: Name of the reference property. +* **type**: Type of reference property to create.
+ Allowed types are: double, long, boolean, and string. + + +**Returns**: + +IDispatch* to an [IRefProp](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp) object. + + + +**Parameters**: + +* BSTR **name** +* BSTR **type** + +**Return type**: IDispatch * + + +### Function getRefPropValue + +![][public] + +``` +VARIANT ModelCenter::IReferenceVariable::getRefPropValue(BSTR name) +``` + + + +Gets the value of a specified reference property for the variable. + + + + + + +**Parameters**: + +* **name**: Name of the reference property. + + +**Returns**: + +The value as a variant. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + + +### Function setRefPropValue + +![][public] + +``` +void ModelCenter::IReferenceVariable::setRefPropValue(BSTR name, BSTR value) +``` + + + +Sets the value of a specified reference property for the variable. + + + + + + +**Parameters**: + +* **name**: Name of the reference property. +* **value**: New value. + + + +**Parameters**: + +* BSTR **name** +* BSTR **value** + +**Return type**: void + + +### Function getRefPropValueAbsolute + +![][public] + +``` +VARIANT ModelCenter::IReferenceVariable::getRefPropValueAbsolute(BSTR name) +``` + + + +Gets the value of a specified reference property for the variable, without validating first. + + + + + + +**Parameters**: + +* **name**: Name of the reference property. + + +**Returns**: + +The value as a variant. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IScriptComponent.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IScriptComponent.md index d29cb0f312..228342ffd5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IScriptComponent.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IScriptComponent.md @@ -1,760 +1,759 @@ - -# Interface ModelCenter::IScriptComponent - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1395) - - - -COM Instance. - -**Inherits from**: - -* [ModelCenter::IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) - -## Members - -* [addVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a04bbcea36b9bb694385e8620fa0a6b11) -* [AssociatedFiles](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a42162de74b1b046b277b927ace2dd403) -* [downloadValues](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ae380bd13a2c92b3392432f879e87baf2) -* [forwardSchedule](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aedc1fa62c68c5512ccfe6913e018610c) -* [getFullName](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a7e4a9eb5127e60bfbbd90640e35b32a7) -* [getMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a2bd6e585619f4cd76426932b62dcf60a) -* [getName](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a88c3162ff460faee36d43d3903c7a498) -* [getPositionX](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aa032eb6b3c27a69052a8eb81053dfc34) -* [getPositionY](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a7b5ce3f6ce5bfd44702ff1fb874fb9fd) -* [getSource](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a3dc2690409dd67fc5b3023e50d7abed0) -* [getSourceScript](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1af377a582a930edbc7b4a56b57cd54375) -* [getType](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a551d15c4f328f341d8cba0fe28bfd2b0) -* [getVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ad88148c419a4c75c4c79b9d5e3c41eb6) -* [Groups](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a6d041596bb6e0be6dd0710c6c9e0e8c9) -* [IndexInParent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a20f2c6a05beb38eb4d95a010cb48f94e) -* [invalidate](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a70b40fcdb20ca2991b3db649f77eb55f) -* [invokeMethod](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a03484bf5c7636d2015b3b11c3849ac30) -* [language](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1af3d2bdfd6cd0c29ada055bee3686b2ff) -* [ParentAssembly](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a48996a90eb72b62a9dff1119708c9d42) -* [prevalidate](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a0f82cdd3e9fa556568265ef51c8bc0de) -* [reconnect](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a716d694026d6ef45a78ab51a8d1f6eae) -* [removeVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a6b191d44fea8ec432315202d094acdb0) -* [rename](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a775db6663f994e82bb2529efe6585c8d) -* [run](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1afcc83d74aabc7ddd66da4fccb708f0e9) -* [setMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a41eb816b08e0e89739822ba87e5416c6) -* [setSourceFromFile](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aa34064721143d9012bfe5c0c899415a8) -* [setSourceFromString](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ab41aea5c06252f82fc831ea6af40e1b1) -* [setVariables](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a03a16eed6dbd98df2286d42f3a47db56) -* [show](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ad7d6f94d38270f36b80ed3c0109312dd) -* [timeout](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a3a0d87f35ccd9845a8dc70e1ccf531eb) -* [userData](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ade9f3ed3c58d1f3eb9914c3a395eb7a6) -* [Variables](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a54219eed78fa8eed485e8da974458ea1) - -## Properties - - -### Property Variables - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IScriptComponent::Variables -``` - - - - - - - -**Return type**: VARIANT - - -### Property Groups - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IScriptComponent::Groups -``` - - - - - - - -**Return type**: VARIANT - - -### Property userData - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IScriptComponent::userData -``` - - - - - - - -**Return type**: VARIANT - - -### Property AssociatedFiles - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IScriptComponent::AssociatedFiles -``` - - - - - - - -**Return type**: VARIANT - - -### Property IndexInParent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -int ModelCenter::IScriptComponent::IndexInParent -``` - - - - - - - -**Return type**: int - - -### Property ParentAssembly - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IScriptComponent::ParentAssembly -``` - - - - - - - -**Return type**: LPDISPATCH - - -### Property language - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IScriptComponent::language -``` - - - -The script language. Must be set prior to setting the source. - - - -**Return type**: BSTR - - -### Property timeout - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -double ModelCenter::IScriptComponent::timeout -``` - - - -The script timeout in seconds. Use -1 to set no timeout. - - - -**Return type**: double - - -### Property forwardSchedule - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IScriptComponent::forwardSchedule -``` - - - -True to run the component in forward scheduling mode. - - - -**Return type**: boolean - - -### Property prevalidate - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IScriptComponent::prevalidate -``` - - - -True to pre-validate the component. - - - -**Return type**: boolean - -## Public functions - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IScriptComponent::getName() -``` - - - -Gets the name of the Component. - - - - - - -**Returns**: - -The name of the Component. - - - -**Return type**: BSTR - -**Reimplements**: [getName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a19763f04596904ff5cab2f4f72f6f501) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IScriptComponent::getFullName() -``` - - - -Gets the full [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) path of the Component. - - - - - - -**Returns**: - -the full ModelCenter path of the Component. - - - -**Return type**: BSTR - -**Reimplements**: [getFullName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9309a89032b2d7d28baf279a3b76b5e8) - - -### Function run - -![][public] - -``` -void ModelCenter::IScriptComponent::run() -``` - - - -Runs the Component. - - - -**Return type**: void - -**Reimplements**: [run](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1adf60ad0c84852250f14d27cfa689d8d0) - - -### Function getSource - -![][public] - -``` -BSTR ModelCenter::IScriptComponent::getSource() -``` - - - -Gets the source of the Component. - - - - - - -**Returns**: - -The source of the Component. - - - -**Return type**: BSTR - -**Reimplements**: [getSource](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a7ee6752f95f3bdfbe83132a3a7794cb2) - - -### Function invokeMethod - -![][public] - -``` -void ModelCenter::IScriptComponent::invokeMethod(BSTR method) -``` - - - -Invokes one of the Component's methods. - - - - - - -**Parameters**: - -* **method**: The name of the method to invoke. - - - -**Parameters**: - -* BSTR **method** - -**Return type**: void - -**Reimplements**: [invokeMethod](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afaddb2c21be03b26716594af883a51ee) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IScriptComponent::invalidate() -``` - - - -Invalidates the Component and all of its variables. - - - -**Return type**: void - -**Reimplements**: [invalidate](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a73c230184c72f5abcb7d3af5f91c9d1e) - - -### Function reconnect - -![][public] - -``` -void ModelCenter::IScriptComponent::reconnect() -``` - - - -Reconnect a Component. - - - -**Return type**: void - -**Reimplements**: [reconnect](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a44d641cc9d4a797f88e56495c466479c) - - -### Function downloadValues - -![][public] - -``` -void ModelCenter::IScriptComponent::downloadValues() -``` - - - -Downloads the component's variable values from [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) Remote Execution, if it's a MCRE component. - - - -**Return type**: void - -**Reimplements**: [downloadValues](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a761c665246557b5b4201873a722d6fed) - - -### Function getVariable - -![][public] - -``` -LPDISPATCH ModelCenter::IScriptComponent::getVariable(BSTR name) -``` - - - -Gets the Variable by the specified name. - - - - - - -**Parameters**: - -* **name**: The name of the variable to retrieve in dotted notation relative to the Component. - - -**Returns**: - -IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: LPDISPATCH - -**Reimplements**: [getVariable](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afb270ae53383589c63f87b4e3385f128) - - -### Function getPositionX - -![][public] - -``` -int ModelCenter::IScriptComponent::getPositionX() -``` - - - - - - - -**Return type**: int - -**Reimplements**: [getPositionX](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a0c3e0c952584ba25801114e01010eab0) - - -### Function getPositionY - -![][public] - -``` -int ModelCenter::IScriptComponent::getPositionY() -``` - - - - - - - -**Return type**: int - -**Reimplements**: [getPositionY](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1ad3da2b98a973112ea897cf3b146f0276) - - -### Function rename - -![][public] - -``` -void ModelCenter::IScriptComponent::rename(BSTR name) -``` - - - -Renames the current Component. - - - - - - -**Parameters**: - -* **name**: New name of the Component. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: void - -**Reimplements**: [rename](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9cae71e48e01e94d48c0353d3db4d90c) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IScriptComponent::getType() -``` - - - -Gets the type of the component. Valid types include: -* Component - -* Assembly - -* Sequence - -* If - -* Parallel - -* Empty - -* ForEach - - - - - - - - -**Returns**: - -The type of the component. - - - -**Return type**: BSTR - -**Reimplements**: [getType](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a04395c5a8d6ceff26ae08e6c001bdd45) - - -### Function show - -![][public] - -``` -void ModelCenter::IScriptComponent::show() -``` - - - -Show the GUI form associated with the component, if any. - - - -**Return type**: void - -**Reimplements**: [show](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aa35c0fb45f677b3c2daf475e53107773) - - -### Function setSourceFromString - -![][public] - -``` -void ModelCenter::IScriptComponent::setSourceFromString(BSTR script) -``` - - - -Sets the source script code of the script component to the given string. The source code is parsed baesd on the current language setting. The script language should be set before calling this function. -**Parameters**: - -* **script**: string value to use as the script code - - - -**Parameters**: - -* BSTR **script** - -**Return type**: void - - -### Function setSourceFromFile - -![][public] - -``` -void ModelCenter::IScriptComponent::setSourceFromFile(BSTR file) -``` - - - -Sets the source script code of the script component to the contents of the file. The source code is parsed baesd on the current language setting. The script language should be set before calling this function. -**Parameters**: - -* **file**: the full path of the file - - - -**Parameters**: - -* BSTR **file** - -**Return type**: void - - -### Function addVariable - -![][public] - -``` -LPDISPATCH ModelCenter::IScriptComponent::addVariable(BSTR name, BSTR type, BSTR state) -``` - - - -Adds the variable to the component. -**Parameters**: - -* **name**: the name of the variable -* **type**: the type of the variable e.x. "double", "string[]", "object", etc -* **state**: the state of the variable e.x. "input", "output" - - -**Returns**: - -the [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object of the newly created variable - - - -**Parameters**: - -* BSTR **name** -* BSTR **type** -* BSTR **state** - -**Return type**: LPDISPATCH - - -### Function removeVariable - -![][public] - -``` -void ModelCenter::IScriptComponent::removeVariable(BSTR name) -``` - - - -Removes the variable from the component. -**Parameters**: - -* **name**: the name of the variable to remove - - - -**Parameters**: - -* BSTR **name** - -**Return type**: void - - -### Function setVariables - -![][public] - -``` -void ModelCenter::IScriptComponent::setVariables(VARIANT inputs, BSTR outputs) -``` - - - -Sets the variables of the component. Previous variables of this component are removed. -**Parameters**: - -* **inputs**: comma separated list of input variables e.x. "long n, double[] p, ..." -* **outputs**: comma separated list of output variables e.x. "double x, string y, ..." - - - -**Parameters**: - -* VARIANT **inputs** -* BSTR **outputs** - -**Return type**: void - - -### Function getSourceScript - -![][public] - -``` -BSTR ModelCenter::IScriptComponent::getSourceScript() -``` - - - -Gets the source script code of the script component. -**Returns**: - -the source script - - - -**Return type**: BSTR - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IScriptComponent + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1395) + + + +COM Instance. + +**Inherits from**: + +* [ModelCenter::IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) + +## Members + +* [addVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a04bbcea36b9bb694385e8620fa0a6b11) +* [AssociatedFiles](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a42162de74b1b046b277b927ace2dd403) +* [downloadValues](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ae380bd13a2c92b3392432f879e87baf2) +* [forwardSchedule](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aedc1fa62c68c5512ccfe6913e018610c) +* [getFullName](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a7e4a9eb5127e60bfbbd90640e35b32a7) +* [getMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a2bd6e585619f4cd76426932b62dcf60a) +* [getName](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a88c3162ff460faee36d43d3903c7a498) +* [getPositionX](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aa032eb6b3c27a69052a8eb81053dfc34) +* [getPositionY](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a7b5ce3f6ce5bfd44702ff1fb874fb9fd) +* [getSource](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a3dc2690409dd67fc5b3023e50d7abed0) +* [getSourceScript](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1af377a582a930edbc7b4a56b57cd54375) +* [getType](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a551d15c4f328f341d8cba0fe28bfd2b0) +* [getVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ad88148c419a4c75c4c79b9d5e3c41eb6) +* [Groups](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a6d041596bb6e0be6dd0710c6c9e0e8c9) +* [IndexInParent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a20f2c6a05beb38eb4d95a010cb48f94e) +* [invalidate](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a70b40fcdb20ca2991b3db649f77eb55f) +* [invokeMethod](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a03484bf5c7636d2015b3b11c3849ac30) +* [language](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1af3d2bdfd6cd0c29ada055bee3686b2ff) +* [ParentAssembly](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a48996a90eb72b62a9dff1119708c9d42) +* [prevalidate](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a0f82cdd3e9fa556568265ef51c8bc0de) +* [reconnect](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a716d694026d6ef45a78ab51a8d1f6eae) +* [removeVariable](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a6b191d44fea8ec432315202d094acdb0) +* [rename](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a775db6663f994e82bb2529efe6585c8d) +* [run](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1afcc83d74aabc7ddd66da4fccb708f0e9) +* [setMetadata](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a41eb816b08e0e89739822ba87e5416c6) +* [setSourceFromFile](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1aa34064721143d9012bfe5c0c899415a8) +* [setSourceFromString](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ab41aea5c06252f82fc831ea6af40e1b1) +* [setVariables](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a03a16eed6dbd98df2286d42f3a47db56) +* [show](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ad7d6f94d38270f36b80ed3c0109312dd) +* [timeout](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a3a0d87f35ccd9845a8dc70e1ccf531eb) +* [userData](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1ade9f3ed3c58d1f3eb9914c3a395eb7a6) +* [Variables](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent_1a54219eed78fa8eed485e8da974458ea1) + +## Properties + + +### Property Variables + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IScriptComponent::Variables +``` + + + + + + + +**Return type**: VARIANT + + +### Property Groups + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IScriptComponent::Groups +``` + + + + + + + +**Return type**: VARIANT + + +### Property userData + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IScriptComponent::userData +``` + + + + + + + +**Return type**: VARIANT + + +### Property AssociatedFiles + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IScriptComponent::AssociatedFiles +``` + + + + + + + +**Return type**: VARIANT + + +### Property IndexInParent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +int ModelCenter::IScriptComponent::IndexInParent +``` + + + + + + + +**Return type**: int + + +### Property ParentAssembly + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IScriptComponent::ParentAssembly +``` + + + + + + + +**Return type**: LPDISPATCH + + +### Property language + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IScriptComponent::language +``` + + + +The script language. Must be set prior to setting the source. + + + +**Return type**: BSTR + + +### Property timeout + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +double ModelCenter::IScriptComponent::timeout +``` + + + +The script timeout in seconds. Use -1 to set no timeout. + + + +**Return type**: double + + +### Property forwardSchedule + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IScriptComponent::forwardSchedule +``` + + + +True to run the component in forward scheduling mode. + + + +**Return type**: boolean + + +### Property prevalidate + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IScriptComponent::prevalidate +``` + + + +True to pre-validate the component. + + + +**Return type**: boolean + +## Public functions + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IScriptComponent::getName() +``` + + + +Gets the name of the Component. + + + + + + +**Returns**: + +The name of the Component. + + + +**Return type**: BSTR + +**Reimplements**: [getName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a19763f04596904ff5cab2f4f72f6f501) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IScriptComponent::getFullName() +``` + + + +Gets the full [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) path of the Component. + + + + + + +**Returns**: + +the full ModelCenter path of the Component. + + + +**Return type**: BSTR + +**Reimplements**: [getFullName](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9309a89032b2d7d28baf279a3b76b5e8) + + +### Function run + +![][public] + +``` +void ModelCenter::IScriptComponent::run() +``` + + + +Runs the Component. + + + +**Return type**: void + +**Reimplements**: [run](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1adf60ad0c84852250f14d27cfa689d8d0) + + +### Function getSource + +![][public] + +``` +BSTR ModelCenter::IScriptComponent::getSource() +``` + + + +Gets the source of the Component. + + + + + + +**Returns**: + +The source of the Component. + + + +**Return type**: BSTR + +**Reimplements**: [getSource](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a7ee6752f95f3bdfbe83132a3a7794cb2) + + +### Function invokeMethod + +![][public] + +``` +void ModelCenter::IScriptComponent::invokeMethod(BSTR method) +``` + + + +Invokes one of the Component's methods. + + + + + + +**Parameters**: + +* **method**: The name of the method to invoke. + + + +**Parameters**: + +* BSTR **method** + +**Return type**: void + +**Reimplements**: [invokeMethod](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afaddb2c21be03b26716594af883a51ee) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IScriptComponent::invalidate() +``` + + + +Invalidates the Component and all of its variables. + + + +**Return type**: void + +**Reimplements**: [invalidate](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a73c230184c72f5abcb7d3af5f91c9d1e) + + +### Function reconnect + +![][public] + +``` +void ModelCenter::IScriptComponent::reconnect() +``` + + + +Reconnect a Component. + + + +**Return type**: void + +**Reimplements**: [reconnect](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a44d641cc9d4a797f88e56495c466479c) + + +### Function downloadValues + +![][public] + +``` +void ModelCenter::IScriptComponent::downloadValues() +``` + + + +Downloads the component's variable values from [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) Remote Execution, if it's a MCRE component. + + + +**Return type**: void + +**Reimplements**: [downloadValues](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a761c665246557b5b4201873a722d6fed) + + +### Function getVariable + +![][public] + +``` +LPDISPATCH ModelCenter::IScriptComponent::getVariable(BSTR name) +``` + + + +Gets the Variable by the specified name. + + + + + + +**Parameters**: + +* **name**: The name of the variable to retrieve in dotted notation relative to the Component. + + +**Returns**: + +IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: LPDISPATCH + +**Reimplements**: [getVariable](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1afb270ae53383589c63f87b4e3385f128) + + +### Function getPositionX + +![][public] + +``` +int ModelCenter::IScriptComponent::getPositionX() +``` + + + + + + + +**Return type**: int + +**Reimplements**: [getPositionX](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a0c3e0c952584ba25801114e01010eab0) + + +### Function getPositionY + +![][public] + +``` +int ModelCenter::IScriptComponent::getPositionY() +``` + + + + + + + +**Return type**: int + +**Reimplements**: [getPositionY](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1ad3da2b98a973112ea897cf3b146f0276) + + +### Function rename + +![][public] + +``` +void ModelCenter::IScriptComponent::rename(BSTR name) +``` + + + +Renames the current Component. + + + + + + +**Parameters**: + +* **name**: New name of the Component. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: void + +**Reimplements**: [rename](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a9cae71e48e01e94d48c0353d3db4d90c) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IScriptComponent::getType() +``` + + + +Gets the type of the component. Valid types include: +* Component + +* Assembly + +* Sequence + +* If + +* Parallel + +* Empty + +* ForEach + + + + + + + + +**Returns**: + +The type of the component. + + + +**Return type**: BSTR + +**Reimplements**: [getType](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1a04395c5a8d6ceff26ae08e6c001bdd45) + + +### Function show + +![][public] + +``` +void ModelCenter::IScriptComponent::show() +``` + + + +Show the GUI form associated with the component, if any. + + + +**Return type**: void + +**Reimplements**: [show](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent_1aa35c0fb45f677b3c2daf475e53107773) + + +### Function setSourceFromString + +![][public] + +``` +void ModelCenter::IScriptComponent::setSourceFromString(BSTR script) +``` + + + +Sets the source script code of the script component to the given string. The source code is parsed baesd on the current language setting. The script language should be set before calling this function. +**Parameters**: + +* **script**: string value to use as the script code + + + +**Parameters**: + +* BSTR **script** + +**Return type**: void + + +### Function setSourceFromFile + +![][public] + +``` +void ModelCenter::IScriptComponent::setSourceFromFile(BSTR file) +``` + + + +Sets the source script code of the script component to the contents of the file. The source code is parsed baesd on the current language setting. The script language should be set before calling this function. +**Parameters**: + +* **file**: the full path of the file + + + +**Parameters**: + +* BSTR **file** + +**Return type**: void + + +### Function addVariable + +![][public] + +``` +LPDISPATCH ModelCenter::IScriptComponent::addVariable(BSTR name, BSTR type, BSTR state) +``` + + + +Adds the variable to the component. +**Parameters**: + +* **name**: the name of the variable +* **type**: the type of the variable e.x. "double", "string[]", "object", etc +* **state**: the state of the variable e.x. "input", "output" + + +**Returns**: + +the [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object of the newly created variable + + + +**Parameters**: + +* BSTR **name** +* BSTR **type** +* BSTR **state** + +**Return type**: LPDISPATCH + + +### Function removeVariable + +![][public] + +``` +void ModelCenter::IScriptComponent::removeVariable(BSTR name) +``` + + + +Removes the variable from the component. +**Parameters**: + +* **name**: the name of the variable to remove + + + +**Parameters**: + +* BSTR **name** + +**Return type**: void + + +### Function setVariables + +![][public] + +``` +void ModelCenter::IScriptComponent::setVariables(VARIANT inputs, BSTR outputs) +``` + + + +Sets the variables of the component. Previous variables of this component are removed. +**Parameters**: + +* **inputs**: comma separated list of input variables e.x. "long n, double[] p, ..." +* **outputs**: comma separated list of output variables e.x. "double x, string y, ..." + + + +**Parameters**: + +* VARIANT **inputs** +* BSTR **outputs** + +**Return type**: void + + +### Function getSourceScript + +![][public] + +``` +BSTR ModelCenter::IScriptComponent::getSourceScript() +``` + + + +Gets the source script code of the script component. +**Returns**: + +the source script + + + +**Return type**: BSTR + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IShowHelpEvents.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IShowHelpEvents.md index a100257f2e..70ff5b559e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IShowHelpEvents.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IShowHelpEvents.md @@ -1,45 +1,44 @@ - -# Interface ModelCenter::IShowHelpEvents - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 4986) - - - -Help system event functions that ModelCenter can send. - -## Members - -* [ShowHelp](interfaceModelCenter_1_1IShowHelpEvents.md#interfaceModelCenter_1_1IShowHelpEvents_1a9e94376ebaa4b126ce37c5c541e8f5cb) - -## Public functions - - -### Function ShowHelp - -![][public] - -``` -void ModelCenter::IShowHelpEvents::ShowHelp(long context) -``` - - - -Function that is called when help is requested. -**Parameters**: - -* **context**: the context the help was called for - - - -**Parameters**: - -* long **context** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IShowHelpEvents + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 4986) + + + +Help system event functions that ModelCenter can send. + +## Members + +* [ShowHelp](interfaceModelCenter_1_1IShowHelpEvents.md#interfaceModelCenter_1_1IShowHelpEvents_1a9e94376ebaa4b126ce37c5c541e8f5cb) + +## Public functions + + +### Function ShowHelp + +![][public] + +``` +void ModelCenter::IShowHelpEvents::ShowHelp(long context) +``` + + + +Function that is called when help is requested. +**Parameters**: + +* **context**: the context the help was called for + + + +**Parameters**: + +* long **context** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IStringArray.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IStringArray.md index af4a05478f..f7fd29aa93 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IStringArray.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IStringArray.md @@ -1,1379 +1,1378 @@ - -# Interface ModelCenter::IStringArray - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5486) - - - -COM Instance. - -**Inherits from**: - -* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) - -## Members - -* [autoSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aca63a47369d69cbbf53532286b64a611) -* [dependentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4227d6aca4e2d7791cea69efeb5b81fd) -* [dependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a392d8e4080854c954c165833bb89a7db) -* [description](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a9a336c7daf4b7f248103e2a3654139e6) -* [directDependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4820176e7ca9e1c3173d602308144c62) -* [directPrecedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a40c76b900187ef244f14c5c8e9bb65bf) -* [enumAliases](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a75eca0b30d1c439ddae44c33b03f9797) -* [enumValues](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ad3575ae96f975b212aaea0739a0c363d) -* [fromString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a65a839b63dfb0495f577bf70ca87a320) -* [fromStringEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8fa6aff7c64224c1c488d5866dfc4865) -* [getArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a499c8a85632b8c29f36a4832ae0a2ba6) -* [getDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a83abe70ccf5e8a0a582748d84e3d7956) -* [getFullName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4ca185e60b69ce2ff41d19a2270bc28b) -* [getLength](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a39098992a1f29458010e4d18385d3681) -* [getMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac730dc0fbfc8ae56788048e6c0fb80fa) -* [getName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a0a90870618bd396edc53c27ff0b8c9af) -* [getSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a3d171136e0b219dd4e2d0d1b4bb9aa1f) -* [getType](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a582f9e8e47e60eca8041b98c996a4f4f) -* [getValue](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a7ba8cf139385e0630061f9ccfc8dc55e) -* [getValueAbsolute](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4e082d20ea2f1b47c95d26152595d05d) -* [hasChanged](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a7d7a0e45d355883535175f060d150a25) -* [hide](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a39446dbc4a63268669450640360a10ca) -* [invalidate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac6dd084c61d7ce2631d207242eca89bf) -* [isInput](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a3b7b397239f04cf9ea9358f9477ee2c4) -* [isInputToComponent](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ad59d273bea1a7e02540520e9b4428264) -* [isInputToModel](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1af1da4c99c6359d527ad57c9433333a36) -* [isValid](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8b738f7eef3f9a3f8a723cede3809f47) -* [length](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af118bdf4b120050d6700a7ceae7f5bec) -* [numDimensions](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1abaa61cb129a23c20be499a61ec4c8443) -* [OwningComponent](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8c1ac6e84d73e34b12cc5e9397bb83a4) -* [precedentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a19c1ae9d08b968bae4b6fdd1ec74fc3e) -* [precedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a913272799193e5d02033c63c746ead9e) -* [setArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1addf446b647e3f8946e8e72825241e0d3) -* [setDimensions](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1aa3a9cdee8b632a3adda4e2d1814c66f8) -* [setLength](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ab20a6b27ddb532d0186532a52a148d91) -* [setMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a495551c5a05027a8537ffce75f333f8e) -* [setSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b7b41ca5463a86aecb2368d73464c0e) -* [setValue](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a34205a2be0ffe6695721d957cd90f963) -* [size](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4164bff5f32408083a55fc9a327ebc66) -* [toString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1aa735025db3ac6e13cb486f8629b86a69) -* [toStringAbsolute](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1adfb1dee0a1fd5b541eacba1e4cbba7ad) -* [toStringAbsoluteEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a3684e3b0b2d36a599f75236a6f5e90e7) -* [toStringEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a9013b29e3ca18c5a0ecaff8dc6d19b5f) -* [validate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a86b82bcfb1ccfa2428968307eaa07108) -* [value](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ae449bcebd78b7ec3fe365cd8fbd3dac7) -* [value](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1afd9e0eaba3274e5802f25fe40f039c16) - -## Properties - - -### Property hasChanged - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IStringArray::hasChanged -``` - - - - - - - -**Return type**: boolean - - -### Property hide - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IStringArray::hide -``` - - - - - - - -**Return type**: boolean - - -### Property OwningComponent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IStringArray::OwningComponent -``` - - - - - - - -**Return type**: LPDISPATCH - - -### Property size - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IStringArray::size -``` - - - - - - - -**Return type**: long - - -### Property numDimensions - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IStringArray::numDimensions -``` - - - - - - - -**Return type**: long - - -### Property description - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IStringArray::description -``` - - - -Description of the array. - - - -**Return type**: BSTR - - -### Property enumAliases - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IStringArray::enumAliases -``` - - - -Enumerated aliases of the array. - - - -**Return type**: BSTR - - -### Property enumValues - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IStringArray::enumValues -``` - - - -Enumerated values of the array. - - - -**Return type**: BSTR - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5578) - -``` -VARIANT ModelCenter::IStringArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9) -``` - - - -Value of an array element. - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - -**Returns**: - -The value. - - - -**Return type**: VARIANT - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5594) - -``` -BSTR ModelCenter::IStringArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9,[optional] VARIANT d10) -``` - - - -Value of an array element. - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). -* **newValue**: The new value. - - - -**Return type**: BSTR - -## Public functions - - -### Function isValid - -![][public] - -``` -boolean ModelCenter::IStringArray::isValid() -``` - - - -Finds out whether or not the array is valid. - - - - - - -**Returns**: - -yes(TRUE) or no(FALSE). - - - -**Return type**: boolean - -**Reimplements**: [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) - - -### Function validate - -![][public] - -``` -void ModelCenter::IStringArray::validate() -``` - - - -Causes the array to validate itself. - - - -**Return type**: void - -**Reimplements**: [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IStringArray::getName() -``` - - - -Gets the name of the array. - - - - - - -**Returns**: - -The name of the array. - - - -**Return type**: BSTR - -**Reimplements**: [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IStringArray::getFullName() -``` - - - -Gets the full ModelCenter path of the array. - - - - - - -**Returns**: - -The full ModelCenter path of the array. - - - -**Return type**: BSTR - -**Reimplements**: [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IStringArray::getType() -``` - - - -Gets the type of the array. - - - - - - -**Returns**: - -The type of the array as a string. - - - -**Return type**: BSTR - -**Reimplements**: [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) - - -### Function isInput - -![][public] - -``` -boolean ModelCenter::IStringArray::isInput() -``` - - - -Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1af1da4c99c6359d527ad57c9433333a36). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) - - -### Function toString - -![][public] - -``` -BSTR ModelCenter::IStringArray::toString() -``` - - - -Converts the array to a string, validating the array if necessary. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. - - - - - - -**Returns**: - -The converted string value of the array. - - - -**Return type**: BSTR - -**Reimplements**: [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) - - -### Function fromString - -![][public] - -``` -void ModelCenter::IStringArray::fromString(BSTR value) -``` - - - -Sets the value of the array from a specified string. For 1D arrays, the specification is of the form '1,2,3'.
-For nD arrays, the specification is of the form 'bounds[2,2,2] {1,2,3,4,5,6,7,8}'.
-String arrays may optionally have the elements quoted in the form 'bounds[2,3] {"a", "b,c", "d", "", "e", "f"}' - - - - - - -**Parameters**: - -* **value**: New value. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - -**Reimplements**: [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) - - -### Function toStringAbsolute - -![][public] - -``` -BSTR ModelCenter::IStringArray::toStringAbsolute() -``` - - - -Converts the array to a string. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. - - - - - - -**Returns**: - -The converted string value of the array. - - - -**Return type**: BSTR - -**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IStringArray::invalidate() -``` - - - -Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. - - - -**Return type**: void - -**Reimplements**: [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) - - -### Function directPrecedents - -![][public] - -``` -LPDISPATCH ModelCenter::IStringArray::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) - - -### Function directDependents - -![][public] - -``` -LPDISPATCH ModelCenter::IStringArray::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) - - -### Function precedentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IStringArray::precedentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) - - -### Function dependentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IStringArray::dependentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) - - -### Function precedents - -![][public] - -``` -LPDISPATCH ModelCenter::IStringArray::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) - - -### Function dependents - -![][public] - -``` -LPDISPATCH ModelCenter::IStringArray::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) - - -### Function isInputToComponent - -![][public] - -``` -boolean ModelCenter::IStringArray::isInputToComponent() -``` - - - -Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) - - -### Function isInputToModel - -![][public] - -``` -boolean ModelCenter::IStringArray::isInputToModel() -``` - - - -Checks whether or not the variable is an input. A linked input returns false (Output). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) - - -### Function setMetadata - -![][public] - -``` -void ModelCenter::IStringArray::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) -``` - - - -Sets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata specifier used to store the data. -* **type**:
-* **value**:
-* **access**:
-* **archive**:
- - - -**Parameters**: - -* BSTR **name** -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** -* VARIANT **value** -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** -* boolean **archive** - -**Return type**: void - -**Reimplements**: [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) - - -### Function getMetadata - -![][public] - -``` -VARIANT ModelCenter::IStringArray::getMetadata(BSTR name) -``` - - - -Gets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata key name. - - -**Returns**: - -Metadata value. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -**Reimplements**: [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) - - -### Function toStringEx - -![][public] - -``` -BSTR ModelCenter::IStringArray::toStringEx(long index) -``` - - - -Converts the value of an array element to a string, validating the array if necessary. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The value of the element as a string. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - -**Reimplements**: [toStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a37c622ae9f50579f714ce98c0379cd98) - - -### Function fromStringEx - -![][public] - -``` -void ModelCenter::IStringArray::fromStringEx(BSTR value, long index) -``` - - - -Sets the value of an array element from a specified string. - - - - - - -**Parameters**: - -* **value**: New value. -* **index**: Index of the array element (0-based index). - - - -**Parameters**: - -* BSTR **value** -* long **index** - -**Return type**: void - -**Reimplements**: [fromStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad23f4082662c464be07251d6d1695a2d) - - -### Function toStringAbsoluteEx - -![][public] - -``` -BSTR ModelCenter::IStringArray::toStringAbsoluteEx(long index) -``` - - - -Converts the value of an array element to a string. - - - - - - -**Parameters**: - -* **index**: Index of the array element (0-based index). - - -**Returns**: - -The value of the element as a string. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - -**Reimplements**: [toStringAbsoluteEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a2e3041440581aab716c684fe88d2ee87) - - -### Function getLength - -![][public] - -``` -long ModelCenter::IStringArray::getLength([optional] VARIANT dim) -``` - - - -Get the length of the n'th dimension of the array. - - - - - - -**Parameters**: - -* **dim**: Dimension of the array to query. This uses a 0 based index, so 0 will give you the first dimension, 1 the second, etc. If omitted, gives the first dimension - - -**Returns**: - -Length(size) of the array. - - - -**Parameters**: - -* _[optional]_ VARIANT **dim** - -**Return type**: long - -**Reimplements**: [getLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) - - -### Function setLength - -![][public] - -``` -void ModelCenter::IStringArray::setLength(long length, [optional] VARIANT dim) -``` - - - -Sets the length of the n'th dimension of the array - - - - - - -**Parameters**: - -* **length**: New length of the n'th dimension of the array -* **dim**: The dimension to set. This uses a 0 based index, so 0 will set the first dimension, 1 the second, etc. If omitted, sets the first dimension - - - -**Parameters**: - -* long **length** -* _[optional]_ VARIANT **dim** - -**Return type**: void - -**Reimplements**: [setLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) - - -### Function setDimensions - -![][public] - -``` -void ModelCenter::IStringArray::setDimensions(long d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Sets the number of dimensions of an array and the length of each dimension in one call. An array initializes to 0 length. If any dimension of the array has 0 length, the whole array contains no data. You must set the array size before filling in values unless you are using the [setArray()](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1addf446b647e3f8946e8e72825241e0d3) call. - - - - - - -**Parameters**: - -* **d1**: length of the 1st dimension of the array -* **d2**: length of the 2nd dimension of the array. If omitted, the array is 1 dimensional -* **d3**: length of the 3rd dimension of the array. If omitted, the array is 2 dimensional -* **d4**: length of the 4th dimension of the array. If omitted, the array is 3 dimensional -* **d5**: length of the 5th dimension of the array. If omitted, the array is 4 dimensional -* **d6**: length of the 6th dimension of the array. If omitted, the array is 5 dimensional -* **d7**: length of the 7th dimension of the array. If omitted, the array is 6 dimensional -* **d8**: length of the 8th dimension of the array. If omitted, the array is 7 dimensional -* **d9**: length of the 9th dimension of the array. If omitted, the array is 8 dimensional -* **d10**: length of the 10th dimension of the array. If omitted, the array is 9 dimensional - - - -**Parameters**: - -* long **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: void - -**Reimplements**: [setDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) - - -### Function getValue - -![][public] - -``` -BSTR ModelCenter::IStringArray::getValue(VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Gets the value of an array element. - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - -**Returns**: - -The value. - - - -**Parameters**: - -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: BSTR - - -### Function setValue - -![][public] - -``` -void ModelCenter::IStringArray::setValue(BSTR value, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Sets the value of an array element. - - - - - - -**Parameters**: - -* **value**: New value. -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - - -**Parameters**: - -* BSTR **value** -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: void - - -### Function getArray - -![][public] - -``` -VARIANT ModelCenter::IStringArray::getArray() -``` - - - -Gets the COM array. - - - - - - -**Returns**: - -The COM array. - - - -**Return type**: VARIANT - - -### Function setArray - -![][public] - -``` -void ModelCenter::IStringArray::setArray(VARIANT array) -``` - - - -Sets the COM array. - - - - - - -**Parameters**: - -* **array**: The COM array. - - - -**Parameters**: - -* VARIANT **array** - -**Return type**: void - - -### Function getValueAbsolute - -![][public] - -``` -BSTR ModelCenter::IStringArray::getValueAbsolute(VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) -``` - - - -Gets the value of an array element without validating. - - - - - - -**Parameters**: - -* **d1**: Index in the 1st dimension (0-based index). -* **d2**: Index in the 2nd dimension (0-based index). -* **d3**: Index in the 3rd dimension (0-based index). -* **d4**: Index in the 4th dimension (0-based index). -* **d5**: Index in the 5th dimension (0-based index). -* **d6**: Index in the 6th dimension (0-based index). -* **d7**: Index in the 7th dimension (0-based index). -* **d8**: Index in the 8th dimension (0-based index). -* **d9**: Index in the 9th dimension (0-based index). -* **d10**: Index in the 10th dimension (0-based index). - - -**Returns**: - -The value. - - - -**Parameters**: - -* VARIANT **d1** -* _[optional]_ VARIANT **d2** -* _[optional]_ VARIANT **d3** -* _[optional]_ VARIANT **d4** -* _[optional]_ VARIANT **d5** -* _[optional]_ VARIANT **d6** -* _[optional]_ VARIANT **d7** -* _[optional]_ VARIANT **d8** -* _[optional]_ VARIANT **d9** -* _[optional]_ VARIANT **d10** - -**Return type**: BSTR - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IStringArray + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5486) + + + +COM Instance. + +**Inherits from**: + +* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) + +## Members + +* [autoSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aca63a47369d69cbbf53532286b64a611) +* [dependentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4227d6aca4e2d7791cea69efeb5b81fd) +* [dependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a392d8e4080854c954c165833bb89a7db) +* [description](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a9a336c7daf4b7f248103e2a3654139e6) +* [directDependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4820176e7ca9e1c3173d602308144c62) +* [directPrecedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a40c76b900187ef244f14c5c8e9bb65bf) +* [enumAliases](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a75eca0b30d1c439ddae44c33b03f9797) +* [enumValues](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ad3575ae96f975b212aaea0739a0c363d) +* [fromString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a65a839b63dfb0495f577bf70ca87a320) +* [fromStringEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8fa6aff7c64224c1c488d5866dfc4865) +* [getArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a499c8a85632b8c29f36a4832ae0a2ba6) +* [getDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a83abe70ccf5e8a0a582748d84e3d7956) +* [getFullName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4ca185e60b69ce2ff41d19a2270bc28b) +* [getLength](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a39098992a1f29458010e4d18385d3681) +* [getMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac730dc0fbfc8ae56788048e6c0fb80fa) +* [getName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a0a90870618bd396edc53c27ff0b8c9af) +* [getSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a3d171136e0b219dd4e2d0d1b4bb9aa1f) +* [getType](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a582f9e8e47e60eca8041b98c996a4f4f) +* [getValue](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a7ba8cf139385e0630061f9ccfc8dc55e) +* [getValueAbsolute](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4e082d20ea2f1b47c95d26152595d05d) +* [hasChanged](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a7d7a0e45d355883535175f060d150a25) +* [hide](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a39446dbc4a63268669450640360a10ca) +* [invalidate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac6dd084c61d7ce2631d207242eca89bf) +* [isInput](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a3b7b397239f04cf9ea9358f9477ee2c4) +* [isInputToComponent](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ad59d273bea1a7e02540520e9b4428264) +* [isInputToModel](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1af1da4c99c6359d527ad57c9433333a36) +* [isValid](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8b738f7eef3f9a3f8a723cede3809f47) +* [length](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af118bdf4b120050d6700a7ceae7f5bec) +* [numDimensions](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1abaa61cb129a23c20be499a61ec4c8443) +* [OwningComponent](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8c1ac6e84d73e34b12cc5e9397bb83a4) +* [precedentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a19c1ae9d08b968bae4b6fdd1ec74fc3e) +* [precedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a913272799193e5d02033c63c746ead9e) +* [setArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1addf446b647e3f8946e8e72825241e0d3) +* [setDimensions](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1aa3a9cdee8b632a3adda4e2d1814c66f8) +* [setLength](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ab20a6b27ddb532d0186532a52a148d91) +* [setMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a495551c5a05027a8537ffce75f333f8e) +* [setSize](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b7b41ca5463a86aecb2368d73464c0e) +* [setValue](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a34205a2be0ffe6695721d957cd90f963) +* [size](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4164bff5f32408083a55fc9a327ebc66) +* [toString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1aa735025db3ac6e13cb486f8629b86a69) +* [toStringAbsolute](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1adfb1dee0a1fd5b541eacba1e4cbba7ad) +* [toStringAbsoluteEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a3684e3b0b2d36a599f75236a6f5e90e7) +* [toStringEx](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a9013b29e3ca18c5a0ecaff8dc6d19b5f) +* [validate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a86b82bcfb1ccfa2428968307eaa07108) +* [value](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ae449bcebd78b7ec3fe365cd8fbd3dac7) +* [value](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1afd9e0eaba3274e5802f25fe40f039c16) + +## Properties + + +### Property hasChanged + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IStringArray::hasChanged +``` + + + + + + + +**Return type**: boolean + + +### Property hide + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IStringArray::hide +``` + + + + + + + +**Return type**: boolean + + +### Property OwningComponent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IStringArray::OwningComponent +``` + + + + + + + +**Return type**: LPDISPATCH + + +### Property size + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IStringArray::size +``` + + + + + + + +**Return type**: long + + +### Property numDimensions + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IStringArray::numDimensions +``` + + + + + + + +**Return type**: long + + +### Property description + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IStringArray::description +``` + + + +Description of the array. + + + +**Return type**: BSTR + + +### Property enumAliases + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IStringArray::enumAliases +``` + + + +Enumerated aliases of the array. + + + +**Return type**: BSTR + + +### Property enumValues + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IStringArray::enumValues +``` + + + +Enumerated values of the array. + + + +**Return type**: BSTR + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5578) + +``` +VARIANT ModelCenter::IStringArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9) +``` + + + +Value of an array element. + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + +**Returns**: + +The value. + + + +**Return type**: VARIANT + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5594) + +``` +BSTR ModelCenter::IStringArray::value( VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10)(VARIANT d1,[optional] VARIANT d2,[optional] VARIANT d3,[optional] VARIANT d4,[optional] VARIANT d5,[optional] VARIANT d6,[optional] VARIANT d7,[optional] VARIANT d8,[optional] VARIANT d9,[optional] VARIANT d10) +``` + + + +Value of an array element. + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). +* **newValue**: The new value. + + + +**Return type**: BSTR + +## Public functions + + +### Function isValid + +![][public] + +``` +boolean ModelCenter::IStringArray::isValid() +``` + + + +Finds out whether or not the array is valid. + + + + + + +**Returns**: + +yes(TRUE) or no(FALSE). + + + +**Return type**: boolean + +**Reimplements**: [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) + + +### Function validate + +![][public] + +``` +void ModelCenter::IStringArray::validate() +``` + + + +Causes the array to validate itself. + + + +**Return type**: void + +**Reimplements**: [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IStringArray::getName() +``` + + + +Gets the name of the array. + + + + + + +**Returns**: + +The name of the array. + + + +**Return type**: BSTR + +**Reimplements**: [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IStringArray::getFullName() +``` + + + +Gets the full ModelCenter path of the array. + + + + + + +**Returns**: + +The full ModelCenter path of the array. + + + +**Return type**: BSTR + +**Reimplements**: [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IStringArray::getType() +``` + + + +Gets the type of the array. + + + + + + +**Returns**: + +The type of the array as a string. + + + +**Return type**: BSTR + +**Reimplements**: [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) + + +### Function isInput + +![][public] + +``` +boolean ModelCenter::IStringArray::isInput() +``` + + + +Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1af1da4c99c6359d527ad57c9433333a36). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) + + +### Function toString + +![][public] + +``` +BSTR ModelCenter::IStringArray::toString() +``` + + + +Converts the array to a string, validating the array if necessary. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. + + + + + + +**Returns**: + +The converted string value of the array. + + + +**Return type**: BSTR + +**Reimplements**: [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) + + +### Function fromString + +![][public] + +``` +void ModelCenter::IStringArray::fromString(BSTR value) +``` + + + +Sets the value of the array from a specified string. For 1D arrays, the specification is of the form '1,2,3'.
+For nD arrays, the specification is of the form 'bounds[2,2,2] {1,2,3,4,5,6,7,8}'.
+String arrays may optionally have the elements quoted in the form 'bounds[2,3] {"a", "b,c", "d", "", "e", "f"}' + + + + + + +**Parameters**: + +* **value**: New value. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + +**Reimplements**: [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) + + +### Function toStringAbsolute + +![][public] + +``` +BSTR ModelCenter::IStringArray::toStringAbsolute() +``` + + + +Converts the array to a string. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. + + + + + + +**Returns**: + +The converted string value of the array. + + + +**Return type**: BSTR + +**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IStringArray::invalidate() +``` + + + +Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. + + + +**Return type**: void + +**Reimplements**: [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) + + +### Function directPrecedents + +![][public] + +``` +LPDISPATCH ModelCenter::IStringArray::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) + + +### Function directDependents + +![][public] + +``` +LPDISPATCH ModelCenter::IStringArray::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) + + +### Function precedentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IStringArray::precedentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) + + +### Function dependentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IStringArray::dependentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) + + +### Function precedents + +![][public] + +``` +LPDISPATCH ModelCenter::IStringArray::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) + + +### Function dependents + +![][public] + +``` +LPDISPATCH ModelCenter::IStringArray::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) + + +### Function isInputToComponent + +![][public] + +``` +boolean ModelCenter::IStringArray::isInputToComponent() +``` + + + +Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) + + +### Function isInputToModel + +![][public] + +``` +boolean ModelCenter::IStringArray::isInputToModel() +``` + + + +Checks whether or not the variable is an input. A linked input returns false (Output). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) + + +### Function setMetadata + +![][public] + +``` +void ModelCenter::IStringArray::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) +``` + + + +Sets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata specifier used to store the data. +* **type**:
+* **value**:
+* **access**:
+* **archive**:
+ + + +**Parameters**: + +* BSTR **name** +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** +* VARIANT **value** +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** +* boolean **archive** + +**Return type**: void + +**Reimplements**: [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) + + +### Function getMetadata + +![][public] + +``` +VARIANT ModelCenter::IStringArray::getMetadata(BSTR name) +``` + + + +Gets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata key name. + + +**Returns**: + +Metadata value. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +**Reimplements**: [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) + + +### Function toStringEx + +![][public] + +``` +BSTR ModelCenter::IStringArray::toStringEx(long index) +``` + + + +Converts the value of an array element to a string, validating the array if necessary. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The value of the element as a string. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + +**Reimplements**: [toStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a37c622ae9f50579f714ce98c0379cd98) + + +### Function fromStringEx + +![][public] + +``` +void ModelCenter::IStringArray::fromStringEx(BSTR value, long index) +``` + + + +Sets the value of an array element from a specified string. + + + + + + +**Parameters**: + +* **value**: New value. +* **index**: Index of the array element (0-based index). + + + +**Parameters**: + +* BSTR **value** +* long **index** + +**Return type**: void + +**Reimplements**: [fromStringEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad23f4082662c464be07251d6d1695a2d) + + +### Function toStringAbsoluteEx + +![][public] + +``` +BSTR ModelCenter::IStringArray::toStringAbsoluteEx(long index) +``` + + + +Converts the value of an array element to a string. + + + + + + +**Parameters**: + +* **index**: Index of the array element (0-based index). + + +**Returns**: + +The value of the element as a string. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + +**Reimplements**: [toStringAbsoluteEx](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a2e3041440581aab716c684fe88d2ee87) + + +### Function getLength + +![][public] + +``` +long ModelCenter::IStringArray::getLength([optional] VARIANT dim) +``` + + + +Get the length of the n'th dimension of the array. + + + + + + +**Parameters**: + +* **dim**: Dimension of the array to query. This uses a 0 based index, so 0 will give you the first dimension, 1 the second, etc. If omitted, gives the first dimension + + +**Returns**: + +Length(size) of the array. + + + +**Parameters**: + +* _[optional]_ VARIANT **dim** + +**Return type**: long + +**Reimplements**: [getLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8a6965fe1217428d63d594384a634bfb) + + +### Function setLength + +![][public] + +``` +void ModelCenter::IStringArray::setLength(long length, [optional] VARIANT dim) +``` + + + +Sets the length of the n'th dimension of the array + + + + + + +**Parameters**: + +* **length**: New length of the n'th dimension of the array +* **dim**: The dimension to set. This uses a 0 based index, so 0 will set the first dimension, 1 the second, etc. If omitted, sets the first dimension + + + +**Parameters**: + +* long **length** +* _[optional]_ VARIANT **dim** + +**Return type**: void + +**Reimplements**: [setLength](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ac632aa0e8bc7a6fcac41245e151beec8) + + +### Function setDimensions + +![][public] + +``` +void ModelCenter::IStringArray::setDimensions(long d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Sets the number of dimensions of an array and the length of each dimension in one call. An array initializes to 0 length. If any dimension of the array has 0 length, the whole array contains no data. You must set the array size before filling in values unless you are using the [setArray()](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1addf446b647e3f8946e8e72825241e0d3) call. + + + + + + +**Parameters**: + +* **d1**: length of the 1st dimension of the array +* **d2**: length of the 2nd dimension of the array. If omitted, the array is 1 dimensional +* **d3**: length of the 3rd dimension of the array. If omitted, the array is 2 dimensional +* **d4**: length of the 4th dimension of the array. If omitted, the array is 3 dimensional +* **d5**: length of the 5th dimension of the array. If omitted, the array is 4 dimensional +* **d6**: length of the 6th dimension of the array. If omitted, the array is 5 dimensional +* **d7**: length of the 7th dimension of the array. If omitted, the array is 6 dimensional +* **d8**: length of the 8th dimension of the array. If omitted, the array is 7 dimensional +* **d9**: length of the 9th dimension of the array. If omitted, the array is 8 dimensional +* **d10**: length of the 10th dimension of the array. If omitted, the array is 9 dimensional + + + +**Parameters**: + +* long **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: void + +**Reimplements**: [setDimensions](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af881060e37aae0ff4c2c2238683db950) + + +### Function getValue + +![][public] + +``` +BSTR ModelCenter::IStringArray::getValue(VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Gets the value of an array element. + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + +**Returns**: + +The value. + + + +**Parameters**: + +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: BSTR + + +### Function setValue + +![][public] + +``` +void ModelCenter::IStringArray::setValue(BSTR value, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Sets the value of an array element. + + + + + + +**Parameters**: + +* **value**: New value. +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + + +**Parameters**: + +* BSTR **value** +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: void + + +### Function getArray + +![][public] + +``` +VARIANT ModelCenter::IStringArray::getArray() +``` + + + +Gets the COM array. + + + + + + +**Returns**: + +The COM array. + + + +**Return type**: VARIANT + + +### Function setArray + +![][public] + +``` +void ModelCenter::IStringArray::setArray(VARIANT array) +``` + + + +Sets the COM array. + + + + + + +**Parameters**: + +* **array**: The COM array. + + + +**Parameters**: + +* VARIANT **array** + +**Return type**: void + + +### Function getValueAbsolute + +![][public] + +``` +BSTR ModelCenter::IStringArray::getValueAbsolute(VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10) +``` + + + +Gets the value of an array element without validating. + + + + + + +**Parameters**: + +* **d1**: Index in the 1st dimension (0-based index). +* **d2**: Index in the 2nd dimension (0-based index). +* **d3**: Index in the 3rd dimension (0-based index). +* **d4**: Index in the 4th dimension (0-based index). +* **d5**: Index in the 5th dimension (0-based index). +* **d6**: Index in the 6th dimension (0-based index). +* **d7**: Index in the 7th dimension (0-based index). +* **d8**: Index in the 8th dimension (0-based index). +* **d9**: Index in the 9th dimension (0-based index). +* **d10**: Index in the 10th dimension (0-based index). + + +**Returns**: + +The value. + + + +**Parameters**: + +* VARIANT **d1** +* _[optional]_ VARIANT **d2** +* _[optional]_ VARIANT **d3** +* _[optional]_ VARIANT **d4** +* _[optional]_ VARIANT **d5** +* _[optional]_ VARIANT **d6** +* _[optional]_ VARIANT **d7** +* _[optional]_ VARIANT **d8** +* _[optional]_ VARIANT **d9** +* _[optional]_ VARIANT **d10** + +**Return type**: BSTR + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IStringVariable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IStringVariable.md index c938358e8f..19ae91a688 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IStringVariable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IStringVariable.md @@ -1,869 +1,868 @@ - -# Interface ModelCenter::IStringVariable - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5687) - - - -COM Instance. - -**Inherits from**: - -* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) - -## Members - -* [dependentLinks](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a019771c2e685c90ef2b4f53a0a3acf7c) -* [dependents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6ce38d07c0dc470d96eec4077c2c38b8) -* [description](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1af60bf6fec0621b386c755c9adc5cf4b5) -* [directDependents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6cd07e865097669f307d3d8ee9ace1c1) -* [directPrecedents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a98031c7081831a57f35dcfd18bef2279) -* [enumAliases](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a55c58e3ba1d7b7b9985a32c8f9b88954) -* [enumValues](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a26a049d4c093a364a5e03c577b6937b1) -* [fromString](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a587cc7ce24785d0110b86ff815a68d89) -* [getFullName](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ac8c712e2b8f8136f59cffd1665d6cb5e) -* [getMetadata](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1aa094d1b1e7b20a631c92c9ec9d936d71) -* [getName](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a50cf9efbe23ed25a027f6df1d7132577) -* [getType](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a9468a019a8bfaaa771c5bf97e206ea5a) -* [hasChanged](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a846973fd74773de77e95f5a686059b8a) -* [hide](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1acd58e2a3356b8297a5cc491f5a3ce9ac) -* [invalidate](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a7b29d24168420440191f35e6ad382d03) -* [isInput](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a2268414421505ee4c0fb49de92953007) -* [isInputToComponent](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a940488ff3ad42baa064349a43fe9eac6) -* [isInputToModel](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a52f14ae0f304152748e0373e91701708) -* [isValid](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a16c6e45e1967f427b3a7123d7da384b1) -* [OwningComponent](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1aedaac8e1d883db0e5d9fa4f9ccd6403f) -* [precedentLinks](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6fcaecc0f0d1bdbd827e507ae1307fa4) -* [precedents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a4affcdc7391a9327db4c828e54c71703) -* [setInitialValue](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1af05313d1d5dce644dc1e0fb7217e18a0) -* [setMetadata](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ac5062f1a9bcf780f891c6abeb0bcb391) -* [toString](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a46f43be460cbd0d90493a6f9f26eb65d) -* [toStringAbsolute](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ae9ed673188c2c46e2c3883cdd65b3af5) -* [validate](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a7bddbd595f981680f8eb062d950f20d7) -* [value](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ab56992c6033247f7a5c262e63e728467) -* [valueAbsolute](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1abe143a72a2b1f663e41bf0af0118d5db) - -## Properties - - -### Property hasChanged - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IStringVariable::hasChanged -``` - - - - - - - -**Return type**: boolean - - -### Property hide - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IStringVariable::hide -``` - - - - - - - -**Return type**: boolean - - -### Property OwningComponent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IStringVariable::OwningComponent -``` - - - - - - - -**Return type**: LPDISPATCH - - -### Property value - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IStringVariable::value -``` - - - -Value of the variable. - - - -**Return type**: BSTR - - -### Property valueAbsolute - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IStringVariable::valueAbsolute -``` - - - -The value of the variable. (Fetched without attempting to validate) - - - -**Return type**: BSTR - - -### Property description - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IStringVariable::description -``` - - - -Description of the variable. - - - -**Return type**: BSTR - - -### Property enumValues - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IStringVariable::enumValues -``` - - - -Enumerated values of the variable. - - - -**Return type**: BSTR - - -### Property enumAliases - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IStringVariable::enumAliases -``` - - - -Enumerated aliases of the variable. - - - -**Return type**: BSTR - -## Public functions - - -### Function isValid - -![][public] - -``` -boolean ModelCenter::IStringVariable::isValid() -``` - - - -Returns whether or not the variable is valid. - - - - - - -**Returns**: - -True if variable is valid. False if the variable is not valid. - - - -**Return type**: boolean - -**Reimplements**: [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) - - -### Function validate - -![][public] - -``` -void ModelCenter::IStringVariable::validate() -``` - - - -Validates the variable by running the component if needed. - - - -**Return type**: void - -**Reimplements**: [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IStringVariable::getName() -``` - - - -Gets the name of the variable. - - - - - - -**Returns**: - -The name of the variable. - - - -**Return type**: BSTR - -**Reimplements**: [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IStringVariable::getFullName() -``` - - - -Gets the full ModelCenter path of the variable. - - - - - - -**Returns**: - -The full ModelCenter path of the variable. - - - -**Return type**: BSTR - -**Reimplements**: [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IStringVariable::getType() -``` - - - -Gets the type of the variable. - - - - - - -**Returns**: - -The type of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) - - -### Function isInput - -![][public] - -``` -boolean ModelCenter::IStringVariable::isInput() -``` - - - -Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a52f14ae0f304152748e0373e91701708). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) - - -### Function toString - -![][public] - -``` -BSTR ModelCenter::IStringVariable::toString() -``` - - - -Converts the variable value to a string, validating the variable if necessary. - - - - - - -**Returns**: - -The value of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) - - -### Function fromString - -![][public] - -``` -void ModelCenter::IStringVariable::fromString(BSTR value) -``` - - - -Sets the value of the variable from the specified string. - - - - - - -**Parameters**: - -* **value**: New value. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - -**Reimplements**: [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) - - -### Function toStringAbsolute - -![][public] - -``` -BSTR ModelCenter::IStringVariable::toStringAbsolute() -``` - - - -Converts the value of the variable to a string. - - - - - - -**Returns**: - -The value of the variable as a string. - - - -**Return type**: BSTR - -**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IStringVariable::invalidate() -``` - - - -Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. - - - -**Return type**: void - -**Reimplements**: [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) - - -### Function directPrecedents - -![][public] - -``` -LPDISPATCH ModelCenter::IStringVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) - - -### Function directDependents - -![][public] - -``` -LPDISPATCH ModelCenter::IStringVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) - - -### Function precedentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IStringVariable::precedentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) - - -### Function dependentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IStringVariable::dependentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) - - -### Function precedents - -![][public] - -``` -LPDISPATCH ModelCenter::IStringVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) - - -### Function dependents - -![][public] - -``` -LPDISPATCH ModelCenter::IStringVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplements**: [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) - - -### Function isInputToComponent - -![][public] - -``` -boolean ModelCenter::IStringVariable::isInputToComponent() -``` - - - -Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) - - -### Function isInputToModel - -![][public] - -``` -boolean ModelCenter::IStringVariable::isInputToModel() -``` - - - -Checks whether or not the variable is an input. A linked input returns false (Output). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) - - -### Function setMetadata - -![][public] - -``` -void ModelCenter::IStringVariable::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) -``` - - - -Sets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata specifier used to store the data. -* **type**:
-* **value**:
-* **access**:
-* **archive**:
- - - -**Parameters**: - -* BSTR **name** -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** -* VARIANT **value** -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** -* boolean **archive** - -**Return type**: void - -**Reimplements**: [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) - - -### Function getMetadata - -![][public] - -``` -VARIANT ModelCenter::IStringVariable::getMetadata(BSTR name) -``` - - - -Gets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata key name. - - -**Returns**: - -Metadata value. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -**Reimplements**: [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) - - -### Function setInitialValue - -![][public] - -``` -void ModelCenter::IStringVariable::setInitialValue(BSTR value) -``` - - - -Sets the initial value of the variable. - - - - - - -**Parameters**: - -* **value**: Initial value. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IStringVariable + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5687) + + + +COM Instance. + +**Inherits from**: + +* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) + +## Members + +* [dependentLinks](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a019771c2e685c90ef2b4f53a0a3acf7c) +* [dependents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6ce38d07c0dc470d96eec4077c2c38b8) +* [description](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1af60bf6fec0621b386c755c9adc5cf4b5) +* [directDependents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6cd07e865097669f307d3d8ee9ace1c1) +* [directPrecedents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a98031c7081831a57f35dcfd18bef2279) +* [enumAliases](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a55c58e3ba1d7b7b9985a32c8f9b88954) +* [enumValues](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a26a049d4c093a364a5e03c577b6937b1) +* [fromString](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a587cc7ce24785d0110b86ff815a68d89) +* [getFullName](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ac8c712e2b8f8136f59cffd1665d6cb5e) +* [getMetadata](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1aa094d1b1e7b20a631c92c9ec9d936d71) +* [getName](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a50cf9efbe23ed25a027f6df1d7132577) +* [getType](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a9468a019a8bfaaa771c5bf97e206ea5a) +* [hasChanged](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a846973fd74773de77e95f5a686059b8a) +* [hide](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1acd58e2a3356b8297a5cc491f5a3ce9ac) +* [invalidate](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a7b29d24168420440191f35e6ad382d03) +* [isInput](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a2268414421505ee4c0fb49de92953007) +* [isInputToComponent](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a940488ff3ad42baa064349a43fe9eac6) +* [isInputToModel](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a52f14ae0f304152748e0373e91701708) +* [isValid](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a16c6e45e1967f427b3a7123d7da384b1) +* [OwningComponent](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1aedaac8e1d883db0e5d9fa4f9ccd6403f) +* [precedentLinks](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6fcaecc0f0d1bdbd827e507ae1307fa4) +* [precedents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a4affcdc7391a9327db4c828e54c71703) +* [setInitialValue](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1af05313d1d5dce644dc1e0fb7217e18a0) +* [setMetadata](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ac5062f1a9bcf780f891c6abeb0bcb391) +* [toString](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a46f43be460cbd0d90493a6f9f26eb65d) +* [toStringAbsolute](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ae9ed673188c2c46e2c3883cdd65b3af5) +* [validate](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a7bddbd595f981680f8eb062d950f20d7) +* [value](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ab56992c6033247f7a5c262e63e728467) +* [valueAbsolute](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1abe143a72a2b1f663e41bf0af0118d5db) + +## Properties + + +### Property hasChanged + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IStringVariable::hasChanged +``` + + + + + + + +**Return type**: boolean + + +### Property hide + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IStringVariable::hide +``` + + + + + + + +**Return type**: boolean + + +### Property OwningComponent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IStringVariable::OwningComponent +``` + + + + + + + +**Return type**: LPDISPATCH + + +### Property value + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IStringVariable::value +``` + + + +Value of the variable. + + + +**Return type**: BSTR + + +### Property valueAbsolute + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IStringVariable::valueAbsolute +``` + + + +The value of the variable. (Fetched without attempting to validate) + + + +**Return type**: BSTR + + +### Property description + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IStringVariable::description +``` + + + +Description of the variable. + + + +**Return type**: BSTR + + +### Property enumValues + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IStringVariable::enumValues +``` + + + +Enumerated values of the variable. + + + +**Return type**: BSTR + + +### Property enumAliases + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IStringVariable::enumAliases +``` + + + +Enumerated aliases of the variable. + + + +**Return type**: BSTR + +## Public functions + + +### Function isValid + +![][public] + +``` +boolean ModelCenter::IStringVariable::isValid() +``` + + + +Returns whether or not the variable is valid. + + + + + + +**Returns**: + +True if variable is valid. False if the variable is not valid. + + + +**Return type**: boolean + +**Reimplements**: [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) + + +### Function validate + +![][public] + +``` +void ModelCenter::IStringVariable::validate() +``` + + + +Validates the variable by running the component if needed. + + + +**Return type**: void + +**Reimplements**: [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IStringVariable::getName() +``` + + + +Gets the name of the variable. + + + + + + +**Returns**: + +The name of the variable. + + + +**Return type**: BSTR + +**Reimplements**: [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IStringVariable::getFullName() +``` + + + +Gets the full ModelCenter path of the variable. + + + + + + +**Returns**: + +The full ModelCenter path of the variable. + + + +**Return type**: BSTR + +**Reimplements**: [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IStringVariable::getType() +``` + + + +Gets the type of the variable. + + + + + + +**Returns**: + +The type of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) + + +### Function isInput + +![][public] + +``` +boolean ModelCenter::IStringVariable::isInput() +``` + + + +Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a52f14ae0f304152748e0373e91701708). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) + + +### Function toString + +![][public] + +``` +BSTR ModelCenter::IStringVariable::toString() +``` + + + +Converts the variable value to a string, validating the variable if necessary. + + + + + + +**Returns**: + +The value of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) + + +### Function fromString + +![][public] + +``` +void ModelCenter::IStringVariable::fromString(BSTR value) +``` + + + +Sets the value of the variable from the specified string. + + + + + + +**Parameters**: + +* **value**: New value. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + +**Reimplements**: [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) + + +### Function toStringAbsolute + +![][public] + +``` +BSTR ModelCenter::IStringVariable::toStringAbsolute() +``` + + + +Converts the value of the variable to a string. + + + + + + +**Returns**: + +The value of the variable as a string. + + + +**Return type**: BSTR + +**Reimplements**: [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IStringVariable::invalidate() +``` + + + +Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. + + + +**Return type**: void + +**Reimplements**: [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) + + +### Function directPrecedents + +![][public] + +``` +LPDISPATCH ModelCenter::IStringVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) + + +### Function directDependents + +![][public] + +``` +LPDISPATCH ModelCenter::IStringVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) + + +### Function precedentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IStringVariable::precedentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) + + +### Function dependentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IStringVariable::dependentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) + + +### Function precedents + +![][public] + +``` +LPDISPATCH ModelCenter::IStringVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) + + +### Function dependents + +![][public] + +``` +LPDISPATCH ModelCenter::IStringVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplements**: [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) + + +### Function isInputToComponent + +![][public] + +``` +boolean ModelCenter::IStringVariable::isInputToComponent() +``` + + + +Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) + + +### Function isInputToModel + +![][public] + +``` +boolean ModelCenter::IStringVariable::isInputToModel() +``` + + + +Checks whether or not the variable is an input. A linked input returns false (Output). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplements**: [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) + + +### Function setMetadata + +![][public] + +``` +void ModelCenter::IStringVariable::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) +``` + + + +Sets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata specifier used to store the data. +* **type**:
+* **value**:
+* **access**:
+* **archive**:
+ + + +**Parameters**: + +* BSTR **name** +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** +* VARIANT **value** +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** +* boolean **archive** + +**Return type**: void + +**Reimplements**: [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) + + +### Function getMetadata + +![][public] + +``` +VARIANT ModelCenter::IStringVariable::getMetadata(BSTR name) +``` + + + +Gets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata key name. + + +**Returns**: + +Metadata value. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +**Reimplements**: [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) + + +### Function setInitialValue + +![][public] + +``` +void ModelCenter::IStringVariable::setInitialValue(BSTR value) +``` + + + +Sets the initial value of the variable. + + + + + + +**Parameters**: + +* **value**: Initial value. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ITradeStudyEvents.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ITradeStudyEvents.md index f6f892ea9d..b3e76f86bb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ITradeStudyEvents.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1ITradeStudyEvents.md @@ -1,99 +1,98 @@ - -# Interface ModelCenter::ITradeStudyEvents - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 4956) - - - -Event functions that ModelCenter can send. - -## Members - -* [EndToolRun](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1a2fd4f50429de83a6469ff4146c2202eb) -* [ModelXMLExtensionsChanged](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1a09c0d68be95fb162874e4da3d0965749) -* [StartToolRun](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1a4bd376f4406023fdb8c562c3e530e32c) -* [ToolClosed](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1aceebb769e27511c9b87462b8fa9ef16f) - -## Public functions - - -### Function StartToolRun - -![][public] - -``` -void ModelCenter::ITradeStudyEvents::StartToolRun() -``` - - - -Function that is called when a trade study has started its run. - - - -**Return type**: void - - -### Function EndToolRun - -![][public] - -``` -void ModelCenter::ITradeStudyEvents::EndToolRun() -``` - - - -Function that is called when a trade study has finished running. - - - -**Return type**: void - - -### Function ToolClosed - -![][public] - -``` -void ModelCenter::ITradeStudyEvents::ToolClosed(BSTR type) -``` - - - -Function that is called when a trade study has closed. -**Parameters**: - -* **type**: the trade study type that was closed. - - - -**Parameters**: - -* BSTR **type** - -**Return type**: void - - -### Function ModelXMLExtensionsChanged - -![][public] - -``` -void ModelCenter::ITradeStudyEvents::ModelXMLExtensionsChanged() -``` - - - -This event is raised whenever the XML extensions for the main model are changed. This may indicate that a trade study tool has saved its favorites. - - - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::ITradeStudyEvents + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 4956) + + + +Event functions that ModelCenter can send. + +## Members + +* [EndToolRun](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1a2fd4f50429de83a6469ff4146c2202eb) +* [ModelXMLExtensionsChanged](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1a09c0d68be95fb162874e4da3d0965749) +* [StartToolRun](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1a4bd376f4406023fdb8c562c3e530e32c) +* [ToolClosed](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents_1aceebb769e27511c9b87462b8fa9ef16f) + +## Public functions + + +### Function StartToolRun + +![][public] + +``` +void ModelCenter::ITradeStudyEvents::StartToolRun() +``` + + + +Function that is called when a trade study has started its run. + + + +**Return type**: void + + +### Function EndToolRun + +![][public] + +``` +void ModelCenter::ITradeStudyEvents::EndToolRun() +``` + + + +Function that is called when a trade study has finished running. + + + +**Return type**: void + + +### Function ToolClosed + +![][public] + +``` +void ModelCenter::ITradeStudyEvents::ToolClosed(BSTR type) +``` + + + +Function that is called when a trade study has closed. +**Parameters**: + +* **type**: the trade study type that was closed. + + + +**Parameters**: + +* BSTR **type** + +**Return type**: void + + +### Function ModelXMLExtensionsChanged + +![][public] + +``` +void ModelCenter::ITradeStudyEvents::ModelXMLExtensionsChanged() +``` + + + +This event is raised whenever the XML extensions for the main model are changed. This may indicate that a trade study tool has saved its favorites. + + + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariable.md index e9f1fa30a2..17378feb33 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariable.md @@ -1,1075 +1,1074 @@ - -# Interface ModelCenter::IVariable - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5769) - - - -COM instance. - -**Inherited by**: - -* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) -* [ModelCenter::IBooleanVariable](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable) -* [ModelCenter::IDoubleVariable](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable) -* [ModelCenter::IFileVariable](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable) -* [ModelCenter::IGeometryVariable](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable) -* [ModelCenter::IIntegerVariable](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable) -* [ModelCenter::IObjectVariable](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable) -* [ModelCenter::IReferenceVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable) -* [ModelCenter::IStringVariable](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable) - -## Members - -* [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) -* [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) -* [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) -* [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) -* [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) -* [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) -* [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) -* [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) -* [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) -* [hasChanged](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a70aa745d819120f3f13d8f5cac099e44) -* [hide](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a2b79ae605f5b5864f5470d730a845f7c) -* [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) -* [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) -* [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) -* [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) -* [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) -* [OwningComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a2b61c0eea38b2b20a08b75041dc20f63) -* [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) -* [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) -* [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) -* [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) -* [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) -* [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) - -## Properties - - -### Property hasChanged - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IVariable::hasChanged -``` - - - -Boolean which indicates if the variable has changed since the last time the boolean was reset. Typically used only by Plug-Ins for their own variables (to avoid conflicting use by different Plug-Ins , macros, or tools). Set the value to false and it will automatically flip to true any time the value changes. - - - -**Return type**: boolean - - -### Property hide - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IVariable::hide -``` - - - -Hides the variable from the User Interface. Variable will not be visible in Component Tree, Data Explorer, or Data Monitors. - - - -**Return type**: boolean - - -### Property OwningComponent - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -LPDISPATCH ModelCenter::IVariable::OwningComponent -``` - - - -Gets the component that owns this variable. - - - - - - -**Returns**: - -IDispatch* to an [IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) object. - - - -**Return type**: LPDISPATCH - -## Public functions - - -### Function isValid - -![][public] - -``` -boolean ModelCenter::IVariable::isValid() -``` - - - -Returns whether or not the variable is valid. - - - - - - -**Returns**: - -True if variable is valid. False if the variable is not valid. - - - -**Return type**: boolean - -**Reimplemented by**: - -* [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) -* [isValid](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d13fb275a266aa85280b6beed8be176) -* [isValid](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a877899b0c2bcc8400bcd8cfa31c4eb7a) -* [isValid](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a4d7719052c0b341f91436d3a0da270cc) -* [isValid](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1b873587774671d25664c294323beae8) -* [isValid](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a88a80a771329337246e883b3ce034400) -* [isValid](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a1d3371b70abb06b2eff5d1ada8aa114f) -* [isValid](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2d8ceabbeb9640dffb9f6a9e654bbd79) -* [isValid](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a01fe29466d2371dd25e6d9a473de32c7) -* [isValid](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ab3d891c3978182e073923a56b4dbe89b) -* [isValid](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ae03686387c15bc80d2caec8c3a5a913f) -* [isValid](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a366cf132edcae4c78ff3c3c29d81ad03) -* [isValid](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1adbc66e2276350867c0b977bf5cf192cf) -* [isValid](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8b738f7eef3f9a3f8a723cede3809f47) -* [isValid](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a16c6e45e1967f427b3a7123d7da384b1) - - -### Function validate - -![][public] - -``` -void ModelCenter::IVariable::validate() -``` - - - -Validates the variable by running the component if needed. - - - -**Return type**: void - -**Reimplemented by**: - -* [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) -* [validate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa221cef15629c5acf569329c0e089b3a) -* [validate](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ae3cb5f6c787efb879f5d85a5ee5ee344) -* [validate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1abc755512c485531a61f10d2bc5d691b0) -* [validate](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1abddc8770d26e37ac9319be5b90bc6e3e) -* [validate](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a56e476d33f05ee8b4faa077396704fa6) -* [validate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a506a66d66cb52b49d7385351bf0cfa46) -* [validate](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa3fdf5883f1849f93bf87256b9100d0b) -* [validate](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a62715d2cd23f7a7daafe7568d1a6e32d) -* [validate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a84ab133f5b1147d475fb8e2c4275b32b) -* [validate](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a2807c2dd1e70fe7d8eab0af0a64e2d74) -* [validate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1af1dd28c351fcda3e3fea31facbd4fca3) -* [validate](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a16aec4b64f98c5dfb3f66c497691e447) -* [validate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a86b82bcfb1ccfa2428968307eaa07108) -* [validate](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a7bddbd595f981680f8eb062d950f20d7) - - -### Function getName - -![][public] - -``` -BSTR ModelCenter::IVariable::getName() -``` - - - -Gets the name of the variable. - - - - - - -**Returns**: - -The name of the variable. - - - -**Return type**: BSTR - -**Reimplemented by**: - -* [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) -* [getName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a471100848db5a6f0c08f2920aa283ac6) -* [getName](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ac4595a4a7f2b81c6c5c2f1f5e3742f56) -* [getName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe2789906f30f6a082e5d3d79e2b5bbc) -* [getName](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a10978bbb428eadf01141d2ceb2373c7a) -* [getName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1ec0c0bce4884b2c8c1decf29f4d5b86) -* [getName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a3f04f85ebe4f50a88c7cc3a61ae597f6) -* [getName](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1adbaa029c76034043ccdf2bf84bbd0e7f) -* [getName](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a2ab57d435f315c7afc7bed802b57d9d0) -* [getName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a79fdcc3e290b4b0df816f69d8a8d5f9d) -* [getName](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abcd09429d47c396bab6dc63690e1a1c1) -* [getName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a282d98574e8d65d85c9908b6799321b7) -* [getName](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa01b77111d4a975cc12ca3e0a16d845b) -* [getName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a0a90870618bd396edc53c27ff0b8c9af) -* [getName](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a50cf9efbe23ed25a027f6df1d7132577) - - -### Function getFullName - -![][public] - -``` -BSTR ModelCenter::IVariable::getFullName() -``` - - - -Gets the full ModelCenter path of the variable. - - - - - - -**Returns**: - -The full ModelCenter path of the variable. - - - -**Return type**: BSTR - -**Reimplemented by**: - -* [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) -* [getFullName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a498741fde4d9eeec6eb3f8171e3161d8) -* [getFullName](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a19c8cfbcba0c9fc8eaae14bfaaa07d39) -* [getFullName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a225331135b6efad1b05c399869975962) -* [getFullName](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a00a7eca52d31c8f86e049dc1896d2434) -* [getFullName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7d1acdd7a964ceb7d189c87a19e9bcb3) -* [getFullName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7aada275954e2fff6bdea69b8a96bd0c) -* [getFullName](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a5b0b8db5aec4ebfbd8e7918568c71b70) -* [getFullName](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a0b0e9f581b1b038395dacb2700d82ce4) -* [getFullName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a8c74276fefc00a8b85a576e1d1b58053) -* [getFullName](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a6bbb377e1c98a99b660cfdfa3c61f191) -* [getFullName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a44ebe17869a3b1b95568ea46299a9f3f) -* [getFullName](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3e427b90dbf2f763c2486cdd774c2d49) -* [getFullName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4ca185e60b69ce2ff41d19a2270bc28b) -* [getFullName](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ac8c712e2b8f8136f59cffd1665d6cb5e) - - -### Function getType - -![][public] - -``` -BSTR ModelCenter::IVariable::getType() -``` - - - -Gets the type of the variable. - - - - - - -**Returns**: - -The type of the variable as a string. - - - -**Return type**: BSTR - -**Reimplemented by**: - -* [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) -* [getType](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad8d2b43dd9f4b3656dba1e8570f7f747) -* [getType](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a6e68844292a9f0b5e1924728465d02c0) -* [getType](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a59535b93acdadae5c47ebb3f148cc8a7) -* [getType](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a974708d2da959d48ee301088918719fd) -* [getType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a40cc49ff4f6fd51695549d4ad32a4384) -* [getType](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a6614c3d1ae621d218762e8ed8ec58222) -* [getType](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aec7c7bb8f9e43d411c457d7b091e5378) -* [getType](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a09f10acb36a75c48c2cce4f1925acb55) -* [getType](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a05e311dcfb051f0df6afc99dd01d6773) -* [getType](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a38de94bbe44275b88d92522926b1a841) -* [getType](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac3c3f33a239fe1182da434d7570346df) -* [getType](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ab946d679180e3e65433c8b4b2d61d39e) -* [getType](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a582f9e8e47e60eca8041b98c996a4f4f) -* [getType](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a9468a019a8bfaaa771c5bf97e206ea5a) - - -### Function isInput - -![][public] - -``` -boolean ModelCenter::IVariable::isInput() -``` - - - -Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplemented by**: - -* [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) -* [isInput](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa87e846de03852ee40e909935c2ec470) -* [isInput](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ab8445c95fe06a4eb82ed55034c26d34e) -* [isInput](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa0a3e17384092dbeb0cef004db873191) -* [isInput](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a162bb6a2a0c8cf5a2f3ee15daaaf85c2) -* [isInput](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1adb2ffa6d382f3874d63cab8c53f956c6) -* [isInput](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9e45ea90908321e84979e5b8d2f50357) -* [isInput](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a92363045c1f3285c5c1127ad149c0250) -* [isInput](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a8c9a1d489060c768242c74b57e85aec2) -* [isInput](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a3752394336c9689384efac1005422431) -* [isInput](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ab441aa413516cf14c082aa39801250c4) -* [isInput](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ae7e5c76cfd592a71fc7e5785c7cf6394) -* [isInput](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa61fe715fadff86e98c35d4bf6aa16e0) -* [isInput](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a3b7b397239f04cf9ea9358f9477ee2c4) -* [isInput](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a2268414421505ee4c0fb49de92953007) - - -### Function toString - -![][public] - -``` -BSTR ModelCenter::IVariable::toString() -``` - - - -Converts the variable value to a string, validating the variable if necessary. - - - - - - -**Returns**: - -The value of the variable as a string. - - - -**Return type**: BSTR - -**Reimplemented by**: - -* [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) -* [toString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a39294beb6d830e498ee8aca7a25cc4a6) -* [toString](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a97263640728fae5de92a272345ce0a01) -* [toString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1af417ef0e71fabce8379be30e4d176355) -* [toString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a59f1d75b8e24323ea9bf523159f04f69) -* [toString](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acc675e2c9045387d4ceb956d7d7d9f70) -* [toString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7ba909789490822b7ab12891075a9e56) -* [toString](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ae28a776965df5807d9ce8b2e0d995867) -* [toString](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a0bda0cd0ea97014dc4be4ee2af69e55c) -* [toString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a83e5e9905df758b37c901bae5e87430e) -* [toString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a2ec6bbef037c4c0a6ab5e510f9063923) -* [toString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aaa37debc6216a5419715e0c542555850) -* [toString](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a6675d6a6451c20b11b43ad594af28bcc) -* [toString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1aa735025db3ac6e13cb486f8629b86a69) -* [toString](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a46f43be460cbd0d90493a6f9f26eb65d) - - -### Function fromString - -![][public] - -``` -void ModelCenter::IVariable::fromString(BSTR value) -``` - - - -Sets the value of the variable from the specified string. - - - - - - -**Parameters**: - -* **value**: New value. - - - -**Parameters**: - -* BSTR **value** - -**Return type**: void - -**Reimplemented by**: - -* [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) -* [fromString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1af5d6c192774673f4f4bf7514b35f8ccf) -* [fromString](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a8b9fd88143b7b23e5f3ae9e229774a2b) -* [fromString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3faefed33c99ee3ffb10b5e0e21d239a) -* [fromString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1128d6c344adde4e9f9d95b0c19f87b9) -* [fromString](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aca195574fffbfac6577eb4b0d54f3dd8) -* [fromString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab107312b8a5b1e8e96ae2a3678ef9897) -* [fromString](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac7654e743af45785904858d2c581058d) -* [fromString](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a710bd007c2d1df9c861a33a397c7a9d7) -* [fromString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af3d5cd8601c1227d439b7b3f74cc2d16) -* [fromString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a180292624fd43a95348bd496b0fee8a6) -* [fromString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9cb9dab871b4e86ed66fb53cc5473ebd) -* [fromString](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa52a8fe2a76861302ee8ab0f8f3a614c) -* [fromString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a65a839b63dfb0495f577bf70ca87a320) -* [fromString](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a587cc7ce24785d0110b86ff815a68d89) - - -### Function toStringAbsolute - -![][public] - -``` -BSTR ModelCenter::IVariable::toStringAbsolute() -``` - - - -Converts the value of the variable to a string. - - - - - - -**Returns**: - -The value of the variable as a string. - - - -**Return type**: BSTR - -**Reimplemented by**: - -* [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) -* [toStringAbsolute](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa07f73fa1f449045d77725b0fef00739) -* [toStringAbsolute](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ad3fdc29d883580eaf57b83a7b796c703) -* [toStringAbsolute](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1adbd82fbad4622d8c2d91533d536a7ea0) -* [toStringAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a89797e61eedee333bd67b55b653ec21f) -* [toStringAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af042cdd3c4908daa767f6b0dce043e75) -* [toStringAbsolute](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ac8f43fca8b974b224bd64a78bd3bdda3) -* [toStringAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a0dda099769e13bdd8c5c076fc7d9378a) -* [toStringAbsolute](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a711f2c70a30362b587b39f5cd3775f71) -* [toStringAbsolute](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5bc139ce096dbc917734386869a3be78) -* [toStringAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac13b9c8e85a30831a81cedcdca610e01) -* [toStringAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a1a0ecbbccb3fe3404c79976e9f07b8db) -* [toStringAbsolute](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a510fd4577f2a29cf0fef6d1c8fe43c94) -* [toStringAbsolute](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1adfb1dee0a1fd5b541eacba1e4cbba7ad) -* [toStringAbsolute](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ae9ed673188c2c46e2c3883cdd65b3af5) - - -### Function invalidate - -![][public] - -``` -void ModelCenter::IVariable::invalidate() -``` - - - -Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. - - - -**Return type**: void - -**Reimplemented by**: - -* [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) -* [invalidate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a04e162fdfae6e99e6dcfd926adfca7b1) -* [invalidate](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a1eecc6708b4fb8e29bfe73ead410adaa) -* [invalidate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a032e132c6c6a61f81370942921ab2edf) -* [invalidate](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a9abf6ea522bbff16d7c2266202b5bdae) -* [invalidate](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aff411bdfa6a95ccc904878f1ffecba6b) -* [invalidate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7599948212f77bb66f8ef42fc98e53ce) -* [invalidate](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2beb5e20db0843a92acf8d0cc961e3af) -* [invalidate](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ac80cc84f95b559145c98a82367649d89) -* [invalidate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a521514c594a1ab4e30669305585530b7) -* [invalidate](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a07f62e68cae660a8bea1d1e31d754fcf) -* [invalidate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a56ea1d83eb42dda4a7c06b6fbbf6ffd5) -* [invalidate](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3a460ef81527173ce0c272d2bdf69da6) -* [invalidate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac6dd084c61d7ce2631d207242eca89bf) -* [invalidate](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a7b29d24168420440191f35e6ad382d03) - - -### Function directPrecedents - -![][public] - -``` -LPDISPATCH ModelCenter::IVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplemented by**: - -* [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) -* [directPrecedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a605c25813e75d1709e364eef080f68e9) -* [directPrecedents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ae54cdcd132e22278b8ddb00aaff236c7) -* [directPrecedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3ab4fe76950c76fbdd2e76ea3f4fb08b) -* [directPrecedents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a7a14b5ef10935109b178062205b91b7a) -* [directPrecedents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aac5eb818fb62f131d6ecb13fd3f6aa34) -* [directPrecedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9f84f73f3b65f16fa507678c53c67527) -* [directPrecedents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aea8561351c3ff1e003d463616682a838) -* [directPrecedents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a8294d8120195193f3a5fba86abcded57) -* [directPrecedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae3879cd50b0512f2b5660765393bd24e) -* [directPrecedents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a5c99fbda3111d689db126a61e0727106) -* [directPrecedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aa8041fca418266f2bee129804654abab) -* [directPrecedents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0e11aede2642dd050f0c5254a36b4a71) -* [directPrecedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a40c76b900187ef244f14c5c8e9bb65bf) -* [directPrecedents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a98031c7081831a57f35dcfd18bef2279) - - -### Function directDependents - -![][public] - -``` -LPDISPATCH ModelCenter::IVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplemented by**: - -* [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) -* [directDependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a6ed20fe44044c682471c7066ae2bd303) -* [directDependents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a40dedf6b7b841a6699d545ea058ad2cd) -* [directDependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe14e74990edda2c656035bbcd8e2af2) -* [directDependents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a6178082dc3de5e1f6665f4faebcb8c36) -* [directDependents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af1b4238d92307aa3586b4f7070e497be) -* [directDependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab61572acbd0617f5c51b04b2ae4bbdba) -* [directDependents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a9347c073e1dc6ca62f1b3c7cd6fbec71) -* [directDependents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a06be08cd5896250dc5b31ec3d90b79e6) -* [directDependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a44b3a3cc73cd46ea7661e776b20b4ded) -* [directDependents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ad783a3a7e231dd0aa00b869699a5bca4) -* [directDependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a862a4306dbf867e3db316d9547cea277) -* [directDependents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a24fa52bf29a92c4f1d6a79e2991e9ae5) -* [directDependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4820176e7ca9e1c3173d602308144c62) -* [directDependents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6cd07e865097669f307d3d8ee9ace1c1) - - -### Function precedentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IVariable::precedentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplemented by**: - -* [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) -* [precedentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a428a6e6a2a2be52d77bfe96323fea64f) -* [precedentLinks](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ab5b740c028c3b878f1341efea2df0116) -* [precedentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a640715d1e272c8f15d8cc4c2b466d990) -* [precedentLinks](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a8bf056e8b989223191b2e8c7595c0753) -* [precedentLinks](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a25a478d55d4855cdbf4f8753b6cd6062) -* [precedentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a998c2f1327219560aacd3d65d2c178b6) -* [precedentLinks](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a4bc52bbf01e5d0a0f95e67e03cce4547) -* [precedentLinks](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a42168bcdab0805055df8432194d5654c) -* [precedentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ac71c9a184e57f627b336438de0b7a238) -* [precedentLinks](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a02a977781b36247895725b38a725dca9) -* [precedentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a084d49d02b9ff5812166721fcdc86018) -* [precedentLinks](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ac4f846dce2494b7c4a9b8482af321c96) -* [precedentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a19c1ae9d08b968bae4b6fdd1ec74fc3e) -* [precedentLinks](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6fcaecc0f0d1bdbd827e507ae1307fa4) - - -### Function dependentLinks - -![][public] - -``` -LPDISPATCH ModelCenter::IVariable::dependentLinks([optional]VARIANT reserved) -``` - - - -Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. - - - - - - -**Parameters**: - -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplemented by**: - -* [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) -* [dependentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1abadb81820fd0b415fa9e78ce6c867c55) -* [dependentLinks](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a69e716f024970454d8c555c73df17360) -* [dependentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a0201276e7d000c4869e4798cfdb68d8b) -* [dependentLinks](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a385019a97e3ddbae4351fd6dd591a49c) -* [dependentLinks](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af52780ea6b4984f40b16c8c072e1b005) -* [dependentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a90373b06919789f06f52dd22a0339847) -* [dependentLinks](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a46a1da5e2a3f39c2e413b520ec33407f) -* [dependentLinks](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a50e3d7ea1d97cd799c29901c2b563208) -* [dependentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a399b9b49ca3133d2a49923637f19609a) -* [dependentLinks](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a1328684b4767a3ee6b006feca4f0296d) -* [dependentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1add9bd8c41cd4a5c77f7e762768b441a5) -* [dependentLinks](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a4c704741da375408b052eeddc6ed90dc) -* [dependentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4227d6aca4e2d7791cea69efeb5b81fd) -* [dependentLinks](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a019771c2e685c90ef2b4f53a0a3acf7c) - - -### Function precedents - -![][public] - -``` -LPDISPATCH ModelCenter::IVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplemented by**: - -* [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) -* [precedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d7349a2273e5b9eaaab5271918eed6f) -* [precedents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1aa43bd8ee475029fc466b20cd3b1b686d) -* [precedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a5973cfc6b1e41db214568a7e95979eef) -* [precedents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac65d0d53de6aee17106700d60161e9cf) -* [precedents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a8c987c7df5766ca31115f25ce36f1f91) -* [precedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1abf61619be1e057cf2c42189456169041) -* [precedents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a8db95046419c83467475175b216efe84) -* [precedents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a6d516295359de158c45bf2a5c0378af0) -* [precedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a01bd8fce84abbb243a9f7e3c771c185c) -* [precedents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a902fe35d10c8e25b86a64e13953a62f1) -* [precedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aea1973c58e45bafe3aeea797b91a4f6b) -* [precedents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ae2d07bb6bf73c064a1a492bb6ff2806a) -* [precedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a913272799193e5d02033c63c746ead9e) -* [precedents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a4affcdc7391a9327db4c828e54c71703) - - -### Function dependents - -![][public] - -``` -LPDISPATCH ModelCenter::IVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) -``` - - - -Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. - - - - - - -**Parameters**: - -* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. -* **reserved**: Reserved for future use. - - -**Returns**: - -IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. - - - -**Parameters**: - -* _[optional]_ VARIANT **followSuspended** -* _[optional]_ VARIANT **reserved** - -**Return type**: LPDISPATCH - -**Reimplemented by**: - -* [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) -* [dependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a386477ffe54e2d0f351f9dc7fbb49712) -* [dependents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1afa6ea6f99c9eeb606ebe08b1e7d9c54d) -* [dependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a6e0601946499c985be03e00354c8acb3) -* [dependents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a04becbe1d34e232e21208333c0700e3c) -* [dependents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ae106e94dca5f19c46ed9f82c67772660) -* [dependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1af16a20eacc6734b343762565ec8b20d6) -* [dependents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac63897b5927f1ad28965384718c0de6b) -* [dependents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ab110babf06372919f705e71b64cc733f) -* [dependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af6712999aa6e50091a95dd66db088661) -* [dependents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aa8739ff163a52ceed99e867e5126330f) -* [dependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a7a3b136537fb09914b87b5997b937df0) -* [dependents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aceffce4238d22a19c211658f675491ee) -* [dependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a392d8e4080854c954c165833bb89a7db) -* [dependents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6ce38d07c0dc470d96eec4077c2c38b8) - - -### Function isInputToComponent - -![][public] - -``` -boolean ModelCenter::IVariable::isInputToComponent() -``` - - - -Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplemented by**: - -* [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) -* [isInputToComponent](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a871c46c1f732b2885e2ef1fa2080a3e8) -* [isInputToComponent](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1af27600cef7dfba2a97acbeb31e2bbe43) -* [isInputToComponent](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a86e51010b5f7765c036af36bd9452622) -* [isInputToComponent](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a18112e5a20ca1711e97f8a5514995a49) -* [isInputToComponent](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aff062edf68ee2b0ff7db9b81cba0899a) -* [isInputToComponent](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a29e9bceef09e96ad83ce6c0618eb17dd) -* [isInputToComponent](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a8ca654408734e709fddeb945e81a5d29) -* [isInputToComponent](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a3223f3e2305da64ecb24530ed3e1652f) -* [isInputToComponent](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a2a19aa7ca1e4c4fb862016aede378c05) -* [isInputToComponent](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a67665668e8c1abee8bc9db708b05e970) -* [isInputToComponent](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a317b7b47fa55798e212c426b4ac8f014) -* [isInputToComponent](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ac551ae6997c725cbb3ef71bd6217f89a) -* [isInputToComponent](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ad59d273bea1a7e02540520e9b4428264) -* [isInputToComponent](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a940488ff3ad42baa064349a43fe9eac6) - - -### Function isInputToModel - -![][public] - -``` -boolean ModelCenter::IVariable::isInputToModel() -``` - - - -Checks whether or not the variable is an input. A linked input returns false (Output). - - - - - - -**Return values**: - -* **true**: Input -* **false**: Output - - - -**Return type**: boolean - -**Reimplemented by**: - -* [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) -* [isInputToModel](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a364726a017aca71bdb22d43530cc9426) -* [isInputToModel](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a38875f7d7b47980f4d78d76a449bbb01) -* [isInputToModel](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a78d5b37b715d259e29e0de79fa58508d) -* [isInputToModel](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a34bbd8b682a39cbe120f972f0be7b1cd) -* [isInputToModel](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa0e5a61596a334437a407396c4a38e44) -* [isInputToModel](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1accf93e4a9fe2c9eb205ccdf1704f3f9e) -* [isInputToModel](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a7bd0dbfb0063987f2484dce0cd61c8d1) -* [isInputToModel](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a324e6df2e0d789abb14a6ab9bbabb119) -* [isInputToModel](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a41c321c0260174a4c118e309fbd13085) -* [isInputToModel](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a87d3f8de3185380e368fdb008466dfe3) -* [isInputToModel](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2d16dbc50ee0f77d5ca99b8a600e5023) -* [isInputToModel](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ad8a6169868d4d186b658946403eae2ab) -* [isInputToModel](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1af1da4c99c6359d527ad57c9433333a36) -* [isInputToModel](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a52f14ae0f304152748e0373e91701708) - - -### Function setMetadata - -![][public] - -``` -void ModelCenter::IVariable::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) -``` - - - -Sets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata specifier used to store the data. -* **type**:
-* **value**:
-* **access**:
-* **archive**:
- - - -**Parameters**: - -* BSTR **name** -* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** -* VARIANT **value** -* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** -* boolean **archive** - -**Return type**: void - -**Reimplemented by**: - -* [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) -* [setMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a772ffc624a737a4808eb8dfc9ff41e0d) -* [setMetadata](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a6771c11a9e1388bc4da11b9fae91e2e8) -* [setMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a56d1d2b85ec3b4c43589c25887c1dd95) -* [setMetadata](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a499a962844cae63886b79779e39db700) -* [setMetadata](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1d611e44da36abed0a41c6f688344841) -* [setMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a46a06089e51539cdb69a6404db042d28) -* [setMetadata](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ad532913f25d0b0d02cc2c27105e7ecc8) -* [setMetadata](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a3c257357cc786dc18d4187d14b030813) -* [setMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae69f586d5f6a7cf93728f99a47b841cf) -* [setMetadata](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ad80d2a2e770297e5e57af0cd86601f83) -* [setMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a31e14e94dd9316f40bf963a9da9939f7) -* [setMetadata](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1afee8a9cb2ea3d6728cacba4aeaa9ff7a) -* [setMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a495551c5a05027a8537ffce75f333f8e) -* [setMetadata](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ac5062f1a9bcf780f891c6abeb0bcb391) - - -### Function getMetadata - -![][public] - -``` -VARIANT ModelCenter::IVariable::getMetadata(BSTR name) -``` - - - -Gets the meta data value of the given meta data key name. - - - - - - -**Parameters**: - -* **name**: Metadata key name. - - -**Returns**: - -Metadata value. - - - -**Parameters**: - -* BSTR **name** - -**Return type**: VARIANT - -**Reimplemented by**: - -* [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) -* [getMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa6b44db219dbaf49be81841dc459f4ae) -* [getMetadata](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a74eae8f0c59826ea05228abfc9a9354a) -* [getMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a1a41489453d177315ae18ef464e8907b) -* [getMetadata](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a40ecee96822db8b700fe1a814b2ab3b1) -* [getMetadata](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6fe6bbfed4b08df8c9f9a4c86cb49ca5) -* [getMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ae315b5cc3acb88a2edabaa8eea7a6690) -* [getMetadata](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a730717369f8ddb8fccfcb3405c56afe3) -* [getMetadata](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a9fa5015afd1b3cdd651ce2a0e093a6f6) -* [getMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a76933c6f159d52907c0b9f6ba3d13136) -* [getMetadata](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aea17e7f7dc6d8979c2c83aec3f8a0c42) -* [getMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac6becc1bb1c5206e972c266164f838ca) -* [getMetadata](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a122afef9ff20a0de02d08ab41eb4e5bb) -* [getMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac730dc0fbfc8ae56788048e6c0fb80fa) -* [getMetadata](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1aa094d1b1e7b20a631c92c9ec9d936d71) - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IVariable + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5769) + + + +COM instance. + +**Inherited by**: + +* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) +* [ModelCenter::IBooleanVariable](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable) +* [ModelCenter::IDoubleVariable](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable) +* [ModelCenter::IFileVariable](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable) +* [ModelCenter::IGeometryVariable](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable) +* [ModelCenter::IIntegerVariable](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable) +* [ModelCenter::IObjectVariable](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable) +* [ModelCenter::IReferenceVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable) +* [ModelCenter::IStringVariable](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable) + +## Members + +* [dependentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a1e52cc38574fbdf83e9dba836dfc5959) +* [dependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6f42f3176eb8fa2fbf9ca1b9a01fc7ce) +* [directDependents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a64c800317037f03a43c8522061885835) +* [directPrecedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a655ce10f3a6e2839f11161e8bf13b0c2) +* [fromString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a3f6325a128422d445705553f11563904) +* [getFullName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a05a46370dd23d612bf0f09f146ba32a0) +* [getMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a610297790a8c506c339586740f1d3022) +* [getName](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ae1ad6db87e29a4b265ec310295fb3843) +* [getType](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ab7fadd397a7779f29005048383a9f187) +* [hasChanged](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a70aa745d819120f3f13d8f5cac099e44) +* [hide](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a2b79ae605f5b5864f5470d730a845f7c) +* [invalidate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1addc5f809058b5573390f62d34b5f5498) +* [isInput](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a875481ba3799c222c5085c6c3ca802a7) +* [isInputToComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a81ddff978026124a52063b1fad430b27) +* [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98) +* [isValid](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a602d42ee0595c1c0408a536c31c61adb) +* [OwningComponent](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a2b61c0eea38b2b20a08b75041dc20f63) +* [precedentLinks](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a9d52333bc9a07146e23124f0fe95db6f) +* [precedents](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1ad1f5d5ba3e96e9c2fab7a4b0d6c4df36) +* [setMetadata](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1af7cbf8f2c8d128c760fb09254819bf64) +* [toString](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6421656e090846e8d7c079b8511fa9d2) +* [toStringAbsolute](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a5e66075d2bff0f7de435056cdc6c011e) +* [validate](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a6748764fba94242fbe35ae2f4d49c9ef) + +## Properties + + +### Property hasChanged + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IVariable::hasChanged +``` + + + +Boolean which indicates if the variable has changed since the last time the boolean was reset. Typically used only by Plug-Ins for their own variables (to avoid conflicting use by different Plug-Ins , macros, or tools). Set the value to false and it will automatically flip to true any time the value changes. + + + +**Return type**: boolean + + +### Property hide + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IVariable::hide +``` + + + +Hides the variable from the User Interface. Variable will not be visible in Component Tree, Data Explorer, or Data Monitors. + + + +**Return type**: boolean + + +### Property OwningComponent + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +LPDISPATCH ModelCenter::IVariable::OwningComponent +``` + + + +Gets the component that owns this variable. + + + + + + +**Returns**: + +IDispatch* to an [IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) object. + + + +**Return type**: LPDISPATCH + +## Public functions + + +### Function isValid + +![][public] + +``` +boolean ModelCenter::IVariable::isValid() +``` + + + +Returns whether or not the variable is valid. + + + + + + +**Returns**: + +True if variable is valid. False if the variable is not valid. + + + +**Return type**: boolean + +**Reimplemented by**: + +* [isValid](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a20792cdbe6866825f978a2e30affca88) +* [isValid](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d13fb275a266aa85280b6beed8be176) +* [isValid](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a877899b0c2bcc8400bcd8cfa31c4eb7a) +* [isValid](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a4d7719052c0b341f91436d3a0da270cc) +* [isValid](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1b873587774671d25664c294323beae8) +* [isValid](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a88a80a771329337246e883b3ce034400) +* [isValid](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a1d3371b70abb06b2eff5d1ada8aa114f) +* [isValid](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2d8ceabbeb9640dffb9f6a9e654bbd79) +* [isValid](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a01fe29466d2371dd25e6d9a473de32c7) +* [isValid](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ab3d891c3978182e073923a56b4dbe89b) +* [isValid](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ae03686387c15bc80d2caec8c3a5a913f) +* [isValid](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a366cf132edcae4c78ff3c3c29d81ad03) +* [isValid](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1adbc66e2276350867c0b977bf5cf192cf) +* [isValid](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a8b738f7eef3f9a3f8a723cede3809f47) +* [isValid](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a16c6e45e1967f427b3a7123d7da384b1) + + +### Function validate + +![][public] + +``` +void ModelCenter::IVariable::validate() +``` + + + +Validates the variable by running the component if needed. + + + +**Return type**: void + +**Reimplemented by**: + +* [validate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a31cda88a70c11ef884e9105ef4ee7d20) +* [validate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa221cef15629c5acf569329c0e089b3a) +* [validate](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ae3cb5f6c787efb879f5d85a5ee5ee344) +* [validate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1abc755512c485531a61f10d2bc5d691b0) +* [validate](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1abddc8770d26e37ac9319be5b90bc6e3e) +* [validate](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a56e476d33f05ee8b4faa077396704fa6) +* [validate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a506a66d66cb52b49d7385351bf0cfa46) +* [validate](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aa3fdf5883f1849f93bf87256b9100d0b) +* [validate](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a62715d2cd23f7a7daafe7568d1a6e32d) +* [validate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a84ab133f5b1147d475fb8e2c4275b32b) +* [validate](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a2807c2dd1e70fe7d8eab0af0a64e2d74) +* [validate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1af1dd28c351fcda3e3fea31facbd4fca3) +* [validate](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a16aec4b64f98c5dfb3f66c497691e447) +* [validate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a86b82bcfb1ccfa2428968307eaa07108) +* [validate](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a7bddbd595f981680f8eb062d950f20d7) + + +### Function getName + +![][public] + +``` +BSTR ModelCenter::IVariable::getName() +``` + + + +Gets the name of the variable. + + + + + + +**Returns**: + +The name of the variable. + + + +**Return type**: BSTR + +**Reimplemented by**: + +* [getName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ace7a0aeb83a64535f7caa63600783fa7) +* [getName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a471100848db5a6f0c08f2920aa283ac6) +* [getName](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ac4595a4a7f2b81c6c5c2f1f5e3742f56) +* [getName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe2789906f30f6a082e5d3d79e2b5bbc) +* [getName](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a10978bbb428eadf01141d2ceb2373c7a) +* [getName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1ec0c0bce4884b2c8c1decf29f4d5b86) +* [getName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a3f04f85ebe4f50a88c7cc3a61ae597f6) +* [getName](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1adbaa029c76034043ccdf2bf84bbd0e7f) +* [getName](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a2ab57d435f315c7afc7bed802b57d9d0) +* [getName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a79fdcc3e290b4b0df816f69d8a8d5f9d) +* [getName](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1abcd09429d47c396bab6dc63690e1a1c1) +* [getName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a282d98574e8d65d85c9908b6799321b7) +* [getName](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa01b77111d4a975cc12ca3e0a16d845b) +* [getName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a0a90870618bd396edc53c27ff0b8c9af) +* [getName](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a50cf9efbe23ed25a027f6df1d7132577) + + +### Function getFullName + +![][public] + +``` +BSTR ModelCenter::IVariable::getFullName() +``` + + + +Gets the full ModelCenter path of the variable. + + + + + + +**Returns**: + +The full ModelCenter path of the variable. + + + +**Return type**: BSTR + +**Reimplemented by**: + +* [getFullName](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a699cf890f3743699cb25a7432c0f7f68) +* [getFullName](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a498741fde4d9eeec6eb3f8171e3161d8) +* [getFullName](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a19c8cfbcba0c9fc8eaae14bfaaa07d39) +* [getFullName](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a225331135b6efad1b05c399869975962) +* [getFullName](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a00a7eca52d31c8f86e049dc1896d2434) +* [getFullName](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a7d1acdd7a964ceb7d189c87a19e9bcb3) +* [getFullName](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7aada275954e2fff6bdea69b8a96bd0c) +* [getFullName](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a5b0b8db5aec4ebfbd8e7918568c71b70) +* [getFullName](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a0b0e9f581b1b038395dacb2700d82ce4) +* [getFullName](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a8c74276fefc00a8b85a576e1d1b58053) +* [getFullName](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a6bbb377e1c98a99b660cfdfa3c61f191) +* [getFullName](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a44ebe17869a3b1b95568ea46299a9f3f) +* [getFullName](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3e427b90dbf2f763c2486cdd774c2d49) +* [getFullName](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4ca185e60b69ce2ff41d19a2270bc28b) +* [getFullName](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ac8c712e2b8f8136f59cffd1665d6cb5e) + + +### Function getType + +![][public] + +``` +BSTR ModelCenter::IVariable::getType() +``` + + + +Gets the type of the variable. + + + + + + +**Returns**: + +The type of the variable as a string. + + + +**Return type**: BSTR + +**Reimplemented by**: + +* [getType](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1adf1ee02ba4bdf03ef0366e2f0a62b344) +* [getType](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1ad8d2b43dd9f4b3656dba1e8570f7f747) +* [getType](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a6e68844292a9f0b5e1924728465d02c0) +* [getType](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a59535b93acdadae5c47ebb3f148cc8a7) +* [getType](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a974708d2da959d48ee301088918719fd) +* [getType](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a40cc49ff4f6fd51695549d4ad32a4384) +* [getType](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a6614c3d1ae621d218762e8ed8ec58222) +* [getType](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aec7c7bb8f9e43d411c457d7b091e5378) +* [getType](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a09f10acb36a75c48c2cce4f1925acb55) +* [getType](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a05e311dcfb051f0df6afc99dd01d6773) +* [getType](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a38de94bbe44275b88d92522926b1a841) +* [getType](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac3c3f33a239fe1182da434d7570346df) +* [getType](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ab946d679180e3e65433c8b4b2d61d39e) +* [getType](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a582f9e8e47e60eca8041b98c996a4f4f) +* [getType](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a9468a019a8bfaaa771c5bf97e206ea5a) + + +### Function isInput + +![][public] + +``` +boolean ModelCenter::IVariable::isInput() +``` + + + +Finds out whether or not the variable is an input with respect to the model. Returns the same value as [isInputToModel](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable_1a0bd883d3757e361b75e0f81627e6ce98). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplemented by**: + +* [isInput](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1af18eb203bc12f95a61b5876279ee17a9) +* [isInput](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa87e846de03852ee40e909935c2ec470) +* [isInput](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ab8445c95fe06a4eb82ed55034c26d34e) +* [isInput](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1aa0a3e17384092dbeb0cef004db873191) +* [isInput](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a162bb6a2a0c8cf5a2f3ee15daaaf85c2) +* [isInput](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1adb2ffa6d382f3874d63cab8c53f956c6) +* [isInput](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9e45ea90908321e84979e5b8d2f50357) +* [isInput](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a92363045c1f3285c5c1127ad149c0250) +* [isInput](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a8c9a1d489060c768242c74b57e85aec2) +* [isInput](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a3752394336c9689384efac1005422431) +* [isInput](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ab441aa413516cf14c082aa39801250c4) +* [isInput](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ae7e5c76cfd592a71fc7e5785c7cf6394) +* [isInput](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa61fe715fadff86e98c35d4bf6aa16e0) +* [isInput](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a3b7b397239f04cf9ea9358f9477ee2c4) +* [isInput](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a2268414421505ee4c0fb49de92953007) + + +### Function toString + +![][public] + +``` +BSTR ModelCenter::IVariable::toString() +``` + + + +Converts the variable value to a string, validating the variable if necessary. + + + + + + +**Returns**: + +The value of the variable as a string. + + + +**Return type**: BSTR + +**Reimplemented by**: + +* [toString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a6ff821435a5704253ffdfb9334cc2dc4) +* [toString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a39294beb6d830e498ee8aca7a25cc4a6) +* [toString](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a97263640728fae5de92a272345ce0a01) +* [toString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1af417ef0e71fabce8379be30e4d176355) +* [toString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a59f1d75b8e24323ea9bf523159f04f69) +* [toString](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1acc675e2c9045387d4ceb956d7d7d9f70) +* [toString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7ba909789490822b7ab12891075a9e56) +* [toString](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ae28a776965df5807d9ce8b2e0d995867) +* [toString](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a0bda0cd0ea97014dc4be4ee2af69e55c) +* [toString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a83e5e9905df758b37c901bae5e87430e) +* [toString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a2ec6bbef037c4c0a6ab5e510f9063923) +* [toString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aaa37debc6216a5419715e0c542555850) +* [toString](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a6675d6a6451c20b11b43ad594af28bcc) +* [toString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1aa735025db3ac6e13cb486f8629b86a69) +* [toString](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a46f43be460cbd0d90493a6f9f26eb65d) + + +### Function fromString + +![][public] + +``` +void ModelCenter::IVariable::fromString(BSTR value) +``` + + + +Sets the value of the variable from the specified string. + + + + + + +**Parameters**: + +* **value**: New value. + + + +**Parameters**: + +* BSTR **value** + +**Return type**: void + +**Reimplemented by**: + +* [fromString](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a97b06c86c2783603221e0b0215dc75c8) +* [fromString](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1af5d6c192774673f4f4bf7514b35f8ccf) +* [fromString](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a8b9fd88143b7b23e5f3ae9e229774a2b) +* [fromString](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3faefed33c99ee3ffb10b5e0e21d239a) +* [fromString](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a1128d6c344adde4e9f9d95b0c19f87b9) +* [fromString](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aca195574fffbfac6577eb4b0d54f3dd8) +* [fromString](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab107312b8a5b1e8e96ae2a3678ef9897) +* [fromString](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac7654e743af45785904858d2c581058d) +* [fromString](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a710bd007c2d1df9c861a33a397c7a9d7) +* [fromString](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af3d5cd8601c1227d439b7b3f74cc2d16) +* [fromString](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a180292624fd43a95348bd496b0fee8a6) +* [fromString](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a9cb9dab871b4e86ed66fb53cc5473ebd) +* [fromString](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aa52a8fe2a76861302ee8ab0f8f3a614c) +* [fromString](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a65a839b63dfb0495f577bf70ca87a320) +* [fromString](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a587cc7ce24785d0110b86ff815a68d89) + + +### Function toStringAbsolute + +![][public] + +``` +BSTR ModelCenter::IVariable::toStringAbsolute() +``` + + + +Converts the value of the variable to a string. + + + + + + +**Returns**: + +The value of the variable as a string. + + + +**Return type**: BSTR + +**Reimplemented by**: + +* [toStringAbsolute](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ad5ecd4799e995bf2c97015c718606550) +* [toStringAbsolute](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa07f73fa1f449045d77725b0fef00739) +* [toStringAbsolute](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ad3fdc29d883580eaf57b83a7b796c703) +* [toStringAbsolute](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1adbd82fbad4622d8c2d91533d536a7ea0) +* [toStringAbsolute](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a89797e61eedee333bd67b55b653ec21f) +* [toStringAbsolute](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af042cdd3c4908daa767f6b0dce043e75) +* [toStringAbsolute](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ac8f43fca8b974b224bd64a78bd3bdda3) +* [toStringAbsolute](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a0dda099769e13bdd8c5c076fc7d9378a) +* [toStringAbsolute](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a711f2c70a30362b587b39f5cd3775f71) +* [toStringAbsolute](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a5bc139ce096dbc917734386869a3be78) +* [toStringAbsolute](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ac13b9c8e85a30831a81cedcdca610e01) +* [toStringAbsolute](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a1a0ecbbccb3fe3404c79976e9f07b8db) +* [toStringAbsolute](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a510fd4577f2a29cf0fef6d1c8fe43c94) +* [toStringAbsolute](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1adfb1dee0a1fd5b541eacba1e4cbba7ad) +* [toStringAbsolute](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ae9ed673188c2c46e2c3883cdd65b3af5) + + +### Function invalidate + +![][public] + +``` +void ModelCenter::IVariable::invalidate() +``` + + + +Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also. + + + +**Return type**: void + +**Reimplemented by**: + +* [invalidate](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1abfaa3f2b5bff1412199f5014ca10c4d5) +* [invalidate](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a04e162fdfae6e99e6dcfd926adfca7b1) +* [invalidate](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a1eecc6708b4fb8e29bfe73ead410adaa) +* [invalidate](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a032e132c6c6a61f81370942921ab2edf) +* [invalidate](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a9abf6ea522bbff16d7c2266202b5bdae) +* [invalidate](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aff411bdfa6a95ccc904878f1ffecba6b) +* [invalidate](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a7599948212f77bb66f8ef42fc98e53ce) +* [invalidate](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a2beb5e20db0843a92acf8d0cc961e3af) +* [invalidate](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ac80cc84f95b559145c98a82367649d89) +* [invalidate](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a521514c594a1ab4e30669305585530b7) +* [invalidate](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a07f62e68cae660a8bea1d1e31d754fcf) +* [invalidate](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a56ea1d83eb42dda4a7c06b6fbbf6ffd5) +* [invalidate](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a3a460ef81527173ce0c272d2bdf69da6) +* [invalidate](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac6dd084c61d7ce2631d207242eca89bf) +* [invalidate](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a7b29d24168420440191f35e6ad382d03) + + +### Function directPrecedents + +![][public] + +``` +LPDISPATCH ModelCenter::IVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplemented by**: + +* [directPrecedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a0367bcfe5c12848d1d10e1266a0a868e) +* [directPrecedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a605c25813e75d1709e364eef080f68e9) +* [directPrecedents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ae54cdcd132e22278b8ddb00aaff236c7) +* [directPrecedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a3ab4fe76950c76fbdd2e76ea3f4fb08b) +* [directPrecedents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a7a14b5ef10935109b178062205b91b7a) +* [directPrecedents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aac5eb818fb62f131d6ecb13fd3f6aa34) +* [directPrecedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a9f84f73f3b65f16fa507678c53c67527) +* [directPrecedents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1aea8561351c3ff1e003d463616682a838) +* [directPrecedents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a8294d8120195193f3a5fba86abcded57) +* [directPrecedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae3879cd50b0512f2b5660765393bd24e) +* [directPrecedents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a5c99fbda3111d689db126a61e0727106) +* [directPrecedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aa8041fca418266f2bee129804654abab) +* [directPrecedents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a0e11aede2642dd050f0c5254a36b4a71) +* [directPrecedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a40c76b900187ef244f14c5c8e9bb65bf) +* [directPrecedents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a98031c7081831a57f35dcfd18bef2279) + + +### Function directDependents + +![][public] + +``` +LPDISPATCH ModelCenter::IVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplemented by**: + +* [directDependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a834a8ad8bfec0c4b0220b21979e82fca) +* [directDependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a6ed20fe44044c682471c7066ae2bd303) +* [directDependents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a40dedf6b7b841a6699d545ea058ad2cd) +* [directDependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1afe14e74990edda2c656035bbcd8e2af2) +* [directDependents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a6178082dc3de5e1f6665f4faebcb8c36) +* [directDependents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af1b4238d92307aa3586b4f7070e497be) +* [directDependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ab61572acbd0617f5c51b04b2ae4bbdba) +* [directDependents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a9347c073e1dc6ca62f1b3c7cd6fbec71) +* [directDependents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a06be08cd5896250dc5b31ec3d90b79e6) +* [directDependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a44b3a3cc73cd46ea7661e776b20b4ded) +* [directDependents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ad783a3a7e231dd0aa00b869699a5bca4) +* [directDependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a862a4306dbf867e3db316d9547cea277) +* [directDependents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a24fa52bf29a92c4f1d6a79e2991e9ae5) +* [directDependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4820176e7ca9e1c3173d602308144c62) +* [directDependents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6cd07e865097669f307d3d8ee9ace1c1) + + +### Function precedentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IVariable::precedentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplemented by**: + +* [precedentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8f2364939bd5efaab13ecdbc3cb7df51) +* [precedentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a428a6e6a2a2be52d77bfe96323fea64f) +* [precedentLinks](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1ab5b740c028c3b878f1341efea2df0116) +* [precedentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a640715d1e272c8f15d8cc4c2b466d990) +* [precedentLinks](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a8bf056e8b989223191b2e8c7595c0753) +* [precedentLinks](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a25a478d55d4855cdbf4f8753b6cd6062) +* [precedentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a998c2f1327219560aacd3d65d2c178b6) +* [precedentLinks](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a4bc52bbf01e5d0a0f95e67e03cce4547) +* [precedentLinks](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a42168bcdab0805055df8432194d5654c) +* [precedentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ac71c9a184e57f627b336438de0b7a238) +* [precedentLinks](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a02a977781b36247895725b38a725dca9) +* [precedentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a084d49d02b9ff5812166721fcdc86018) +* [precedentLinks](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ac4f846dce2494b7c4a9b8482af321c96) +* [precedentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a19c1ae9d08b968bae4b6fdd1ec74fc3e) +* [precedentLinks](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6fcaecc0f0d1bdbd827e507ae1307fa4) + + +### Function dependentLinks + +![][public] + +``` +LPDISPATCH ModelCenter::IVariable::dependentLinks([optional]VARIANT reserved) +``` + + + +Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. + + + + + + +**Parameters**: + +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplemented by**: + +* [dependentLinks](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1aecc2dc18b0ee43d5175503d44ca259c3) +* [dependentLinks](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1abadb81820fd0b415fa9e78ce6c867c55) +* [dependentLinks](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a69e716f024970454d8c555c73df17360) +* [dependentLinks](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a0201276e7d000c4869e4798cfdb68d8b) +* [dependentLinks](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a385019a97e3ddbae4351fd6dd591a49c) +* [dependentLinks](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1af52780ea6b4984f40b16c8c072e1b005) +* [dependentLinks](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a90373b06919789f06f52dd22a0339847) +* [dependentLinks](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a46a1da5e2a3f39c2e413b520ec33407f) +* [dependentLinks](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a50e3d7ea1d97cd799c29901c2b563208) +* [dependentLinks](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a399b9b49ca3133d2a49923637f19609a) +* [dependentLinks](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a1328684b4767a3ee6b006feca4f0296d) +* [dependentLinks](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1add9bd8c41cd4a5c77f7e762768b441a5) +* [dependentLinks](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a4c704741da375408b052eeddc6ed90dc) +* [dependentLinks](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a4227d6aca4e2d7791cea69efeb5b81fd) +* [dependentLinks](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a019771c2e685c90ef2b4f53a0a3acf7c) + + +### Function precedents + +![][public] + +``` +LPDISPATCH ModelCenter::IVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplemented by**: + +* [precedents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1ab185a76064278e30ee48682164364e72) +* [precedents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a9d7349a2273e5b9eaaab5271918eed6f) +* [precedents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1aa43bd8ee475029fc466b20cd3b1b686d) +* [precedents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a5973cfc6b1e41db214568a7e95979eef) +* [precedents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1ac65d0d53de6aee17106700d60161e9cf) +* [precedents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a8c987c7df5766ca31115f25ce36f1f91) +* [precedents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1abf61619be1e057cf2c42189456169041) +* [precedents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a8db95046419c83467475175b216efe84) +* [precedents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a6d516295359de158c45bf2a5c0378af0) +* [precedents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a01bd8fce84abbb243a9f7e3c771c185c) +* [precedents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a902fe35d10c8e25b86a64e13953a62f1) +* [precedents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1aea1973c58e45bafe3aeea797b91a4f6b) +* [precedents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ae2d07bb6bf73c064a1a492bb6ff2806a) +* [precedents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a913272799193e5d02033c63c746ead9e) +* [precedents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a4affcdc7391a9327db4c828e54c71703) + + +### Function dependents + +![][public] + +``` +LPDISPATCH ModelCenter::IVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved) +``` + + + +Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones. + + + + + + +**Parameters**: + +* **followSuspended**: Optional boolean specifies whether links which are suspended should be included in the search. Default is false. +* **reserved**: Reserved for future use. + + +**Returns**: + +IDispatch* to an [IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) object. + + + +**Parameters**: + +* _[optional]_ VARIANT **followSuspended** +* _[optional]_ VARIANT **reserved** + +**Return type**: LPDISPATCH + +**Reimplemented by**: + +* [dependents](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a7cb300d678991e0b6449ad7b0d004906) +* [dependents](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a386477ffe54e2d0f351f9dc7fbb49712) +* [dependents](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1afa6ea6f99c9eeb606ebe08b1e7d9c54d) +* [dependents](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a6e0601946499c985be03e00354c8acb3) +* [dependents](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a04becbe1d34e232e21208333c0700e3c) +* [dependents](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1ae106e94dca5f19c46ed9f82c67772660) +* [dependents](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1af16a20eacc6734b343762565ec8b20d6) +* [dependents](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ac63897b5927f1ad28965384718c0de6b) +* [dependents](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1ab110babf06372919f705e71b64cc733f) +* [dependents](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1af6712999aa6e50091a95dd66db088661) +* [dependents](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aa8739ff163a52ceed99e867e5126330f) +* [dependents](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a7a3b136537fb09914b87b5997b937df0) +* [dependents](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1aceffce4238d22a19c211658f675491ee) +* [dependents](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a392d8e4080854c954c165833bb89a7db) +* [dependents](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a6ce38d07c0dc470d96eec4077c2c38b8) + + +### Function isInputToComponent + +![][public] + +``` +boolean ModelCenter::IVariable::isInputToComponent() +``` + + + +Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links. + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplemented by**: + +* [isInputToComponent](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a74e3e9729c8de2d3d091a6f22f7cb45b) +* [isInputToComponent](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a871c46c1f732b2885e2ef1fa2080a3e8) +* [isInputToComponent](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1af27600cef7dfba2a97acbeb31e2bbe43) +* [isInputToComponent](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a86e51010b5f7765c036af36bd9452622) +* [isInputToComponent](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a18112e5a20ca1711e97f8a5514995a49) +* [isInputToComponent](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aff062edf68ee2b0ff7db9b81cba0899a) +* [isInputToComponent](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a29e9bceef09e96ad83ce6c0618eb17dd) +* [isInputToComponent](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a8ca654408734e709fddeb945e81a5d29) +* [isInputToComponent](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a3223f3e2305da64ecb24530ed3e1652f) +* [isInputToComponent](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a2a19aa7ca1e4c4fb862016aede378c05) +* [isInputToComponent](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a67665668e8c1abee8bc9db708b05e970) +* [isInputToComponent](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a317b7b47fa55798e212c426b4ac8f014) +* [isInputToComponent](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ac551ae6997c725cbb3ef71bd6217f89a) +* [isInputToComponent](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ad59d273bea1a7e02540520e9b4428264) +* [isInputToComponent](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a940488ff3ad42baa064349a43fe9eac6) + + +### Function isInputToModel + +![][public] + +``` +boolean ModelCenter::IVariable::isInputToModel() +``` + + + +Checks whether or not the variable is an input. A linked input returns false (Output). + + + + + + +**Return values**: + +* **true**: Input +* **false**: Output + + + +**Return type**: boolean + +**Reimplemented by**: + +* [isInputToModel](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a87cc3a01fd30ce7c6380b5d1d6ff7df9) +* [isInputToModel](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a364726a017aca71bdb22d43530cc9426) +* [isInputToModel](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a38875f7d7b47980f4d78d76a449bbb01) +* [isInputToModel](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a78d5b37b715d259e29e0de79fa58508d) +* [isInputToModel](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a34bbd8b682a39cbe120f972f0be7b1cd) +* [isInputToModel](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1aa0e5a61596a334437a407396c4a38e44) +* [isInputToModel](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1accf93e4a9fe2c9eb205ccdf1704f3f9e) +* [isInputToModel](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a7bd0dbfb0063987f2484dce0cd61c8d1) +* [isInputToModel](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a324e6df2e0d789abb14a6ab9bbabb119) +* [isInputToModel](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a41c321c0260174a4c118e309fbd13085) +* [isInputToModel](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1a87d3f8de3185380e368fdb008466dfe3) +* [isInputToModel](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a2d16dbc50ee0f77d5ca99b8a600e5023) +* [isInputToModel](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1ad8a6169868d4d186b658946403eae2ab) +* [isInputToModel](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1af1da4c99c6359d527ad57c9433333a36) +* [isInputToModel](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1a52f14ae0f304152748e0373e91701708) + + +### Function setMetadata + +![][public] + +``` +void ModelCenter::IVariable::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive) +``` + + + +Sets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata specifier used to store the data. +* **type**:
+* **value**:
+* **access**:
+* **archive**:
+ + + +**Parameters**: + +* BSTR **name** +* [MetadataType](namespaceModelCenter.md#namespaceModelCenter_1a59560dc5274b3a18daae06b531055153) **type** +* VARIANT **value** +* [MetadataAccess](namespaceModelCenter.md#namespaceModelCenter_1afea526d882aa1a4fd48b5a28b7b1c9dc) **access** +* boolean **archive** + +**Return type**: void + +**Reimplemented by**: + +* [setMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a8b1a6f24260a22b01e738ed2fb1d4523) +* [setMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1a772ffc624a737a4808eb8dfc9ff41e0d) +* [setMetadata](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a6771c11a9e1388bc4da11b9fae91e2e8) +* [setMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a56d1d2b85ec3b4c43589c25887c1dd95) +* [setMetadata](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a499a962844cae63886b79779e39db700) +* [setMetadata](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a1d611e44da36abed0a41c6f688344841) +* [setMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1a46a06089e51539cdb69a6404db042d28) +* [setMetadata](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1ad532913f25d0b0d02cc2c27105e7ecc8) +* [setMetadata](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a3c257357cc786dc18d4187d14b030813) +* [setMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1ae69f586d5f6a7cf93728f99a47b841cf) +* [setMetadata](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1ad80d2a2e770297e5e57af0cd86601f83) +* [setMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1a31e14e94dd9316f40bf963a9da9939f7) +* [setMetadata](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1afee8a9cb2ea3d6728cacba4aeaa9ff7a) +* [setMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1a495551c5a05027a8537ffce75f333f8e) +* [setMetadata](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1ac5062f1a9bcf780f891c6abeb0bcb391) + + +### Function getMetadata + +![][public] + +``` +VARIANT ModelCenter::IVariable::getMetadata(BSTR name) +``` + + + +Gets the meta data value of the given meta data key name. + + + + + + +**Parameters**: + +* **name**: Metadata key name. + + +**Returns**: + +Metadata value. + + + +**Parameters**: + +* BSTR **name** + +**Return type**: VARIANT + +**Reimplemented by**: + +* [getMetadata](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray_1a53f2d3f772584c3c43341ff4236402c9) +* [getMetadata](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray_1aa6b44db219dbaf49be81841dc459f4ae) +* [getMetadata](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable_1a74eae8f0c59826ea05228abfc9a9354a) +* [getMetadata](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray_1a1a41489453d177315ae18ef464e8907b) +* [getMetadata](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable_1a40ecee96822db8b700fe1a814b2ab3b1) +* [getMetadata](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable_1a6fe6bbfed4b08df8c9f9a4c86cb49ca5) +* [getMetadata](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray_1ae315b5cc3acb88a2edabaa8eea7a6690) +* [getMetadata](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable_1a730717369f8ddb8fccfcb3405c56afe3) +* [getMetadata](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable_1a9fa5015afd1b3cdd651ce2a0e093a6f6) +* [getMetadata](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray_1a76933c6f159d52907c0b9f6ba3d13136) +* [getMetadata](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable_1aea17e7f7dc6d8979c2c83aec3f8a0c42) +* [getMetadata](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray_1ac6becc1bb1c5206e972c266164f838ca) +* [getMetadata](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable_1a122afef9ff20a0de02d08ab41eb4e5bb) +* [getMetadata](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray_1ac730dc0fbfc8ae56788048e6c0fb80fa) +* [getMetadata](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable_1aa094d1b1e7b20a631c92c9ec9d936d71) + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariableDescription.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariableDescription.md index 8e94ca7196..fa26d268e2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariableDescription.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariableDescription.md @@ -1,189 +1,188 @@ - -# Interface ModelCenter::IVariableDescription - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5973) - - - -COM Instance. - -## Members - -* [equation](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1aa42abd87b11af98fcb67926472408801) -* [fullName](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1aa3c8267507d2f0d6cbbd35a33de0fca3) -* [isCustom](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1ae6ba3b64b599b6df11a39f0c3fa1b078) -* [isNumeric](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1ac7d823563278b1abbc458b61aa5eb686) -* [name](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1a5430f2b928f3f8fc672dc2dcf8c6db03) -* [state](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1ace7a19354a1c40a3f64464fb87b992ba) -* [type](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1a8fc783420e2ab3163a2552436d694d0a) -* [units](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1abea210199b644bc3da685775950b9368) - -## Properties - - -### Property name - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IVariableDescription::name -``` - - - -Name of the variable. - - - -**Return type**: BSTR - - -### Property fullName - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IVariableDescription::fullName -``` - - - -Full ModelCenter path of the variable. - - - -**Return type**: BSTR - - -### Property state - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -short ModelCenter::IVariableDescription::state -``` - - - -State of the variable. - - - - - -Possible states: -* 0 (INPUT) - -* 1 (OUTPUT) - - - -**Return type**: short - - -### Property units - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IVariableDescription::units -``` - - - -Units of the variable. - - - -**Return type**: BSTR - - -### Property isCustom - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IVariableDescription::isCustom -``` - - - -Whether or not the variable is custom. - - - -**Return type**: boolean - - -### Property equation - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IVariableDescription::equation -``` - - - -Equation of the variable. - - - -**Return type**: BSTR - - -### Property type - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IVariableDescription::type -``` - - - -Type of the variable. - - - -**Return type**: BSTR - - -### Property isNumeric - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IVariableDescription::isNumeric -``` - - - -Whether or not the variable is numeric. - - - -**Return type**: boolean - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IVariableDescription + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5973) + + + +COM Instance. + +## Members + +* [equation](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1aa42abd87b11af98fcb67926472408801) +* [fullName](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1aa3c8267507d2f0d6cbbd35a33de0fca3) +* [isCustom](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1ae6ba3b64b599b6df11a39f0c3fa1b078) +* [isNumeric](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1ac7d823563278b1abbc458b61aa5eb686) +* [name](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1a5430f2b928f3f8fc672dc2dcf8c6db03) +* [state](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1ace7a19354a1c40a3f64464fb87b992ba) +* [type](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1a8fc783420e2ab3163a2552436d694d0a) +* [units](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription_1abea210199b644bc3da685775950b9368) + +## Properties + + +### Property name + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IVariableDescription::name +``` + + + +Name of the variable. + + + +**Return type**: BSTR + + +### Property fullName + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IVariableDescription::fullName +``` + + + +Full ModelCenter path of the variable. + + + +**Return type**: BSTR + + +### Property state + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +short ModelCenter::IVariableDescription::state +``` + + + +State of the variable. + + + + + +Possible states: +* 0 (INPUT) + +* 1 (OUTPUT) + + + +**Return type**: short + + +### Property units + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IVariableDescription::units +``` + + + +Units of the variable. + + + +**Return type**: BSTR + + +### Property isCustom + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IVariableDescription::isCustom +``` + + + +Whether or not the variable is custom. + + + +**Return type**: boolean + + +### Property equation + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IVariableDescription::equation +``` + + + +Equation of the variable. + + + +**Return type**: BSTR + + +### Property type + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IVariableDescription::type +``` + + + +Type of the variable. + + + +**Return type**: BSTR + + +### Property isNumeric + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IVariableDescription::isNumeric +``` + + + +Whether or not the variable is numeric. + + + +**Return type**: boolean + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariableLink.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariableLink.md index 9941ac58e3..5287bc56f6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariableLink.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariableLink.md @@ -1,116 +1,115 @@ - -# Interface ModelCenter::IVariableLink - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6026) - - - -Represents a link between variables. - -## Members - -* [breakLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a0e2397280fb0a53c07ecee27bdff89bd) -* [LHS](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1ae3805787afceef57db6297e72632650a) -* [resumeLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a38ec9f0f44714dd151f7683721bd7ce8) -* [RHS](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a05eff77b1fab3100869de855008d8b02) -* [suspendLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a8a637411378f91597e5612e2e03c959d) - -## Properties - - -### Property LHS - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IVariableLink::LHS -``` - - - -The left hand side of the equation. Read only. Will always be a simple variable name. - - - -**Return type**: BSTR - - -### Property RHS - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -BSTR ModelCenter::IVariableLink::RHS -``` - - - -The right hand side of the equation. You can change the link by changing this value. - - - -**Return type**: BSTR - -## Public functions - - -### Function suspendLink - -![][public] - -``` -void ModelCenter::IVariableLink::suspendLink() -``` - - - -Causes the link to be suspended. - - - -**Return type**: void - - -### Function resumeLink - -![][public] - -``` -void ModelCenter::IVariableLink::resumeLink() -``` - - - -Resumes the link if it was suspended. - - - -**Return type**: void - - -### Function breakLink - -![][public] - -``` -void ModelCenter::IVariableLink::breakLink() -``` - - - -Breaks this link and removes the dependencies between the LHS and RHS of the equation. This object becomes invalid and cannot be used after calling this method. - - - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IVariableLink + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6026) + + + +Represents a link between variables. + +## Members + +* [breakLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a0e2397280fb0a53c07ecee27bdff89bd) +* [LHS](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1ae3805787afceef57db6297e72632650a) +* [resumeLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a38ec9f0f44714dd151f7683721bd7ce8) +* [RHS](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a05eff77b1fab3100869de855008d8b02) +* [suspendLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink_1a8a637411378f91597e5612e2e03c959d) + +## Properties + + +### Property LHS + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IVariableLink::LHS +``` + + + +The left hand side of the equation. Read only. Will always be a simple variable name. + + + +**Return type**: BSTR + + +### Property RHS + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +BSTR ModelCenter::IVariableLink::RHS +``` + + + +The right hand side of the equation. You can change the link by changing this value. + + + +**Return type**: BSTR + +## Public functions + + +### Function suspendLink + +![][public] + +``` +void ModelCenter::IVariableLink::suspendLink() +``` + + + +Causes the link to be suspended. + + + +**Return type**: void + + +### Function resumeLink + +![][public] + +``` +void ModelCenter::IVariableLink::resumeLink() +``` + + + +Resumes the link if it was suspended. + + + +**Return type**: void + + +### Function breakLink + +![][public] + +``` +void ModelCenter::IVariableLink::breakLink() +``` + + + +Breaks this link and removes the dependencies between the LHS and RHS of the equation. This object becomes invalid and cannot be used after calling this method. + + + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariableLinks.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariableLinks.md index 7eff5f2f4b..df97792a3d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariableLinks.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariableLinks.md @@ -1,78 +1,77 @@ - -# Interface ModelCenter::IVariableLinks - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6066) - - - -A collection of [IVariableLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink) objects. - -## Members - -* [Count](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks_1a65d1ab625bcdab41639028c42f712b26) -* [Item](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks_1af1e6de7d83b5af2ae699785b1d61fb1c) - -## Properties - - -### Property Count - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IVariableLinks::Count -``` - - - -Number of Links. - - - -**Return type**: VARIANT - -## Public functions - - -### Function Item - -![][public] - -``` -VARIANT ModelCenter::IVariableLinks::Item(VARIANT id) -``` - - - -Gets the specified Link object. - - - - - - -**Parameters**: - -* **id**: ID of the specified Link. It can be a name or an index (0-based index). In the case of a name, it looks for the link based on the LHS variable's name. - - -**Returns**: - -IDispatch* to an [IVariableLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink) object. - - - -**Parameters**: - -* VARIANT **id** - -**Return type**: VARIANT - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IVariableLinks + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6066) + + + +A collection of [IVariableLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink) objects. + +## Members + +* [Count](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks_1a65d1ab625bcdab41639028c42f712b26) +* [Item](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks_1af1e6de7d83b5af2ae699785b1d61fb1c) + +## Properties + + +### Property Count + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IVariableLinks::Count +``` + + + +Number of Links. + + + +**Return type**: VARIANT + +## Public functions + + +### Function Item + +![][public] + +``` +VARIANT ModelCenter::IVariableLinks::Item(VARIANT id) +``` + + + +Gets the specified Link object. + + + + + + +**Parameters**: + +* **id**: ID of the specified Link. It can be a name or an index (0-based index). In the case of a name, it looks for the link based on the LHS variable's name. + + +**Returns**: + +IDispatch* to an [IVariableLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink) object. + + + +**Parameters**: + +* VARIANT **id** + +**Return type**: VARIANT + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariables.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariables.md index 32ed90872b..913b355cff 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariables.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVariables.md @@ -1,78 +1,77 @@ - -# Interface ModelCenter::IVariables - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6096) - - - -COM Instance. - -## Members - -* [Count](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables_1a5805886fd173e6fc77a3387d5f1c6b95) -* [Item](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables_1a68b42951fd19cf993eef52d372dbdb84) - -## Properties - - -### Property Count - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -VARIANT ModelCenter::IVariables::Count -``` - - - -Number of variables. - - - -**Return type**: VARIANT - -## Public functions - - -### Function Item - -![][public] - -``` -VARIANT ModelCenter::IVariables::Item(VARIANT id) -``` - - - -Gets a pointer to the specified variable. - - - - - - -**Parameters**: - -* **id**: ID of the specified variable. It can be a name or an index (0-based index). - - -**Returns**: - -IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object. - - - -**Parameters**: - -* VARIANT **id** - -**Return type**: VARIANT - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IVariables + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6096) + + + +COM Instance. + +## Members + +* [Count](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables_1a5805886fd173e6fc77a3387d5f1c6b95) +* [Item](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables_1a68b42951fd19cf993eef52d372dbdb84) + +## Properties + + +### Property Count + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +VARIANT ModelCenter::IVariables::Count +``` + + + +Number of variables. + + + +**Return type**: VARIANT + +## Public functions + + +### Function Item + +![][public] + +``` +VARIANT ModelCenter::IVariables::Item(VARIANT id) +``` + + + +Gets a pointer to the specified variable. + + + + + + +**Parameters**: + +* **id**: ID of the specified variable. It can be a name or an index (0-based index). + + +**Returns**: + +IDispatch* to an [IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) object. + + + +**Parameters**: + +* VARIANT **id** + +**Return type**: VARIANT + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVizContainer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVizContainer.md index 7308428324..4d54fa5b01 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVizContainer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceModelCenter_1_1IVizContainer.md @@ -1,169 +1,168 @@ - -# Interface ModelCenter::IVizContainer - -![][IDL] -![][private] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6706) - - - -COM instance of a Viz Constainer that allows basic access like show(), hide(), Visible and to the underlying implementation of IDataExplorerPlugIn. - -## Members - -* [fileSaved](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a380f514b047b16f7cfb2fa4bacba4e6c) -* [hide](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a12129753b07898622d2e8a55801ef19d) -* [HWnd](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a4971d80a859be3f620c329dbc5019d7d) -* [id](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a1022454788e8b96f6e84ad60e652bbe3) -* [show](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1ae8ccfc592c21eb6adffad9502e4b28fb) -* [showAt](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a69bf3249d5ef44ef0eee2152724f9457) -* [Visible](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a4e7368bd0265ae9a637cfd675b5bd264) - -## Properties - - -### Property Visible - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -boolean ModelCenter::IVizContainer::Visible -``` - - - -Indicates whether container is visible. - - - -**Return type**: boolean - - -### Property HWnd - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) - -``` -long ModelCenter::IVizContainer::HWnd -``` - - - -Returns the Hwnd for the container instance. - - - -**Return type**: long - - -### Property id - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6729) - -``` -DataExplorer ModelCenter::IVizContainer::id -``` - - - -Returns the COM instance of IDataExplorerPlugIn implementation of the container. This is a read-only property. - - - -**Return type**: DataExplorer - -## Public functions - - -### Function hide - -![][public] - -``` -void ModelCenter::IVizContainer::hide() -``` - - - -Hides the container. Does not remove or close it. - - - -**Return type**: void - - -### Function show - -![][public] - -``` -void ModelCenter::IVizContainer::show() -``` - - - -Displays the container and brings it to foreground. - - - -**Return type**: void - - -### Function fileSaved - -![][public] - -``` -void ModelCenter::IVizContainer::fileSaved() -``` - - - -Tell the container that the file was saved - - - -**Return type**: void - - -### Function showAt - -![][public] - -``` -void ModelCenter::IVizContainer::showAt(long top, long left, long width, long height, [optional] VARIANT state) -``` - - - -Displays the container at the given position in the given state. -**Parameters**: - -* **top**: the top position of the window -* **left**: the left position of the window -* **width**: the width of the window -* **height**: the height of the window -* **state**: [optional] the state of the window (SW_NORMAL, SW_MINIMIZE, SW_MAXIMIZE) - - - -**Parameters**: - -* long **top** -* long **left** -* long **width** -* long **height** -* _[optional]_ VARIANT **state** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface ModelCenter::IVizContainer + +![][IDL] +![][private] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6706) + + + +COM instance of a Viz Constainer that allows basic access like show(), hide(), Visible and to the underlying implementation of IDataExplorerPlugIn. + +## Members + +* [fileSaved](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a380f514b047b16f7cfb2fa4bacba4e6c) +* [hide](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a12129753b07898622d2e8a55801ef19d) +* [HWnd](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a4971d80a859be3f620c329dbc5019d7d) +* [id](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a1022454788e8b96f6e84ad60e652bbe3) +* [show](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1ae8ccfc592c21eb6adffad9502e4b28fb) +* [showAt](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a69bf3249d5ef44ef0eee2152724f9457) +* [Visible](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer_1a4e7368bd0265ae9a637cfd675b5bd264) + +## Properties + + +### Property Visible + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +boolean ModelCenter::IVizContainer::Visible +``` + + + +Indicates whether container is visible. + + + +**Return type**: boolean + + +### Property HWnd + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 1) + +``` +long ModelCenter::IVizContainer::HWnd +``` + + + +Returns the Hwnd for the container instance. + + + +**Return type**: long + + +### Property id + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 6729) + +``` +DataExplorer ModelCenter::IVizContainer::id +``` + + + +Returns the COM instance of IDataExplorerPlugIn implementation of the container. This is a read-only property. + + + +**Return type**: DataExplorer + +## Public functions + + +### Function hide + +![][public] + +``` +void ModelCenter::IVizContainer::hide() +``` + + + +Hides the container. Does not remove or close it. + + + +**Return type**: void + + +### Function show + +![][public] + +``` +void ModelCenter::IVizContainer::show() +``` + + + +Displays the container and brings it to foreground. + + + +**Return type**: void + + +### Function fileSaved + +![][public] + +``` +void ModelCenter::IVizContainer::fileSaved() +``` + + + +Tell the container that the file was saved + + + +**Return type**: void + + +### Function showAt + +![][public] + +``` +void ModelCenter::IVizContainer::showAt(long top, long left, long width, long height, [optional] VARIANT state) +``` + + + +Displays the container at the given position in the given state. +**Parameters**: + +* **top**: the top position of the window +* **left**: the left position of the window +* **width**: the width of the window +* **height**: the height of the window +* **state**: [optional] the state of the window (SW_NORMAL, SW_MINIMIZE, SW_MAXIMIZE) + + + +**Parameters**: + +* long **top** +* long **left** +* long **width** +* long **height** +* _[optional]_ VARIANT **state** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner.md index 8fc2e715d1..1eda4fb0fb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner.md @@ -1,17 +1,16 @@ - -# Interface PHXDATAEXPLORERLib::IDataExplorerFacadeOwner - -![][IDL] -![][private] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 445) - - - -An interface that represents something that can own a facade DataExplorer. Implemented by the Legacy DE so that it can have a reference to the Mux DE. The Mux DE needs to call getKeepalive on the DE when it is visible. - -## Members - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface PHXDATAEXPLORERLib::IDataExplorerFacadeOwner + +![][IDL] +![][private] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 445) + + + +An interface that represents something that can own a facade DataExplorer. Implemented by the Legacy DE so that it can have a reference to the Mux DE. The Mux DE needs to call getKeepalive on the DE when it is visible. + +## Members + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md index 9c0990d72f..adadbfe390 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md @@ -1,59 +1,58 @@ - -# Interface PHXDATAEXPLORERLib::ILegacyVisiblity - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 511) - - - -An interface facilitating the ability to show a legacy DataExplorer - -## Members - -* [getLegacyHWND](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity_1a7a2562683a18b86dee7b0cb60564b5e6) -* [showLegacy](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity_1af5b6718a60c0ac08286e7ae40df8332a) - -## Public functions - - -### Function showLegacy - -![][public] - -``` -void PHXDATAEXPLORERLib::ILegacyVisiblity::showLegacy() -``` - - - -Will show the Legacy DataExplorer associated with this object. - - - -**Return type**: void - - -### Function getLegacyHWND - -![][public] - -``` -long PHXDATAEXPLORERLib::ILegacyVisiblity::getLegacyHWND() -``` - - - -Get the HWND of this legacy DataExplorer -**Returns**: - -the HWND - - - -**Return type**: long - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface PHXDATAEXPLORERLib::ILegacyVisiblity + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 511) + + + +An interface facilitating the ability to show a legacy DataExplorer + +## Members + +* [getLegacyHWND](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity_1a7a2562683a18b86dee7b0cb60564b5e6) +* [showLegacy](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity_1af5b6718a60c0ac08286e7ae40df8332a) + +## Public functions + + +### Function showLegacy + +![][public] + +``` +void PHXDATAEXPLORERLib::ILegacyVisiblity::showLegacy() +``` + + + +Will show the Legacy DataExplorer associated with this object. + + + +**Return type**: void + + +### Function getLegacyHWND + +![][public] + +``` +long PHXDATAEXPLORERLib::ILegacyVisiblity::getLegacyHWND() +``` + + + +Get the HWND of this legacy DataExplorer +**Returns**: + +the HWND + + + +**Return type**: long + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive.md index ed8cac3063..17367df197 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive.md @@ -1,17 +1,16 @@ - -# Interface PHXDATAEXPLORERLib::IPHXDEKeepalive - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 429) - - - - - -## Members - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface PHXDATAEXPLORERLib::IPHXDEKeepalive + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 429) + + + + + +## Members + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md index 207f9ba703..a2b902eba3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md @@ -1,38 +1,37 @@ - -# Interface PHXDATAEXPLORERLib::IPHXDataExplorerPointer - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 391) - - - -A pointer class used to prevent circular dependencies between Data Explorer, Data History, and Data Explorer Plug-Ins. - -## Members - -* [getDataExplorer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer_1aa6b13b15afbe694654cbba4b3fa1157e) - -## Public functions - - -### Function getDataExplorer - -![][public] - -``` -IDispatch * PHXDATAEXPLORERLib::IPHXDataExplorerPointer::getDataExplorer() -``` - - - -Returns a new pointer to the associated Data Explorer Object. Do not store this object locally, use it temporarily and release it as soon as you are done with it. Otherwise, circular dependencies will prevent proper cleanup of memory allocation. - - - -**Return type**: IDispatch * - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface PHXDATAEXPLORERLib::IPHXDataExplorerPointer + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 391) + + + +A pointer class used to prevent circular dependencies between Data Explorer, Data History, and Data Explorer Plug-Ins. + +## Members + +* [getDataExplorer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer_1aa6b13b15afbe694654cbba4b3fa1157e) + +## Public functions + + +### Function getDataExplorer + +![][public] + +``` +IDispatch * PHXDATAEXPLORERLib::IPHXDataExplorerPointer::getDataExplorer() +``` + + + +Returns a new pointer to the associated Data Explorer Object. Do not store this object locally, use it temporarily and release it as soon as you are done with it. Otherwise, circular dependencies will prevent proper cleanup of memory allocation. + + + +**Return type**: IDispatch * + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md index 8ef6c3e1a4..4557fe2578 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md @@ -1,147 +1,146 @@ - -# Interface PHXDATAEXPLORERLib::IPageVisibility - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 466) - - - -An interface that represents something that has a number of pages which all have visibility that can be individually controlled. It also should support having a specific data view that can be given focus. - -## Members - -* [getDataViewHWND](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1a00bc608cb2e87ea6a12c4da4497c4768) -* [getViewHWND](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1a19d4d225ecc6463333715ddde8c5f65f) -* [hide](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1aed414820e7a805ab6ba5d08c437d7347) -* [isVisible](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1aa52adfedbec735ae4d1e34c4daf66455) -* [show](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1a0e233fef605747c79f16a6032e4ebd01) - -## Public functions - - -### Function hide - -![][public] - -``` -void PHXDATAEXPLORERLib::IPageVisibility::hide(long index) -``` - - - -Hide the page at the specified index. Does nothing if the page is already hidden -**Parameters**: - -* **index**: the index of the page to hide - - - -**Parameters**: - -* long **index** - -**Return type**: void - - -### Function show - -![][public] - -``` -void PHXDATAEXPLORERLib::IPageVisibility::show(long index) -``` - - - -Show the page at the specified index. Does nothing if the page is already shown. -**Parameters**: - -* **index**: the index of the page to show - - - -**Parameters**: - -* long **index** - -**Return type**: void - - -### Function isVisible - -![][public] - -``` -boolean PHXDATAEXPLORERLib::IPageVisibility::isVisible(long index) -``` - - - -Get whether or not the page at the specified index is currently visible. -**Return values**: - -* **true**: if the page is currently visible -* **false**: if the page is not currently visible - - - -**Parameters**: - -* long **index** - -**Return type**: boolean - - -### Function getDataViewHWND - -![][public] - -``` -long PHXDATAEXPLORERLib::IPageVisibility::getDataViewHWND() -``` - - - -Retrieves the HWND that represents the Data View (aka TableView) so that it can have its focus set -**Returns**: - -the HWND representing the Data View - - - -**Return type**: long - - -### Function getViewHWND - -![][public] - -``` -long PHXDATAEXPLORERLib::IPageVisibility::getViewHWND(long index) -``` - - - -Get the HWND representing the given view -**Parameters**: - -* **the**: index of the page or view - - -**Returns**: - -the HWND representing the page or view - - - -**Parameters**: - -* long **index** - -**Return type**: long - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface PHXDATAEXPLORERLib::IPageVisibility + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 466) + + + +An interface that represents something that has a number of pages which all have visibility that can be individually controlled. It also should support having a specific data view that can be given focus. + +## Members + +* [getDataViewHWND](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1a00bc608cb2e87ea6a12c4da4497c4768) +* [getViewHWND](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1a19d4d225ecc6463333715ddde8c5f65f) +* [hide](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1aed414820e7a805ab6ba5d08c437d7347) +* [isVisible](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1aa52adfedbec735ae4d1e34c4daf66455) +* [show](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility_1a0e233fef605747c79f16a6032e4ebd01) + +## Public functions + + +### Function hide + +![][public] + +``` +void PHXDATAEXPLORERLib::IPageVisibility::hide(long index) +``` + + + +Hide the page at the specified index. Does nothing if the page is already hidden +**Parameters**: + +* **index**: the index of the page to hide + + + +**Parameters**: + +* long **index** + +**Return type**: void + + +### Function show + +![][public] + +``` +void PHXDATAEXPLORERLib::IPageVisibility::show(long index) +``` + + + +Show the page at the specified index. Does nothing if the page is already shown. +**Parameters**: + +* **index**: the index of the page to show + + + +**Parameters**: + +* long **index** + +**Return type**: void + + +### Function isVisible + +![][public] + +``` +boolean PHXDATAEXPLORERLib::IPageVisibility::isVisible(long index) +``` + + + +Get whether or not the page at the specified index is currently visible. +**Return values**: + +* **true**: if the page is currently visible +* **false**: if the page is not currently visible + + + +**Parameters**: + +* long **index** + +**Return type**: boolean + + +### Function getDataViewHWND + +![][public] + +``` +long PHXDATAEXPLORERLib::IPageVisibility::getDataViewHWND() +``` + + + +Retrieves the HWND that represents the Data View (aka TableView) so that it can have its focus set +**Returns**: + +the HWND representing the Data View + + + +**Return type**: long + + +### Function getViewHWND + +![][public] + +``` +long PHXDATAEXPLORERLib::IPageVisibility::getViewHWND(long index) +``` + + + +Get the HWND representing the given view +**Parameters**: + +* **the**: index of the page or view + + +**Returns**: + +the HWND representing the page or view + + + +**Parameters**: + +* long **index** + +**Return type**: long + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md index 8c8b9a0d7c..0ef2365734 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md @@ -1,1507 +1,1506 @@ - -# Interface PHXDATAEXPLORERLib::\_DPHXDataExplorer - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 35) - - - -The Data Explorer object represents a Data Explorer window, the enclosed Data History, all the pages, and associated meta-data. This API supercedes the Data Collector API (which still works for backwards compatibility). - -## Members - -* [addPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af65679f9d81fa741896f22fb959f81d1) -* [addRunsToComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a7e608fa73c8645388956a6c1538438af) -* [addToComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2b46272c7cead32a5f75319eecddbc87) -* [associatedModelFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a145b2ba8b5de9c0bac5b0ac89ad7f960) -* [associatedModelFileUUID](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad91c318a844622c7673df74c0f92128b) -* [author](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a8acab1f7a5d2caa0ab47d0d74247497e) -* [creationDate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a4e0ab1e84c6e9f6ddd62ec774c75f42c) -* [description](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a29b8b160371c7db191f6e3dd0e1fc414) -* [displayName](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a5f8b196a046e313bc7d50d6ac80ec29d) -* [ensureRunDataAction](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab5a2bb675d76aca81691538b7ef55ef9) -* [exportImage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2dc01f47f79342cc3893c66a8be1fb12) -* [fromCenterLink](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab68593eb479ef9f2684e7e8e683ed0bd) -* [fromXML](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aef1e4bfd5cd8b8e28d6e26b06483629f) -* [fromXMLFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a4ea300c891cc45556fdd4b1e7988274d) -* [fromXMLSaveContext](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a237c798449d1bd63e69905b53fe17d06) -* [getDaXFormat](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2559ee7d7f32bbcebd0d18bb145bd012) -* [getDaXType](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af8150d8d7d5f6fc37eb3bdf0a27fc817) -* [getHWND](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a27e733b7b61329799abe081c40b00394) -* [getKeepalive](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa49db3c3a511089125f6ce44a1ec838f) -* [getMenuItems](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1c15433a3ca058372e666abbaa1e1fa6) -* [getNumPages](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a389bca42567d788cb1c1c619a400109f) -* [getPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a3da50454f5e424f4aa3971d84f7387c4) -* [getPageSetup](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ac36fc1456cb55f50ccf9046d617b7187) -* [getPageTitle](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a91b7a788be45f38d1cea9579731e794c) -* [getPageType](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2e8a2fc452e5d1bad94bedf2edfe3ca5) -* [getSelectedPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2dfa9fbb916798751f0fbac5ca3d2fa8) -* [hide](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1adcc3bc6f74b07b516bbc98361b36d4d6) -* [id](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa3402e5d6822ebe510cc7fec192d5094) -* [id](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a75bed8e4832c534f7d7842ec7921e652) -* [ignoreDefaultPlotSetup](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a0c7a09c2192beadb073ce041aa0e8893) -* [invokeInsertPageGUI](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a0f0eb77a79bbc31706335b91e6a2923a) -* [invokeMenuItem](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2a636f7492de925506cd78a80e37deca) -* [isMenuItemChecked](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa6aabcb973d32ab328fa815d38d2da7f) -* [isMenuItemEnabled](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a23f32ddd6ea2d2d268351327a03e46b5) -* [isVisible](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a876e3d3fad4e109897eb41df8252cee4) -* [loadTemplate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1945a9df23ff32406e48f560a14ea592) -* [movePage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa890fee8f830a7ca7e04840962c2cece) -* [multiDelete](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad9dc21008ad2ddd47dfc339328d454da) -* [multiPageCopy](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1eca7b9ded4f6956ccfa95b11629021d) -* [multiPageCut](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ae2457af6aec2f86ffb328421ad2051e7) -* [pageCopy](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1241ff0682653a4b92dd9b6064d0bf42) -* [pageCut](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1925e33cfa2ae4e284cef4b8255c92dd) -* [pagePaste](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a08c390d4e7e3ff7f93a60283464c7826) -* [removeFromComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa30551e6356933878904d49df1239bd3) -* [removePage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a75118395c50e7e2dc424d3f3eeba8fa6) -* [saveTemplate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a3919d10a314c536703149f6377f7f924) -* [selectPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2110d97cf0636bd118ea3197ef9ba134) -* [setGeomViewerRunID](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af1cd6cc367767eafd9ee19b54cac0305) -* [setupPlotsPost](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2f726b811f8e11e39612bfd8b082ef68) -* [setupPlotsPre](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a21238a932694565dbf0e2115c80ae59b) -* [show](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad1f82e4921ee4c4db89b43fe92bf171d) -* [showGeomTooltip](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a89fb0170b61fdd2e320c52a8b370e99c) -* [showGeomViewer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a7d467a6fb859b8cb7f63c04f84f75dfa) -* [toXML](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1afc2dbe6d642993070f320d76f0b1f6b6) -* [toXMLFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a889efcee9f2e90cf7de94b3d521f4cdd) -* [toXMLSaveContext](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a9ce95b6c36069c784ea2389d85dde7ec) -* [tradeStudyUri](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aefa05eb2c41402bebce7e388d06d08e8) -* [updateComparisonViewHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad687c055e59a0bb50aac411174fa9a70) -* [updateGeomViewerHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab9e6e926290d9a829d5e90b17911fb22) -* [updateThumbHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1adda950ce0660029538ab7bdb541c6f2c) - -## Properties - - -### Property author - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 1) - -``` -BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::author -``` - - - -The author of the data in this Data Explorer. - - - -**Return type**: BSTR - - -### Property description - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 1) - -``` -BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::description -``` - - - -A description of the data in this Data Explorer. - - - -**Return type**: BSTR - - -### Property displayName - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 1) - -``` -BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::displayName -``` - - - -A display name for this Data Explorer. - - - -**Return type**: BSTR - - -### Property id - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 66) - -``` -tradeStudyType PHXDATAEXPLORERLib::_DPHXDataExplorer::id -``` - - - -A pointer to the associated ModelCenter session. Points to a [ModelCenter.Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) or [ModelCenter.IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) object. - - - -**Return type**: tradeStudyType - - -### Property id - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 74) - -``` -tradeStudySetup PHXDATAEXPLORERLib::_DPHXDataExplorer::id -``` - - - -A pointer to the included Data History object. - - - -**Return type**: tradeStudySetup - - -### Property associatedModelFile - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 1) - -``` -BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::associatedModelFile -``` - - - -The filename of the associated model file for this Data Explorer. - - - -**Return type**: BSTR - - -### Property associatedModelFileUUID - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 1) - -``` -BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::associatedModelFileUUID -``` - - - -The UUID of the associated Model. - - - -**Return type**: BSTR - - -### Property creationDate - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 1) - -``` -BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::creationDate -``` - - - -The creation date of the model. - - - -**Return type**: BSTR - - -### Property tradeStudyUri - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 1) - -``` -BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::tradeStudyUri -``` - - - -The URI of the file loaded in this object, empty for no currently loaded file. Changing this does not load a new file, it is merely a container for a string. - - - -**Return type**: BSTR - - -### Property isVisible - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 347) - -``` -PHXDATAEXPLORERLib::_DPHXDataExplorer::isVisible -``` - - - -Is the window visible? - - - -**Return type**: - -## Public functions - - -### Function getNumPages - -![][public] - -``` -long PHXDATAEXPLORERLib::_DPHXDataExplorer::getNumPages() -``` - - - -Gets the number of pages in this Data Explorer. -**Returns**: - -The number of pages. - - - -**Return type**: long - - -### Function getPage - -![][public] - -``` -IDispatch * PHXDATAEXPLORERLib::_DPHXDataExplorer::getPage(long page) -``` - - - -Get an IDispatch for the requested page. - - - - - - -**Parameters**: - -* **page**: The 0 based index to the requested page. - - -**Returns**: - -An IDispatch for the requested page. This pointer is guaranteed to implement [PHXDataExplorerPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) and may additionally implement other interfaces. - - - -**Parameters**: - -* long **page** - -**Return type**: IDispatch * - - -### Function addPage - -![][public] - -``` -IDispatch * PHXDATAEXPLORERLib::_DPHXDataExplorer::addPage(BSTR type, VARIANT insertBefore, VARIANT setupString) -``` - - - -Adds a new page to the Data Explorer. - - - - - - -**Parameters**: - -* **type**: Select the type of page to create. May be a COM Application ID (such as PHXCarpetPlot.Application) or a name as registered with [ModelCenter](namespaceModelCenter.md#namespaceModelCenter)'s PlugIn Manager's Data Explorer Plug-Ins section (such as "Carpet Plot"). -* **insertBefore**: Where to insert the page. May be -1 or omitted to place at the end. -* **setupString**: An optional string to pass to the newly created page's [fromString()](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a889e85b07599a03c7a262297629d0763) call. Format is page dependent. - - -**Returns**: - -The IDispatch of the newly created page. This pointer is guaranteed to implement [PHXDataExplorerPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) and may additionally implement other interfaces. - - - -**Parameters**: - -* BSTR **type** -* VARIANT **insertBefore** -* VARIANT **setupString** - -**Return type**: IDispatch * - - -### Function removePage - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::removePage(long page) -``` - - - -Removes the requested page from the Data Explorer. - - - - - - -**Parameters**: - -* **page**: The 0 based index of the page to remove. - - - -**Parameters**: - -* long **page** - -**Return type**: void - - -### Function movePage - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::movePage(long page, long insertBefore) -``` - - - -Moves a page within the Data Explorer. - - - - - - -**Parameters**: - -* **page**: The 0 based index of the page to move. -* **insertBefore**: The 0 based index of where to put the page. May be -1 to put the page at the end. - - - -**Parameters**: - -* long **page** -* long **insertBefore** - -**Return type**: void - - -### Function selectPage - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::selectPage(long page) -``` - - - -Selects and makes visible the requested page. - - - - - - -**Parameters**: - -* **page**: The 0 based index of the page to select. - - - -**Parameters**: - -* long **page** - -**Return type**: void - - -### Function getSelectedPage - -![][public] - -``` -long PHXDATAEXPLORERLib::_DPHXDataExplorer::getSelectedPage() -``` - - - -Returns a 0 based index to which page is currently selected. -**Returns**: - -The index of the currently selected page. - - - -**Return type**: long - - -### Function pageCut - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::pageCut(long index) -``` - - - -Causes the "page template" for the selected page to be put on the clipboard and the page to be removed. - - - - - - -**Parameters**: - -* **index**: The 0 based index of the page to cut. - - - -**Parameters**: - -* long **index** - -**Return type**: void - - -### Function pageCopy - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::pageCopy(long index) -``` - - - -Causes the "page template" for the selected page to be put on the clipboard. - - - - - - -**Parameters**: - -* **index**: The 0 based index of the page to copy. - - - -**Parameters**: - -* long **index** - -**Return type**: void - - -### Function pagePaste - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::pagePaste() -``` - - - -Causes the page template currently on the clipboard to be pasted into the Data Explorer. - - - -**Return type**: void - - -### Function invokeInsertPageGUI - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::invokeInsertPageGUI() -``` - - - -Causes the "Add New Page" dialog to be presented to the user the same as if they had clicked on "Add Page/Chart" - - - -**Return type**: void - - -### Function toXMLFile - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::toXMLFile(BSTR fileName, [optional]VARIANT includeRunData) -``` - - - -Saves the current state of the Data Explorer and all the included meta-data and pages to an XML file. - - - - - - -**Parameters**: - -* **fileName**: The file to save to. -* **includeRunData**:
- - - -**Parameters**: - -* BSTR **fileName** -* _[optional]_ VARIANT **includeRunData** - -**Return type**: void - - -### Function getPageType - -![][public] - -``` -BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::getPageType(long page) -``` - - - -Gets the type of page for the requested page. May be a COM Application ID (such as PHXCarpetPlot.Application) or a name as registered with [ModelCenter](namespaceModelCenter.md#namespaceModelCenter)'s PlugIn Manager's Data Explorer Plug-Ins section (such as "Carpet Plot"). - - - - - - -**Parameters**: - -* **page**: The 0 based index to the requested page. - - -**Returns**: - -The type of the requested page. - - - -**Parameters**: - -* long **page** - -**Return type**: BSTR - - -### Function fromXMLFile - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::fromXMLFile(BSTR fileName, [optional]VARIANT root) -``` - - - -Loads the contents of the Data Explorer from an XML file. - - - - - - -**Parameters**: - -* **fileName**: The filename of the file to load. -* **root**: The node ID of the node to begin reading at. This is useful if you are loading a larger document which contains a Data Explorer node as a child. - - - -**Parameters**: - -* BSTR **fileName** -* _[optional]_ VARIANT **root** - -**Return type**: void - - -### Function toXML - -![][public] - -``` -BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::toXML([optional]VARIANT includeRunData) -``` - - - -Saves the current state of the Data Explorer and all the included meta-data and pages to an XML string. - - - - - - -**Parameters**: - -* **includeRunData**:
- - -**Returns**: - -An XML string representing the Data Explorer's state. - - - -**Parameters**: - -* _[optional]_ VARIANT **includeRunData** - -**Return type**: BSTR - - -### Function fromXML - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::fromXML(BSTR xml, [optional] VARIANT root) -``` - - - -Loads the contents of the Data Explorer from an XML string. - - - - - - -**Parameters**: - -* **xml**: The XML data to load. -* **root**: The node ID of the node to begin reading at. This is useful if you are loading a larger document which contains a Data Explorer node as a child. - - - -**Parameters**: - -* BSTR **xml** -* _[optional]_ VARIANT **root** - -**Return type**: void - - -### Function getMenuItems - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::getMenuItems(LPDISPATCH iPHXMenuItem) -``` - - - -**Deprecated**: - -Deprecated. Do not use. - - - -**Parameters**: - -* LPDISPATCH **iPHXMenuItem** - -**Return type**: void - - -### Function invokeMenuItem - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::invokeMenuItem(long id) -``` - - - -**Deprecated**: - -Deprecated. Do not use. - - - -**Parameters**: - -* long **id** - -**Return type**: void - - -### Function isMenuItemEnabled - -![][public] - -``` -boolean PHXDATAEXPLORERLib::_DPHXDataExplorer::isMenuItemEnabled(long id) -``` - - - -**Deprecated**: - -Deprecated. Do not use. - - - -**Parameters**: - -* long **id** - -**Return type**: boolean - - -### Function updateThumbHint - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::updateThumbHint(long id) -``` - - - -**Deprecated**: - -Deprecated. Do not use. - - - -**Parameters**: - -* long **id** - -**Return type**: void - - -### Function getPageSetup - -![][public] - -``` -BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::getPageSetup(long page) -``` - - - -Get the setup string for a page. This is exactly what the page returns from its toString() method. - - - - - - -**Parameters**: - -* **page**: The 0 based index of the page to query. - - -**Returns**: - -Returns the setup string for a page. - - - -**Parameters**: - -* long **page** - -**Return type**: BSTR - - -### Function exportImage - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::exportImage(long page, BSTR hints, BSTR filename) -``` - - - -Causes a page to export an image to an enhanced metafile (emf) file. - - - - - - -**Parameters**: - -* **page**: The page number to export. -* **hints**: Unused. -* **filename**: The filename to write. - - - -**Parameters**: - -* long **page** -* BSTR **hints** -* BSTR **filename** - -**Return type**: void - - -### Function multiPageCut - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::multiPageCut(VARIANT index) -``` - - - -Cuts multiple pages to the clipboard. -**Parameters**: - -* **index**: String containing a comma seperated list of the indices of the pages to be cut. - - - -**Parameters**: - -* VARIANT **index** - -**Return type**: void - - -### Function multiPageCopy - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::multiPageCopy(VARIANT index) -``` - - - -Causes the comma-separated "page templates" for the selected indices to be put on the clipboard. -**Parameters**: - -* **index**: Indices of the pages. - - - -**Parameters**: - -* VARIANT **index** - -**Return type**: void - - -### Function multiDelete - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::multiDelete(VARIANT index) -``` - - - -Deletes the comma-separated "page templates" for the selected indices. -**Parameters**: - -* **index**: Indices of the pages. - - - -**Parameters**: - -* VARIANT **index** - -**Return type**: void - - -### Function loadTemplate - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::loadTemplate(BSTR str) -``` - - - -Causes the DataExplorer to remove all current pages, then import an XML document that describes new pages to display.
- - - - - - - -**Parameters**: - -* **str**: The filename to load. - - - -**Parameters**: - -* BSTR **str** - -**Return type**: void - - -### Function saveTemplate - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::saveTemplate(BSTR str) -``` - - - -Causes the DataExplorer to export an XML document describing the current pages. - - - - - - -**Parameters**: - -* **str**: The filename to write. - - - -**Parameters**: - -* BSTR **str** - -**Return type**: void - - -### Function toXMLSaveContext - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::toXMLSaveContext(LPDISPATCH saveContext, [optional] VARIANT includeRunData) -``` - - - -Writes the Data History contents to an XML file. - - - - - - -**Parameters**: - -* **saveContext**: Context to use when loading this file, used for storing large files and other data contained in the save file but not directly in the XML. -* **includeRunData**:
- - - -**Parameters**: - -* LPDISPATCH **saveContext** -* _[optional]_ VARIANT **includeRunData** - -**Return type**: void - - -### Function fromXMLSaveContext - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::fromXMLSaveContext(LPDISPATCH saveContext, [optional] VARIANT root) -``` - - - -Tells the Data History to load its state from the XML file passed in. - - - - - - -**Parameters**: - -* **saveContext**: Context to use when loading this file, used for storing large files and other data contained in the save file but not directly in the XML.
-* **root**: The node ID of the node to begin reading at. This is useful if you are loading a larger document which contains a Data History node as a child. - - - -**Parameters**: - -* LPDISPATCH **saveContext** -* _[optional]_ VARIANT **root** - -**Return type**: void - - -### Function show - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::show() -``` - - - -Show the associated window. - - - -**Return type**: void - - -### Function hide - -![][public] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::hide() -``` - - - -Hide the associated window. - - - -**Return type**: void - - -### Function getPageTitle - -![][public] - -``` -BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::getPageTitle(long page) -``` - - - -Get the title for the specified page. - - - -**Parameters**: - -* long **page** - -**Return type**: BSTR - -## Private functions - - -### Function fromCenterLink - -![][private] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::fromCenterLink(BSTR server, BSTR runMatrixID, BSTR userName, BSTR password) -``` - - - - - - - -**Parameters**: - -* BSTR **server** -* BSTR **runMatrixID** -* BSTR **userName** -* BSTR **password** - -**Return type**: void - - -### Function ignoreDefaultPlotSetup - -![][private] - -``` -boolean PHXDATAEXPLORERLib::_DPHXDataExplorer::ignoreDefaultPlotSetup() -``` - - - - - - - -**Return type**: boolean - - -### Function setupPlotsPre - -![][private] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::setupPlotsPre() -``` - - - - - - - -**Return type**: void - - -### Function setupPlotsPost - -![][private] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::setupPlotsPost() -``` - - - - - - - -**Return type**: void - - -### Function showGeomTooltip - -![][private] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::showGeomTooltip(long run, long x, long y) -``` - - - - - - - -**Parameters**: - -* long **run** -* long **x** -* long **y** - -**Return type**: void - - -### Function showGeomViewer - -![][private] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::showGeomViewer(long run, long x, long y) -``` - - - - - - - -**Parameters**: - -* long **run** -* long **x** -* long **y** - -**Return type**: void - - -### Function updateGeomViewerHint - -![][private] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::updateGeomViewerHint(long viewerID) -``` - - - - - - - -**Parameters**: - -* long **viewerID** - -**Return type**: void - - -### Function setGeomViewerRunID - -![][private] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::setGeomViewerRunID(long viewerID, long runID) -``` - - - - - - - -**Parameters**: - -* long **viewerID** -* long **runID** - -**Return type**: void - - -### Function updateComparisonViewHint - -![][private] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::updateComparisonViewHint(BOOL restore) -``` - - - - - - - -**Parameters**: - -* BOOL **restore** - -**Return type**: void - - -### Function isMenuItemChecked - -![][private] - -``` -boolean PHXDATAEXPLORERLib::_DPHXDataExplorer::isMenuItemChecked(long id) -``` - - - - - - - -**Parameters**: - -* long **id** - -**Return type**: boolean - - -### Function removeFromComparisonList - -![][private] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::removeFromComparisonList(long runID) -``` - - - - - - - -**Parameters**: - -* long **runID** - -**Return type**: void - - -### Function addToComparisonList - -![][private] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::addToComparisonList(long runID) -``` - - - - - - - -**Parameters**: - -* long **runID** - -**Return type**: void - - -### Function addRunsToComparisonList - -![][private] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::addRunsToComparisonList(VARIANT runIDs) -``` - - - - - - - -**Parameters**: - -* VARIANT **runIDs** - -**Return type**: void - - -### Function getDaXType - -![][private] - -``` -boolean PHXDATAEXPLORERLib::_DPHXDataExplorer::getDaXType() -``` - - - - - - - -**Return type**: boolean - - -### Function getDaXFormat - -![][private] - -``` -boolean PHXDATAEXPLORERLib::_DPHXDataExplorer::getDaXFormat() -``` - - - - - - - -**Return type**: boolean - - -### Function ensureRunDataAction - -![][private] - -``` -void PHXDATAEXPLORERLib::_DPHXDataExplorer::ensureRunDataAction() -``` - - - - - - - -**Return type**: void - - -### Function getKeepalive - -![][private] - -``` -IDispatch * PHXDATAEXPLORERLib::_DPHXDataExplorer::getKeepalive() -``` - - - - - - - -**Return type**: IDispatch * - - -### Function getHWND - -![][private] - -``` -long PHXDATAEXPLORERLib::_DPHXDataExplorer::getHWND() -``` - - - - - - - -**Return type**: long - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface PHXDATAEXPLORERLib::\_DPHXDataExplorer + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 35) + + + +The Data Explorer object represents a Data Explorer window, the enclosed Data History, all the pages, and associated meta-data. This API supercedes the Data Collector API (which still works for backwards compatibility). + +## Members + +* [addPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af65679f9d81fa741896f22fb959f81d1) +* [addRunsToComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a7e608fa73c8645388956a6c1538438af) +* [addToComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2b46272c7cead32a5f75319eecddbc87) +* [associatedModelFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a145b2ba8b5de9c0bac5b0ac89ad7f960) +* [associatedModelFileUUID](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad91c318a844622c7673df74c0f92128b) +* [author](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a8acab1f7a5d2caa0ab47d0d74247497e) +* [creationDate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a4e0ab1e84c6e9f6ddd62ec774c75f42c) +* [description](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a29b8b160371c7db191f6e3dd0e1fc414) +* [displayName](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a5f8b196a046e313bc7d50d6ac80ec29d) +* [ensureRunDataAction](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab5a2bb675d76aca81691538b7ef55ef9) +* [exportImage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2dc01f47f79342cc3893c66a8be1fb12) +* [fromCenterLink](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab68593eb479ef9f2684e7e8e683ed0bd) +* [fromXML](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aef1e4bfd5cd8b8e28d6e26b06483629f) +* [fromXMLFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a4ea300c891cc45556fdd4b1e7988274d) +* [fromXMLSaveContext](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a237c798449d1bd63e69905b53fe17d06) +* [getDaXFormat](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2559ee7d7f32bbcebd0d18bb145bd012) +* [getDaXType](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af8150d8d7d5f6fc37eb3bdf0a27fc817) +* [getHWND](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a27e733b7b61329799abe081c40b00394) +* [getKeepalive](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa49db3c3a511089125f6ce44a1ec838f) +* [getMenuItems](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1c15433a3ca058372e666abbaa1e1fa6) +* [getNumPages](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a389bca42567d788cb1c1c619a400109f) +* [getPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a3da50454f5e424f4aa3971d84f7387c4) +* [getPageSetup](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ac36fc1456cb55f50ccf9046d617b7187) +* [getPageTitle](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a91b7a788be45f38d1cea9579731e794c) +* [getPageType](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2e8a2fc452e5d1bad94bedf2edfe3ca5) +* [getSelectedPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2dfa9fbb916798751f0fbac5ca3d2fa8) +* [hide](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1adcc3bc6f74b07b516bbc98361b36d4d6) +* [id](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa3402e5d6822ebe510cc7fec192d5094) +* [id](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a75bed8e4832c534f7d7842ec7921e652) +* [ignoreDefaultPlotSetup](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a0c7a09c2192beadb073ce041aa0e8893) +* [invokeInsertPageGUI](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a0f0eb77a79bbc31706335b91e6a2923a) +* [invokeMenuItem](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2a636f7492de925506cd78a80e37deca) +* [isMenuItemChecked](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa6aabcb973d32ab328fa815d38d2da7f) +* [isMenuItemEnabled](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a23f32ddd6ea2d2d268351327a03e46b5) +* [isVisible](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a876e3d3fad4e109897eb41df8252cee4) +* [loadTemplate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1945a9df23ff32406e48f560a14ea592) +* [movePage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa890fee8f830a7ca7e04840962c2cece) +* [multiDelete](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad9dc21008ad2ddd47dfc339328d454da) +* [multiPageCopy](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1eca7b9ded4f6956ccfa95b11629021d) +* [multiPageCut](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ae2457af6aec2f86ffb328421ad2051e7) +* [pageCopy](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1241ff0682653a4b92dd9b6064d0bf42) +* [pageCut](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a1925e33cfa2ae4e284cef4b8255c92dd) +* [pagePaste](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a08c390d4e7e3ff7f93a60283464c7826) +* [removeFromComparisonList](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aa30551e6356933878904d49df1239bd3) +* [removePage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a75118395c50e7e2dc424d3f3eeba8fa6) +* [saveTemplate](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a3919d10a314c536703149f6377f7f924) +* [selectPage](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2110d97cf0636bd118ea3197ef9ba134) +* [setGeomViewerRunID](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1af1cd6cc367767eafd9ee19b54cac0305) +* [setupPlotsPost](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a2f726b811f8e11e39612bfd8b082ef68) +* [setupPlotsPre](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a21238a932694565dbf0e2115c80ae59b) +* [show](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad1f82e4921ee4c4db89b43fe92bf171d) +* [showGeomTooltip](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a89fb0170b61fdd2e320c52a8b370e99c) +* [showGeomViewer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a7d467a6fb859b8cb7f63c04f84f75dfa) +* [toXML](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1afc2dbe6d642993070f320d76f0b1f6b6) +* [toXMLFile](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a889efcee9f2e90cf7de94b3d521f4cdd) +* [toXMLSaveContext](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1a9ce95b6c36069c784ea2389d85dde7ec) +* [tradeStudyUri](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1aefa05eb2c41402bebce7e388d06d08e8) +* [updateComparisonViewHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ad687c055e59a0bb50aac411174fa9a70) +* [updateGeomViewerHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1ab9e6e926290d9a829d5e90b17911fb22) +* [updateThumbHint](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer_1adda950ce0660029538ab7bdb541c6f2c) + +## Properties + + +### Property author + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 1) + +``` +BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::author +``` + + + +The author of the data in this Data Explorer. + + + +**Return type**: BSTR + + +### Property description + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 1) + +``` +BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::description +``` + + + +A description of the data in this Data Explorer. + + + +**Return type**: BSTR + + +### Property displayName + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 1) + +``` +BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::displayName +``` + + + +A display name for this Data Explorer. + + + +**Return type**: BSTR + + +### Property id + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 66) + +``` +tradeStudyType PHXDATAEXPLORERLib::_DPHXDataExplorer::id +``` + + + +A pointer to the associated ModelCenter session. Points to a [ModelCenter.Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) or [ModelCenter.IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) object. + + + +**Return type**: tradeStudyType + + +### Property id + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 74) + +``` +tradeStudySetup PHXDATAEXPLORERLib::_DPHXDataExplorer::id +``` + + + +A pointer to the included Data History object. + + + +**Return type**: tradeStudySetup + + +### Property associatedModelFile + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 1) + +``` +BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::associatedModelFile +``` + + + +The filename of the associated model file for this Data Explorer. + + + +**Return type**: BSTR + + +### Property associatedModelFileUUID + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 1) + +``` +BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::associatedModelFileUUID +``` + + + +The UUID of the associated Model. + + + +**Return type**: BSTR + + +### Property creationDate + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 1) + +``` +BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::creationDate +``` + + + +The creation date of the model. + + + +**Return type**: BSTR + + +### Property tradeStudyUri + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 1) + +``` +BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::tradeStudyUri +``` + + + +The URI of the file loaded in this object, empty for no currently loaded file. Changing this does not load a new file, it is merely a container for a string. + + + +**Return type**: BSTR + + +### Property isVisible + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 347) + +``` +PHXDATAEXPLORERLib::_DPHXDataExplorer::isVisible +``` + + + +Is the window visible? + + + +**Return type**: + +## Public functions + + +### Function getNumPages + +![][public] + +``` +long PHXDATAEXPLORERLib::_DPHXDataExplorer::getNumPages() +``` + + + +Gets the number of pages in this Data Explorer. +**Returns**: + +The number of pages. + + + +**Return type**: long + + +### Function getPage + +![][public] + +``` +IDispatch * PHXDATAEXPLORERLib::_DPHXDataExplorer::getPage(long page) +``` + + + +Get an IDispatch for the requested page. + + + + + + +**Parameters**: + +* **page**: The 0 based index to the requested page. + + +**Returns**: + +An IDispatch for the requested page. This pointer is guaranteed to implement [PHXDataExplorerPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) and may additionally implement other interfaces. + + + +**Parameters**: + +* long **page** + +**Return type**: IDispatch * + + +### Function addPage + +![][public] + +``` +IDispatch * PHXDATAEXPLORERLib::_DPHXDataExplorer::addPage(BSTR type, VARIANT insertBefore, VARIANT setupString) +``` + + + +Adds a new page to the Data Explorer. + + + + + + +**Parameters**: + +* **type**: Select the type of page to create. May be a COM Application ID (such as PHXCarpetPlot.Application) or a name as registered with [ModelCenter](namespaceModelCenter.md#namespaceModelCenter)'s PlugIn Manager's Data Explorer Plug-Ins section (such as "Carpet Plot"). +* **insertBefore**: Where to insert the page. May be -1 or omitted to place at the end. +* **setupString**: An optional string to pass to the newly created page's [fromString()](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a889e85b07599a03c7a262297629d0763) call. Format is page dependent. + + +**Returns**: + +The IDispatch of the newly created page. This pointer is guaranteed to implement [PHXDataExplorerPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) and may additionally implement other interfaces. + + + +**Parameters**: + +* BSTR **type** +* VARIANT **insertBefore** +* VARIANT **setupString** + +**Return type**: IDispatch * + + +### Function removePage + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::removePage(long page) +``` + + + +Removes the requested page from the Data Explorer. + + + + + + +**Parameters**: + +* **page**: The 0 based index of the page to remove. + + + +**Parameters**: + +* long **page** + +**Return type**: void + + +### Function movePage + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::movePage(long page, long insertBefore) +``` + + + +Moves a page within the Data Explorer. + + + + + + +**Parameters**: + +* **page**: The 0 based index of the page to move. +* **insertBefore**: The 0 based index of where to put the page. May be -1 to put the page at the end. + + + +**Parameters**: + +* long **page** +* long **insertBefore** + +**Return type**: void + + +### Function selectPage + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::selectPage(long page) +``` + + + +Selects and makes visible the requested page. + + + + + + +**Parameters**: + +* **page**: The 0 based index of the page to select. + + + +**Parameters**: + +* long **page** + +**Return type**: void + + +### Function getSelectedPage + +![][public] + +``` +long PHXDATAEXPLORERLib::_DPHXDataExplorer::getSelectedPage() +``` + + + +Returns a 0 based index to which page is currently selected. +**Returns**: + +The index of the currently selected page. + + + +**Return type**: long + + +### Function pageCut + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::pageCut(long index) +``` + + + +Causes the "page template" for the selected page to be put on the clipboard and the page to be removed. + + + + + + +**Parameters**: + +* **index**: The 0 based index of the page to cut. + + + +**Parameters**: + +* long **index** + +**Return type**: void + + +### Function pageCopy + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::pageCopy(long index) +``` + + + +Causes the "page template" for the selected page to be put on the clipboard. + + + + + + +**Parameters**: + +* **index**: The 0 based index of the page to copy. + + + +**Parameters**: + +* long **index** + +**Return type**: void + + +### Function pagePaste + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::pagePaste() +``` + + + +Causes the page template currently on the clipboard to be pasted into the Data Explorer. + + + +**Return type**: void + + +### Function invokeInsertPageGUI + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::invokeInsertPageGUI() +``` + + + +Causes the "Add New Page" dialog to be presented to the user the same as if they had clicked on "Add Page/Chart" + + + +**Return type**: void + + +### Function toXMLFile + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::toXMLFile(BSTR fileName, [optional]VARIANT includeRunData) +``` + + + +Saves the current state of the Data Explorer and all the included meta-data and pages to an XML file. + + + + + + +**Parameters**: + +* **fileName**: The file to save to. +* **includeRunData**:
+ + + +**Parameters**: + +* BSTR **fileName** +* _[optional]_ VARIANT **includeRunData** + +**Return type**: void + + +### Function getPageType + +![][public] + +``` +BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::getPageType(long page) +``` + + + +Gets the type of page for the requested page. May be a COM Application ID (such as PHXCarpetPlot.Application) or a name as registered with [ModelCenter](namespaceModelCenter.md#namespaceModelCenter)'s PlugIn Manager's Data Explorer Plug-Ins section (such as "Carpet Plot"). + + + + + + +**Parameters**: + +* **page**: The 0 based index to the requested page. + + +**Returns**: + +The type of the requested page. + + + +**Parameters**: + +* long **page** + +**Return type**: BSTR + + +### Function fromXMLFile + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::fromXMLFile(BSTR fileName, [optional]VARIANT root) +``` + + + +Loads the contents of the Data Explorer from an XML file. + + + + + + +**Parameters**: + +* **fileName**: The filename of the file to load. +* **root**: The node ID of the node to begin reading at. This is useful if you are loading a larger document which contains a Data Explorer node as a child. + + + +**Parameters**: + +* BSTR **fileName** +* _[optional]_ VARIANT **root** + +**Return type**: void + + +### Function toXML + +![][public] + +``` +BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::toXML([optional]VARIANT includeRunData) +``` + + + +Saves the current state of the Data Explorer and all the included meta-data and pages to an XML string. + + + + + + +**Parameters**: + +* **includeRunData**:
+ + +**Returns**: + +An XML string representing the Data Explorer's state. + + + +**Parameters**: + +* _[optional]_ VARIANT **includeRunData** + +**Return type**: BSTR + + +### Function fromXML + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::fromXML(BSTR xml, [optional] VARIANT root) +``` + + + +Loads the contents of the Data Explorer from an XML string. + + + + + + +**Parameters**: + +* **xml**: The XML data to load. +* **root**: The node ID of the node to begin reading at. This is useful if you are loading a larger document which contains a Data Explorer node as a child. + + + +**Parameters**: + +* BSTR **xml** +* _[optional]_ VARIANT **root** + +**Return type**: void + + +### Function getMenuItems + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::getMenuItems(LPDISPATCH iPHXMenuItem) +``` + + + +**Deprecated**: + +Deprecated. Do not use. + + + +**Parameters**: + +* LPDISPATCH **iPHXMenuItem** + +**Return type**: void + + +### Function invokeMenuItem + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::invokeMenuItem(long id) +``` + + + +**Deprecated**: + +Deprecated. Do not use. + + + +**Parameters**: + +* long **id** + +**Return type**: void + + +### Function isMenuItemEnabled + +![][public] + +``` +boolean PHXDATAEXPLORERLib::_DPHXDataExplorer::isMenuItemEnabled(long id) +``` + + + +**Deprecated**: + +Deprecated. Do not use. + + + +**Parameters**: + +* long **id** + +**Return type**: boolean + + +### Function updateThumbHint + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::updateThumbHint(long id) +``` + + + +**Deprecated**: + +Deprecated. Do not use. + + + +**Parameters**: + +* long **id** + +**Return type**: void + + +### Function getPageSetup + +![][public] + +``` +BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::getPageSetup(long page) +``` + + + +Get the setup string for a page. This is exactly what the page returns from its toString() method. + + + + + + +**Parameters**: + +* **page**: The 0 based index of the page to query. + + +**Returns**: + +Returns the setup string for a page. + + + +**Parameters**: + +* long **page** + +**Return type**: BSTR + + +### Function exportImage + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::exportImage(long page, BSTR hints, BSTR filename) +``` + + + +Causes a page to export an image to an enhanced metafile (emf) file. + + + + + + +**Parameters**: + +* **page**: The page number to export. +* **hints**: Unused. +* **filename**: The filename to write. + + + +**Parameters**: + +* long **page** +* BSTR **hints** +* BSTR **filename** + +**Return type**: void + + +### Function multiPageCut + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::multiPageCut(VARIANT index) +``` + + + +Cuts multiple pages to the clipboard. +**Parameters**: + +* **index**: String containing a comma seperated list of the indices of the pages to be cut. + + + +**Parameters**: + +* VARIANT **index** + +**Return type**: void + + +### Function multiPageCopy + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::multiPageCopy(VARIANT index) +``` + + + +Causes the comma-separated "page templates" for the selected indices to be put on the clipboard. +**Parameters**: + +* **index**: Indices of the pages. + + + +**Parameters**: + +* VARIANT **index** + +**Return type**: void + + +### Function multiDelete + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::multiDelete(VARIANT index) +``` + + + +Deletes the comma-separated "page templates" for the selected indices. +**Parameters**: + +* **index**: Indices of the pages. + + + +**Parameters**: + +* VARIANT **index** + +**Return type**: void + + +### Function loadTemplate + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::loadTemplate(BSTR str) +``` + + + +Causes the DataExplorer to remove all current pages, then import an XML document that describes new pages to display.
+ + + + + + + +**Parameters**: + +* **str**: The filename to load. + + + +**Parameters**: + +* BSTR **str** + +**Return type**: void + + +### Function saveTemplate + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::saveTemplate(BSTR str) +``` + + + +Causes the DataExplorer to export an XML document describing the current pages. + + + + + + +**Parameters**: + +* **str**: The filename to write. + + + +**Parameters**: + +* BSTR **str** + +**Return type**: void + + +### Function toXMLSaveContext + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::toXMLSaveContext(LPDISPATCH saveContext, [optional] VARIANT includeRunData) +``` + + + +Writes the Data History contents to an XML file. + + + + + + +**Parameters**: + +* **saveContext**: Context to use when loading this file, used for storing large files and other data contained in the save file but not directly in the XML. +* **includeRunData**:
+ + + +**Parameters**: + +* LPDISPATCH **saveContext** +* _[optional]_ VARIANT **includeRunData** + +**Return type**: void + + +### Function fromXMLSaveContext + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::fromXMLSaveContext(LPDISPATCH saveContext, [optional] VARIANT root) +``` + + + +Tells the Data History to load its state from the XML file passed in. + + + + + + +**Parameters**: + +* **saveContext**: Context to use when loading this file, used for storing large files and other data contained in the save file but not directly in the XML.
+* **root**: The node ID of the node to begin reading at. This is useful if you are loading a larger document which contains a Data History node as a child. + + + +**Parameters**: + +* LPDISPATCH **saveContext** +* _[optional]_ VARIANT **root** + +**Return type**: void + + +### Function show + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::show() +``` + + + +Show the associated window. + + + +**Return type**: void + + +### Function hide + +![][public] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::hide() +``` + + + +Hide the associated window. + + + +**Return type**: void + + +### Function getPageTitle + +![][public] + +``` +BSTR PHXDATAEXPLORERLib::_DPHXDataExplorer::getPageTitle(long page) +``` + + + +Get the title for the specified page. + + + +**Parameters**: + +* long **page** + +**Return type**: BSTR + +## Private functions + + +### Function fromCenterLink + +![][private] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::fromCenterLink(BSTR server, BSTR runMatrixID, BSTR userName, BSTR password) +``` + + + + + + + +**Parameters**: + +* BSTR **server** +* BSTR **runMatrixID** +* BSTR **userName** +* BSTR **password** + +**Return type**: void + + +### Function ignoreDefaultPlotSetup + +![][private] + +``` +boolean PHXDATAEXPLORERLib::_DPHXDataExplorer::ignoreDefaultPlotSetup() +``` + + + + + + + +**Return type**: boolean + + +### Function setupPlotsPre + +![][private] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::setupPlotsPre() +``` + + + + + + + +**Return type**: void + + +### Function setupPlotsPost + +![][private] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::setupPlotsPost() +``` + + + + + + + +**Return type**: void + + +### Function showGeomTooltip + +![][private] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::showGeomTooltip(long run, long x, long y) +``` + + + + + + + +**Parameters**: + +* long **run** +* long **x** +* long **y** + +**Return type**: void + + +### Function showGeomViewer + +![][private] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::showGeomViewer(long run, long x, long y) +``` + + + + + + + +**Parameters**: + +* long **run** +* long **x** +* long **y** + +**Return type**: void + + +### Function updateGeomViewerHint + +![][private] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::updateGeomViewerHint(long viewerID) +``` + + + + + + + +**Parameters**: + +* long **viewerID** + +**Return type**: void + + +### Function setGeomViewerRunID + +![][private] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::setGeomViewerRunID(long viewerID, long runID) +``` + + + + + + + +**Parameters**: + +* long **viewerID** +* long **runID** + +**Return type**: void + + +### Function updateComparisonViewHint + +![][private] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::updateComparisonViewHint(BOOL restore) +``` + + + + + + + +**Parameters**: + +* BOOL **restore** + +**Return type**: void + + +### Function isMenuItemChecked + +![][private] + +``` +boolean PHXDATAEXPLORERLib::_DPHXDataExplorer::isMenuItemChecked(long id) +``` + + + + + + + +**Parameters**: + +* long **id** + +**Return type**: boolean + + +### Function removeFromComparisonList + +![][private] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::removeFromComparisonList(long runID) +``` + + + + + + + +**Parameters**: + +* long **runID** + +**Return type**: void + + +### Function addToComparisonList + +![][private] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::addToComparisonList(long runID) +``` + + + + + + + +**Parameters**: + +* long **runID** + +**Return type**: void + + +### Function addRunsToComparisonList + +![][private] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::addRunsToComparisonList(VARIANT runIDs) +``` + + + + + + + +**Parameters**: + +* VARIANT **runIDs** + +**Return type**: void + + +### Function getDaXType + +![][private] + +``` +boolean PHXDATAEXPLORERLib::_DPHXDataExplorer::getDaXType() +``` + + + + + + + +**Return type**: boolean + + +### Function getDaXFormat + +![][private] + +``` +boolean PHXDATAEXPLORERLib::_DPHXDataExplorer::getDaXFormat() +``` + + + + + + + +**Return type**: boolean + + +### Function ensureRunDataAction + +![][private] + +``` +void PHXDATAEXPLORERLib::_DPHXDataExplorer::ensureRunDataAction() +``` + + + + + + + +**Return type**: void + + +### Function getKeepalive + +![][private] + +``` +IDispatch * PHXDATAEXPLORERLib::_DPHXDataExplorer::getKeepalive() +``` + + + + + + + +**Return type**: IDispatch * + + +### Function getHWND + +![][private] + +``` +long PHXDATAEXPLORERLib::_DPHXDataExplorer::getHWND() +``` + + + + + + + +**Return type**: long + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents.md index d8abbcd2a9..7c4737e04e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents.md @@ -1,17 +1,16 @@ - -# Interface PHXDATAEXPLORERLib::\_DPHXDataExplorerEvents - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 361) - - - - - -## Members - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface PHXDATAEXPLORERLib::\_DPHXDataExplorerEvents + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 361) + + + + + +## Members + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1IDHVariable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1IDHVariable.md index 8faa698119..9dedab885a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1IDHVariable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1IDHVariable.md @@ -1,562 +1,561 @@ - -# Interface PHXDATAHISTORYLib::IDHVariable - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1020) - - - -An object which represents a single Variable's meta-data within the Data History. - -## Members - -* [copyFrom](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ae9e54933d6dd82e4d4aa5991b58b6ee3) -* [enumAliases](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1af3b9b49e293ed90e0e36ac8cd64a1d5d) -* [enumValues](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ac0461a8fca66f784a7f1a66b77c952e7) -* [equation](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a3901f5a0e0dba161b1746d3869d83807) -* [fileName](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a441ac734f55bcc3351b2e475524bd890) -* [format](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1aee5d1b31138b410b58410abbc82cf441) -* [geomScript](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a1fa79813f4fadc3f9f668aa5d433c431) -* [getEnumAlias](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5c03822c2d28cde3b9d0fdf4f335a594) -* [getEnumValue](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ad6bfcac769bd40c96db19848232fad3f) -* [getMetaData](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5c33238aa348f88bd3a7c66cde890631) -* [getNumEnumAliases](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ac865d961f3e4aa6fdb21c65f4960e7ee) -* [getNumEnumValues](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5f133f6ecf8e21010e1a624221f78d5b) -* [isBinary](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a18d61da08976eabab25b4049726415a5) -* [isDesignVar](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a6429c927c6b4f5937ed8f046ebb618dc) -* [isInput](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a36394ba4430c4f15bd18a02a96ff9c00) -* [isNumeric](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a72127ffab32587ffbec60628e70df2fc) -* [lowerBound](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a559e14d8841091219ceb4c121ab8d1fb) -* [name](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1aecd9b3210d5ef87459cb8a9830bb0f94) -* [removeMetadata](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a7bd9389ff771d6b63aa3643c961e7223) -* [SAFEARRAY](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a34d198c9ed66b975c39ed058511a3181) -* [setMetaData](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a9479fcb9ffceb4360b99be62d77eabad) -* [type](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ad46181f350249f42a737877eb3ce6c97) -* [units](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1aff5fbd1ebbbe6b3d4bd7ce114a09f40e) -* [upperBound](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5e7eff43bb2a4ca6eed5cd8e95b0e182) - -## Properties - - -### Property name - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -BSTR PHXDATAHISTORYLib::IDHVariable::name -``` - - - -The Variable name. May be a long, human readable string for Design Variables. - - - -**Return type**: BSTR - - -### Property equation - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -BSTR PHXDATAHISTORYLib::IDHVariable::equation -``` - - - -The equation for this Variable. This is typically only set for Design Variables and can be an actual equation of multiple Variables. - - - -**Return type**: BSTR - - -### Property isDesignVar - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -boolean PHXDATAHISTORYLib::IDHVariable::isDesignVar -``` - - - -Whether this Variable represents one of the Design Variables for the Trade Study that was run. - - - -**Return type**: boolean - - -### Property isNumeric - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -boolean PHXDATAHISTORYLib::IDHVariable::isNumeric -``` - - - -Whether this Variable is numeric. - - - -**Return type**: boolean - - -### Property isInput - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -boolean PHXDATAHISTORYLib::IDHVariable::isInput -``` - - - -Whether this Variable is an input (can be set in ModelCenter). Input Variables with links to them become outputs (cannot be set). - - - -**Return type**: boolean - - -### Property format - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -BSTR PHXDATAHISTORYLib::IDHVariable::format -``` - - - -The print format for this Variable. - - - -**Return type**: BSTR - - -### Property enumValues - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -BSTR PHXDATAHISTORYLib::IDHVariable::enumValues -``` - - - -The enumerated values for this Variable. String is a comma separated list which may optionally include double quotes around each element. - - - -**Return type**: BSTR - - -### Property enumAliases - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -BSTR PHXDATAHISTORYLib::IDHVariable::enumAliases -``` - - - -The enumerated aliases for this Variable. String is a comma separated list which may optionally include double quotes around each element. - - - -**Return type**: BSTR - - -### Property lowerBound - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -VARIANT PHXDATAHISTORYLib::IDHVariable::lowerBound -``` - - - -The lower bound for this Variable. - - - -**Return type**: VARIANT - - -### Property upperBound - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -VARIANT PHXDATAHISTORYLib::IDHVariable::upperBound -``` - - - -The upper bound of this Variable. - - - -**Return type**: VARIANT - - -### Property type - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -BSTR PHXDATAHISTORYLib::IDHVariable::type -``` - - - -The type of Variable. - - - -**Return type**: BSTR - - -### Property units - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -BSTR PHXDATAHISTORYLib::IDHVariable::units -``` - - - -The units for this Variable. - - - -**Return type**: BSTR - - -### Property geomScript - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -BSTR PHXDATAHISTORYLib::IDHVariable::geomScript -``` - - - -For a Geometry File Variable, the geometry script associated with the Variable. - - - -**Return type**: BSTR - - -### Property isBinary - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -boolean PHXDATAHISTORYLib::IDHVariable::isBinary -``` - - - -Whether this Variable, if it is a File Variable, represents a binary file. - - - -**Return type**: boolean - - -### Property fileName - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -BSTR PHXDATAHISTORYLib::IDHVariable::fileName -``` - - - -For a File Variable, the name of the file that this File Variable points to. - - - -**Return type**: BSTR - -## Public functions - - -### Function getNumEnumValues - -![][public] - -``` -long PHXDATAHISTORYLib::IDHVariable::getNumEnumValues() -``` - - - -Gets the number of enumerated values for this Variable. -**Returns**: - -The number of enumerated values for this variable. - - - -**Return type**: long - - -### Function getEnumValue - -![][public] - -``` -BSTR PHXDATAHISTORYLib::IDHVariable::getEnumValue(long index) -``` - - - -Returns a particular enumerated value. It is preferred that you use this method as opposed to parsing the [enumValues](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ac0461a8fca66f784a7f1a66b77c952e7) property yourself so that all tools will use the same logic for parsing. - - - - - - -**Parameters**: - -* **index**: The 0 based index of the enumerated value to get. - - -**Returns**: - -The enumerated value. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - - -### Function getEnumAlias - -![][public] - -``` -BSTR PHXDATAHISTORYLib::IDHVariable::getEnumAlias(long index) -``` - - - -Returns a particular enumerated alias. It is preferred that you use this method as opposed to parsing the [enumAliases](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1af3b9b49e293ed90e0e36ac8cd64a1d5d) property yourself so that all tools will use the same logic for parsing. - - - - - - -**Parameters**: - -* **index**: The 0 based index of the enumerated alias to get. - - -**Returns**: - -The particular enumerated alias.
- - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - - -### Function getNumEnumAliases - -![][public] - -``` -long PHXDATAHISTORYLib::IDHVariable::getNumEnumAliases() -``` - - - -Gets the number of enumerated aliases for this Variable. -**Returns**: - -The number of enumerated aliases. - - - -**Return type**: long - - -### Function setMetaData - -![][public] - -``` -void PHXDATAHISTORYLib::IDHVariable::setMetaData(BSTR key, BSTR value) -``` - - - -Sets the meta data value of the given meta data key name. It updates the value if the key already exists. -**Parameters**: - -* **key**: The name of the key. -* **value**: The new value for the meta data. - - - -**Parameters**: - -* BSTR **key** -* BSTR **value** - -**Return type**: void - - -### Function getMetaData - -![][public] - -``` -BSTR PHXDATAHISTORYLib::IDHVariable::getMetaData(BSTR key) -``` - - - -Gets the meta data value of the given meta data key name. -**Parameters**: - -* **key**: The name of the key. - - -**Returns**: - -The value of the meta data of the key name. - - - -**Parameters**: - -* BSTR **key** - -**Return type**: BSTR - - -### Function SAFEARRAY - -![][public] - -``` -PHXDATAHISTORYLib::IDHVariable::SAFEARRAY(BSTR) getMetaDataKeys() -``` - - - -Gets a list of metadata keys stored in this variable. - - - -**Parameters**: - -* BSTR - -**Return type**: - - -### Function copyFrom - -![][public] - -``` -void PHXDATAHISTORYLib::IDHVariable::copyFrom(LPDISPATCH other) -``` - - - -Copies data from another [IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable). - - - -**Parameters**: - -* LPDISPATCH **other** - -**Return type**: void - - -### Function removeMetadata - -![][public] - -``` -void PHXDATAHISTORYLib::IDHVariable::removeMetadata(BSTR key) -``` - - - -Removes the meta data value of the given meta data key name. -**Parameters**: - -* **key**: The name of the key to remove - - - -**Parameters**: - -* BSTR **key** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface PHXDATAHISTORYLib::IDHVariable + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1020) + + + +An object which represents a single Variable's meta-data within the Data History. + +## Members + +* [copyFrom](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ae9e54933d6dd82e4d4aa5991b58b6ee3) +* [enumAliases](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1af3b9b49e293ed90e0e36ac8cd64a1d5d) +* [enumValues](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ac0461a8fca66f784a7f1a66b77c952e7) +* [equation](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a3901f5a0e0dba161b1746d3869d83807) +* [fileName](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a441ac734f55bcc3351b2e475524bd890) +* [format](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1aee5d1b31138b410b58410abbc82cf441) +* [geomScript](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a1fa79813f4fadc3f9f668aa5d433c431) +* [getEnumAlias](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5c03822c2d28cde3b9d0fdf4f335a594) +* [getEnumValue](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ad6bfcac769bd40c96db19848232fad3f) +* [getMetaData](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5c33238aa348f88bd3a7c66cde890631) +* [getNumEnumAliases](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ac865d961f3e4aa6fdb21c65f4960e7ee) +* [getNumEnumValues](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5f133f6ecf8e21010e1a624221f78d5b) +* [isBinary](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a18d61da08976eabab25b4049726415a5) +* [isDesignVar](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a6429c927c6b4f5937ed8f046ebb618dc) +* [isInput](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a36394ba4430c4f15bd18a02a96ff9c00) +* [isNumeric](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a72127ffab32587ffbec60628e70df2fc) +* [lowerBound](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a559e14d8841091219ceb4c121ab8d1fb) +* [name](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1aecd9b3210d5ef87459cb8a9830bb0f94) +* [removeMetadata](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a7bd9389ff771d6b63aa3643c961e7223) +* [SAFEARRAY](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a34d198c9ed66b975c39ed058511a3181) +* [setMetaData](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a9479fcb9ffceb4360b99be62d77eabad) +* [type](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ad46181f350249f42a737877eb3ce6c97) +* [units](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1aff5fbd1ebbbe6b3d4bd7ce114a09f40e) +* [upperBound](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1a5e7eff43bb2a4ca6eed5cd8e95b0e182) + +## Properties + + +### Property name + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +BSTR PHXDATAHISTORYLib::IDHVariable::name +``` + + + +The Variable name. May be a long, human readable string for Design Variables. + + + +**Return type**: BSTR + + +### Property equation + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +BSTR PHXDATAHISTORYLib::IDHVariable::equation +``` + + + +The equation for this Variable. This is typically only set for Design Variables and can be an actual equation of multiple Variables. + + + +**Return type**: BSTR + + +### Property isDesignVar + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +boolean PHXDATAHISTORYLib::IDHVariable::isDesignVar +``` + + + +Whether this Variable represents one of the Design Variables for the Trade Study that was run. + + + +**Return type**: boolean + + +### Property isNumeric + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +boolean PHXDATAHISTORYLib::IDHVariable::isNumeric +``` + + + +Whether this Variable is numeric. + + + +**Return type**: boolean + + +### Property isInput + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +boolean PHXDATAHISTORYLib::IDHVariable::isInput +``` + + + +Whether this Variable is an input (can be set in ModelCenter). Input Variables with links to them become outputs (cannot be set). + + + +**Return type**: boolean + + +### Property format + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +BSTR PHXDATAHISTORYLib::IDHVariable::format +``` + + + +The print format for this Variable. + + + +**Return type**: BSTR + + +### Property enumValues + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +BSTR PHXDATAHISTORYLib::IDHVariable::enumValues +``` + + + +The enumerated values for this Variable. String is a comma separated list which may optionally include double quotes around each element. + + + +**Return type**: BSTR + + +### Property enumAliases + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +BSTR PHXDATAHISTORYLib::IDHVariable::enumAliases +``` + + + +The enumerated aliases for this Variable. String is a comma separated list which may optionally include double quotes around each element. + + + +**Return type**: BSTR + + +### Property lowerBound + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +VARIANT PHXDATAHISTORYLib::IDHVariable::lowerBound +``` + + + +The lower bound for this Variable. + + + +**Return type**: VARIANT + + +### Property upperBound + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +VARIANT PHXDATAHISTORYLib::IDHVariable::upperBound +``` + + + +The upper bound of this Variable. + + + +**Return type**: VARIANT + + +### Property type + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +BSTR PHXDATAHISTORYLib::IDHVariable::type +``` + + + +The type of Variable. + + + +**Return type**: BSTR + + +### Property units + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +BSTR PHXDATAHISTORYLib::IDHVariable::units +``` + + + +The units for this Variable. + + + +**Return type**: BSTR + + +### Property geomScript + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +BSTR PHXDATAHISTORYLib::IDHVariable::geomScript +``` + + + +For a Geometry File Variable, the geometry script associated with the Variable. + + + +**Return type**: BSTR + + +### Property isBinary + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +boolean PHXDATAHISTORYLib::IDHVariable::isBinary +``` + + + +Whether this Variable, if it is a File Variable, represents a binary file. + + + +**Return type**: boolean + + +### Property fileName + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +BSTR PHXDATAHISTORYLib::IDHVariable::fileName +``` + + + +For a File Variable, the name of the file that this File Variable points to. + + + +**Return type**: BSTR + +## Public functions + + +### Function getNumEnumValues + +![][public] + +``` +long PHXDATAHISTORYLib::IDHVariable::getNumEnumValues() +``` + + + +Gets the number of enumerated values for this Variable. +**Returns**: + +The number of enumerated values for this variable. + + + +**Return type**: long + + +### Function getEnumValue + +![][public] + +``` +BSTR PHXDATAHISTORYLib::IDHVariable::getEnumValue(long index) +``` + + + +Returns a particular enumerated value. It is preferred that you use this method as opposed to parsing the [enumValues](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1ac0461a8fca66f784a7f1a66b77c952e7) property yourself so that all tools will use the same logic for parsing. + + + + + + +**Parameters**: + +* **index**: The 0 based index of the enumerated value to get. + + +**Returns**: + +The enumerated value. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + + +### Function getEnumAlias + +![][public] + +``` +BSTR PHXDATAHISTORYLib::IDHVariable::getEnumAlias(long index) +``` + + + +Returns a particular enumerated alias. It is preferred that you use this method as opposed to parsing the [enumAliases](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable_1af3b9b49e293ed90e0e36ac8cd64a1d5d) property yourself so that all tools will use the same logic for parsing. + + + + + + +**Parameters**: + +* **index**: The 0 based index of the enumerated alias to get. + + +**Returns**: + +The particular enumerated alias.
+ + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + + +### Function getNumEnumAliases + +![][public] + +``` +long PHXDATAHISTORYLib::IDHVariable::getNumEnumAliases() +``` + + + +Gets the number of enumerated aliases for this Variable. +**Returns**: + +The number of enumerated aliases. + + + +**Return type**: long + + +### Function setMetaData + +![][public] + +``` +void PHXDATAHISTORYLib::IDHVariable::setMetaData(BSTR key, BSTR value) +``` + + + +Sets the meta data value of the given meta data key name. It updates the value if the key already exists. +**Parameters**: + +* **key**: The name of the key. +* **value**: The new value for the meta data. + + + +**Parameters**: + +* BSTR **key** +* BSTR **value** + +**Return type**: void + + +### Function getMetaData + +![][public] + +``` +BSTR PHXDATAHISTORYLib::IDHVariable::getMetaData(BSTR key) +``` + + + +Gets the meta data value of the given meta data key name. +**Parameters**: + +* **key**: The name of the key. + + +**Returns**: + +The value of the meta data of the key name. + + + +**Parameters**: + +* BSTR **key** + +**Return type**: BSTR + + +### Function SAFEARRAY + +![][public] + +``` +PHXDATAHISTORYLib::IDHVariable::SAFEARRAY(BSTR) getMetaDataKeys() +``` + + + +Gets a list of metadata keys stored in this variable. + + + +**Parameters**: + +* BSTR + +**Return type**: + + +### Function copyFrom + +![][public] + +``` +void PHXDATAHISTORYLib::IDHVariable::copyFrom(LPDISPATCH other) +``` + + + +Copies data from another [IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable). + + + +**Parameters**: + +* LPDISPATCH **other** + +**Return type**: void + + +### Function removeMetadata + +![][public] + +``` +void PHXDATAHISTORYLib::IDHVariable::removeMetadata(BSTR key) +``` + + + +Removes the meta data value of the given meta data key name. +**Parameters**: + +* **key**: The name of the key to remove + + + +**Parameters**: + +* BSTR **key** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md index cf11e5e9b1..b9d60a8804 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md @@ -1,149 +1,148 @@ - -# Interface PHXDATAHISTORYLib::IPHXMenuItems - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1164) - - - -An object which is used to get extra context dependent menu items from [PHXDataExplorerPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) pages through the [getMenuItems](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ad899f49a6bef9cd0f56292b7c92d8503) call. - -## Members - -* [getMenuItemDescription](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1a3213c537df82b4c00dd7f4df96b90712) -* [getMenuItemName](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1aa8491483ad472e4f1f9e51ea028561eb) -* [numItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1a74bd895a7bdaa2b6786bb4dc2c4d12a1) -* [setMenuItem](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1aa76ac2aefb1a69021d5f536db66c0c4b) - -## Properties - - -### Property numItems - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -long PHXDATAHISTORYLib::IPHXMenuItems::numItems -``` - - - -The number of context dependent menu items. Set this first, then use [setMenuItem()](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1aa76ac2aefb1a69021d5f536db66c0c4b) for each menu item. - - - -**Return type**: long - -## Public functions - - -### Function setMenuItem - -![][public] - -``` -void PHXDATAHISTORYLib::IPHXMenuItems::setMenuItem(long index, BSTR name, BSTR description) -``` - - - -Sets the data for a particular menu item. - - - - - - -**Parameters**: - -* **index**: A 0 based index of the menu item to set. -* **name**: The name of the menu item. This will display in the menu itself. -* **description**: The description of the menu item. Will be displayed in tooltips and the status bar when the user hovers over a menu item. - - - -**Parameters**: - -* long **index** -* BSTR **name** -* BSTR **description** - -**Return type**: void - - -### Function getMenuItemName - -![][public] - -``` -BSTR PHXDATAHISTORYLib::IPHXMenuItems::getMenuItemName(long index) -``` - - - -Gets the name of the menu item. - - - - - - -**Parameters**: - -* **index**: A 0 based index of the menu item to access. - - -**Returns**: - -The menu item name. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - - -### Function getMenuItemDescription - -![][public] - -``` -BSTR PHXDATAHISTORYLib::IPHXMenuItems::getMenuItemDescription(long index) -``` - - - -Gets the description field for the requested menu item. - - - - - - -**Parameters**: - -* **index**: A 0 based index of the menu item to access. - - -**Returns**: - -The value of the description field of the menu item. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface PHXDATAHISTORYLib::IPHXMenuItems + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1164) + + + +An object which is used to get extra context dependent menu items from [PHXDataExplorerPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) pages through the [getMenuItems](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ad899f49a6bef9cd0f56292b7c92d8503) call. + +## Members + +* [getMenuItemDescription](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1a3213c537df82b4c00dd7f4df96b90712) +* [getMenuItemName](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1aa8491483ad472e4f1f9e51ea028561eb) +* [numItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1a74bd895a7bdaa2b6786bb4dc2c4d12a1) +* [setMenuItem](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1aa76ac2aefb1a69021d5f536db66c0c4b) + +## Properties + + +### Property numItems + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +long PHXDATAHISTORYLib::IPHXMenuItems::numItems +``` + + + +The number of context dependent menu items. Set this first, then use [setMenuItem()](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems_1aa76ac2aefb1a69021d5f536db66c0c4b) for each menu item. + + + +**Return type**: long + +## Public functions + + +### Function setMenuItem + +![][public] + +``` +void PHXDATAHISTORYLib::IPHXMenuItems::setMenuItem(long index, BSTR name, BSTR description) +``` + + + +Sets the data for a particular menu item. + + + + + + +**Parameters**: + +* **index**: A 0 based index of the menu item to set. +* **name**: The name of the menu item. This will display in the menu itself. +* **description**: The description of the menu item. Will be displayed in tooltips and the status bar when the user hovers over a menu item. + + + +**Parameters**: + +* long **index** +* BSTR **name** +* BSTR **description** + +**Return type**: void + + +### Function getMenuItemName + +![][public] + +``` +BSTR PHXDATAHISTORYLib::IPHXMenuItems::getMenuItemName(long index) +``` + + + +Gets the name of the menu item. + + + + + + +**Parameters**: + +* **index**: A 0 based index of the menu item to access. + + +**Returns**: + +The menu item name. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + + +### Function getMenuItemDescription + +![][public] + +``` +BSTR PHXDATAHISTORYLib::IPHXMenuItems::getMenuItemDescription(long index) +``` + + + +Gets the description field for the requested menu item. + + + + + + +**Parameters**: + +* **index**: A 0 based index of the menu item to access. + + +**Returns**: + +The value of the description field of the menu item. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1ISaveContext.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1ISaveContext.md index 25e3119722..387d9da41e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1ISaveContext.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1ISaveContext.md @@ -1,229 +1,228 @@ - -# Interface PHXDATAHISTORYLib::ISaveContext - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1209) - - - -Object for assisting in save and restoring files. - -## Members - -* [close](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a314e254f112778f1bb9839e157fcc532) -* [getFileFormat](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ab69f2a1eba739bfa1e95a1b5ba2cc8c8) -* [getSaveLocation](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a02bf3019e5a957a4db2daff6dda6ca28) -* [restoreFile](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a90cd640253dfeb285c7c66803e61f6ac) -* [restoreFileStream](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ad11ce33d8317c86c335597d0e8389578) -* [saveFile](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ae85020cbcdca30d63c0dc803f19b7599) -* [saveFileStream](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a840d41a9c874a046867c9d25c8a0d628) -* [setFileFormat](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ad30b0ac3ddc36ac47b0f03662d3d4d0a) - -## Public functions - - -### Function saveFile - -![][public] - -``` -boolean PHXDATAHISTORYLib::ISaveContext::saveFile(BSTR sourceLocation, BSTR context) -``` - - - -Save a file into the context. If the save is successful passing the context to restore as the file ID will return the saved file. -**Parameters**: - -* **sourceLocation**: the location of the source file to save -* **context**: context by which to save - - -**Returns**: - -true if the file was saved successfully; false otherwise - - - -**Parameters**: - -* BSTR **sourceLocation** -* BSTR **context** - -**Return type**: boolean - - -### Function restoreFile - -![][public] - -``` -boolean PHXDATAHISTORYLib::ISaveContext::restoreFile(BSTR fileID, BSTR targetLocation) -``` - - - -Restores the file by ID to the given location. -**Parameters**: - -* **fileID**: id of the file to restore -* **targetLocation**: disk location to restore the file - - -**Returns**: - -true if a file with the given id was restored, false on failure - - - -**Parameters**: - -* BSTR **fileID** -* BSTR **targetLocation** - -**Return type**: boolean - - -### Function close - -![][public] - -``` -void PHXDATAHISTORYLib::ISaveContext::close() -``` - - - -Closes the save context. - - - -**Return type**: void - - -### Function getSaveLocation - -![][public] - -``` -BSTR PHXDATAHISTORYLib::ISaveContext::getSaveLocation() -``` - - - -Gets the disk location this save context saves. -**Returns**: - -the save context file path - - - -**Return type**: BSTR - - -### Function saveFileStream - -![][public] - -``` -LPUNKNOWN PHXDATAHISTORYLib::ISaveContext::saveFileStream(BSTR context) -``` - - - -Gets a stream that can be used for saving a file to the context. Only one stream may be open at a time. -**Parameters**: - -* **context**: context by which to save - - -**Returns**: - -output stream for saving - - - -**Parameters**: - -* BSTR **context** - -**Return type**: LPUNKNOWN - - -### Function restoreFileStream - -![][public] - -``` -LPUNKNOWN PHXDATAHISTORYLib::ISaveContext::restoreFileStream(BSTR fileID) -``` - - - -Gets a stream that can be used for restoring a file saved into the context with the given ID. Only one stream may be open at a time. -**Parameters**: - -* **fileID**: id of the file to restore - - -**Returns**: - -input stream for restoring - - - -**Parameters**: - -* BSTR **fileID** - -**Return type**: LPUNKNOWN - - -### Function getFileFormat - -![][public] - -``` -int PHXDATAHISTORYLib::ISaveContext::getFileFormat() -``` - - - -Get the file format of the save context instance. -**Returns**: - -save context file format - - - -**Return type**: int - - -### Function setFileFormat - -![][public] - -``` -void PHXDATAHISTORYLib::ISaveContext::setFileFormat(int fileFormat) -``` - - - -Set the file format of the save context. -**Parameters**: - -* **fileFormat**: file format of save context instance - - - -**Parameters**: - -* int **fileFormat** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface PHXDATAHISTORYLib::ISaveContext + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1209) + + + +Object for assisting in save and restoring files. + +## Members + +* [close](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a314e254f112778f1bb9839e157fcc532) +* [getFileFormat](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ab69f2a1eba739bfa1e95a1b5ba2cc8c8) +* [getSaveLocation](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a02bf3019e5a957a4db2daff6dda6ca28) +* [restoreFile](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a90cd640253dfeb285c7c66803e61f6ac) +* [restoreFileStream](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ad11ce33d8317c86c335597d0e8389578) +* [saveFile](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ae85020cbcdca30d63c0dc803f19b7599) +* [saveFileStream](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1a840d41a9c874a046867c9d25c8a0d628) +* [setFileFormat](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext_1ad30b0ac3ddc36ac47b0f03662d3d4d0a) + +## Public functions + + +### Function saveFile + +![][public] + +``` +boolean PHXDATAHISTORYLib::ISaveContext::saveFile(BSTR sourceLocation, BSTR context) +``` + + + +Save a file into the context. If the save is successful passing the context to restore as the file ID will return the saved file. +**Parameters**: + +* **sourceLocation**: the location of the source file to save +* **context**: context by which to save + + +**Returns**: + +true if the file was saved successfully; false otherwise + + + +**Parameters**: + +* BSTR **sourceLocation** +* BSTR **context** + +**Return type**: boolean + + +### Function restoreFile + +![][public] + +``` +boolean PHXDATAHISTORYLib::ISaveContext::restoreFile(BSTR fileID, BSTR targetLocation) +``` + + + +Restores the file by ID to the given location. +**Parameters**: + +* **fileID**: id of the file to restore +* **targetLocation**: disk location to restore the file + + +**Returns**: + +true if a file with the given id was restored, false on failure + + + +**Parameters**: + +* BSTR **fileID** +* BSTR **targetLocation** + +**Return type**: boolean + + +### Function close + +![][public] + +``` +void PHXDATAHISTORYLib::ISaveContext::close() +``` + + + +Closes the save context. + + + +**Return type**: void + + +### Function getSaveLocation + +![][public] + +``` +BSTR PHXDATAHISTORYLib::ISaveContext::getSaveLocation() +``` + + + +Gets the disk location this save context saves. +**Returns**: + +the save context file path + + + +**Return type**: BSTR + + +### Function saveFileStream + +![][public] + +``` +LPUNKNOWN PHXDATAHISTORYLib::ISaveContext::saveFileStream(BSTR context) +``` + + + +Gets a stream that can be used for saving a file to the context. Only one stream may be open at a time. +**Parameters**: + +* **context**: context by which to save + + +**Returns**: + +output stream for saving + + + +**Parameters**: + +* BSTR **context** + +**Return type**: LPUNKNOWN + + +### Function restoreFileStream + +![][public] + +``` +LPUNKNOWN PHXDATAHISTORYLib::ISaveContext::restoreFileStream(BSTR fileID) +``` + + + +Gets a stream that can be used for restoring a file saved into the context with the given ID. Only one stream may be open at a time. +**Parameters**: + +* **fileID**: id of the file to restore + + +**Returns**: + +input stream for restoring + + + +**Parameters**: + +* BSTR **fileID** + +**Return type**: LPUNKNOWN + + +### Function getFileFormat + +![][public] + +``` +int PHXDATAHISTORYLib::ISaveContext::getFileFormat() +``` + + + +Get the file format of the save context instance. +**Returns**: + +save context file format + + + +**Return type**: int + + +### Function setFileFormat + +![][public] + +``` +void PHXDATAHISTORYLib::ISaveContext::setFileFormat(int fileFormat) +``` + + + +Set the file format of the save context. +**Parameters**: + +* **fileFormat**: file format of save context instance + + + +**Parameters**: + +* int **fileFormat** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md index 78a8b4b39b..3cfc6cc01f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md @@ -1,53 +1,52 @@ - -# Interface PHXDATAHISTORYLib::PHXDataExplorerExportPlugIn - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 985) - - - -A data explorer plug-in can implement this interface in order to provide a higher quality image or snapshot export capability. - -## Members - -* [exportImage](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn_1a6e04dc894ad504d6c349d36ae7384e09) - -## Public functions - - -### Function exportImage - -![][public] - -``` -void PHXDATAHISTORYLib::PHXDataExplorerExportPlugIn::exportImage(BSTR hints, BSTR filename) -``` - - - -The plug-in should write an enhanced metafile out when this method is called. - - - - - - -**Parameters**: - -* **hints**: Currently unused. -* **filename**: The filename of the file to write. - - - -**Parameters**: - -* BSTR **hints** -* BSTR **filename** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface PHXDATAHISTORYLib::PHXDataExplorerExportPlugIn + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 985) + + + +A data explorer plug-in can implement this interface in order to provide a higher quality image or snapshot export capability. + +## Members + +* [exportImage](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn_1a6e04dc894ad504d6c349d36ae7384e09) + +## Public functions + + +### Function exportImage + +![][public] + +``` +void PHXDATAHISTORYLib::PHXDataExplorerExportPlugIn::exportImage(BSTR hints, BSTR filename) +``` + + + +The plug-in should write an enhanced metafile out when this method is called. + + + + + + +**Parameters**: + +* **hints**: Currently unused. +* **filename**: The filename of the file to write. + + + +**Parameters**: + +* BSTR **hints** +* BSTR **filename** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md index f6f1a380d3..e5e121f973 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md @@ -1,365 +1,364 @@ - -# Interface PHXDATAHISTORYLib::PHXDataExplorerPlugIn - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 882) - - - -An interface which represents a Data Explorer Page. An object must implement this interface in order to be displayed as a Data Explorer Page. - -## Members - -* [fromString](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a889e85b07599a03c7a262297629d0763) -* [getDataHistory](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a2add0041717f37ff0c72761de93af815) -* [getMenuItems](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ad899f49a6bef9cd0f56292b7c92d8503) -* [getModelCenter](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ab914e1d1c1dd883a0a1b6201cde0577f) -* [getPageTitle](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a38ed1207dbcb350057bc22b0450eb009) -* [getThumbnail](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1af5f2203aace2cd54bac6c8789b1782c5) -* [invokeMenuItem](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1afe6db966ff1b5790a8ae887d70294dc3) -* [isMenuItemEnabled](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a7259c195e2711d0fb54579e22752adb2) -* [setDataHistory](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a530e372d5d75f87574b4f5a7f8f25347) -* [setModelCenter](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a38e366a60626a29afa74869e40f156c6) -* [setStartContext](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ab7f82a38962d77ab437299dd6cbe50a1) -* [toString](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a075c34c41b0461b36077d19c314fdc2a) -* [updateHint](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a6394212eddc67589ac43fbd85826bbc2) - -## Public functions - - -### Function getDataHistory - -![][public] - -``` -LPDISPATCH PHXDATAHISTORYLib::PHXDataExplorerPlugIn::getDataHistory() -``` - - - -Returns the IDispatch of the associated Data History object. -**Returns**: - -The IDispatch of the associated Data History object. - - - -**Return type**: LPDISPATCH - - -### Function setDataHistory - -![][public] - -``` -void PHXDATAHISTORYLib::PHXDataExplorerPlugIn::setDataHistory(LPDISPATCH dataHistory) -``` - - - -Passes the associated Data History for this page. -**Parameters**: - -* **dataHistory**: The dataHistory object. - - - -**Parameters**: - -* LPDISPATCH **dataHistory** - -**Return type**: void - - -### Function getModelCenter - -![][public] - -``` -LPDISPATCH PHXDATAHISTORYLib::PHXDataExplorerPlugIn::getModelCenter() -``` - - - -Returns the associated ModelCenter object, if one exists. -**Returns**: - -The associated ModelCenter object. - - - -**Return type**: LPDISPATCH - - -### Function setModelCenter - -![][public] - -``` -void PHXDATAHISTORYLib::PHXDataExplorerPlugIn::setModelCenter(LPDISPATCH modelCenter) -``` - - - -Passes the associated ModelCenter object for this Plug-In. Plug-Ins should not expect this to be set and should fail gracefully with reduced functionality if an associated ModelCenter object is not available. -**Parameters**: - -* **modelCenter**: The ModelCenter object. - - - -**Parameters**: - -* LPDISPATCH **modelCenter** - -**Return type**: void - - -### Function getPageTitle - -![][public] - -``` -BSTR PHXDATAHISTORYLib::PHXDataExplorerPlugIn::getPageTitle() -``` - - - -Returns the page title. -**Returns**: - -The page title. - - - -**Return type**: BSTR - - -### Function toString - -![][public] - -``` -BSTR PHXDATAHISTORYLib::PHXDataExplorerPlugIn::toString() -``` - - - -Tells the Plug-In to save its current state into string form so that it can be saved with the file or put on the clipboard as a "Page Template". -**Returns**: - -The string representation of the Plug-In. - - - -**Return type**: BSTR - - -### Function fromString - -![][public] - -``` -void PHXDATAHISTORYLib::PHXDataExplorerPlugIn::fromString(BSTR str) -``` - - - -Tells this Data Explorer Plug-In to load its state from the given string. This data is used for saving/loading a Data Explorer Page and also for cut-n-paste of Data Explorer page templates, therefore the Plug-In should not expect that the data and Variable names in the associated Data History is the same as when the [toString()](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a075c34c41b0461b36077d19c314fdc2a) method was called. - - - - - - -**Parameters**: - -* **str**: The string to load. This will be passed unaltered from a previous call to [toString()](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a075c34c41b0461b36077d19c314fdc2a). - - - -**Parameters**: - -* BSTR **str** - -**Return type**: void - - -### Function getMenuItems - -![][public] - -``` -void PHXDATAHISTORYLib::PHXDataExplorerPlugIn::getMenuItems(LPDISPATCH iPHXMenuItem) -``` - - - -The Plug-In should fill in the passed in object with any context dependent menu items to put into the Page menu below all the standard items. - - - - - - -**Parameters**: - -* **iPHXMenuItem**: An [IPHXMenuItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems) object which should be filled in by the Plug-In. - - - -**Parameters**: - -* LPDISPATCH **iPHXMenuItem** - -**Return type**: void - - -### Function invokeMenuItem - -![][public] - -``` -void PHXDATAHISTORYLib::PHXDataExplorerPlugIn::invokeMenuItem(long id) -``` - - - -Tells the Plug-In that the user is attempting to invoke a menu item related to this page. - - - - - - -**Parameters**: - -* **id**: May be one of the constants from the PXHMENU_PREDEFS enumeration or a 0 based index into the custom menu items that the Plug-In defined through the [getMenuItems](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ad899f49a6bef9cd0f56292b7c92d8503) call. - - - -**Parameters**: - -* long **id** - -**Return type**: void - - -### Function isMenuItemEnabled - -![][public] - -``` -boolean PHXDATAHISTORYLib::PHXDataExplorerPlugIn::isMenuItemEnabled(long id) -``` - - - -This function should return whether the selected menu item is valid and should be enabled in the menu bar. - - - - - - -**Parameters**: - -* **id**: May be one of the constants from the PXHMENU_PREDEFS enumeration or a 0 based index into the custom menu items that the Plug-In defined through the [getMenuItems](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ad899f49a6bef9cd0f56292b7c92d8503) call. - - -**Returns**: - -True if valid/enabled, else false. - - - -**Parameters**: - -* long **id** - -**Return type**: boolean - - -### Function updateHint - -![][public] - -``` -boolean PHXDATAHISTORYLib::PHXDataExplorerPlugIn::updateHint() -``` - - - -This function is called just before a new thumbnail snapshot is taken. It is used by Plug-Ins which don't update content when they are not visible or selected, but would like an opportunity to update before a thumbnail is drawn. -**Returns**: - -False if an exception is thrown, else true. - - - -**Return type**: boolean - - -### Function setStartContext - -![][public] - -``` -void PHXDATAHISTORYLib::PHXDataExplorerPlugIn::setStartContext(BSTR str) -``` - - - -Passes in the "context" in which this plug-in is being invoked. The context is the name of the Plug-In as defined in [ModelCenter](namespaceModelCenter.md#namespaceModelCenter)'s Plug-In Manager, such as "2D Line". This is useful when a single Plug-In has multiple behaviors. -**Parameters**: - -* **str**: The start context. - - - -**Parameters**: - -* BSTR **str** - -**Return type**: void - - -### Function getThumbnail - -![][public] - -``` -BSTR PHXDATAHISTORYLib::PHXDataExplorerPlugIn::getThumbnail(BSTR hints) -``` - - - -Called by the Data Explorer to get the name of a file that contains the thumbnail image. - - - - - - -**Parameters**: - -* **hints**: - - -**Returns**: - -The name of the file containing the thumbnail image. - - - -**Parameters**: - -* BSTR **hints** - -**Return type**: BSTR - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface PHXDATAHISTORYLib::PHXDataExplorerPlugIn + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 882) + + + +An interface which represents a Data Explorer Page. An object must implement this interface in order to be displayed as a Data Explorer Page. + +## Members + +* [fromString](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a889e85b07599a03c7a262297629d0763) +* [getDataHistory](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a2add0041717f37ff0c72761de93af815) +* [getMenuItems](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ad899f49a6bef9cd0f56292b7c92d8503) +* [getModelCenter](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ab914e1d1c1dd883a0a1b6201cde0577f) +* [getPageTitle](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a38ed1207dbcb350057bc22b0450eb009) +* [getThumbnail](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1af5f2203aace2cd54bac6c8789b1782c5) +* [invokeMenuItem](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1afe6db966ff1b5790a8ae887d70294dc3) +* [isMenuItemEnabled](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a7259c195e2711d0fb54579e22752adb2) +* [setDataHistory](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a530e372d5d75f87574b4f5a7f8f25347) +* [setModelCenter](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a38e366a60626a29afa74869e40f156c6) +* [setStartContext](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ab7f82a38962d77ab437299dd6cbe50a1) +* [toString](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a075c34c41b0461b36077d19c314fdc2a) +* [updateHint](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a6394212eddc67589ac43fbd85826bbc2) + +## Public functions + + +### Function getDataHistory + +![][public] + +``` +LPDISPATCH PHXDATAHISTORYLib::PHXDataExplorerPlugIn::getDataHistory() +``` + + + +Returns the IDispatch of the associated Data History object. +**Returns**: + +The IDispatch of the associated Data History object. + + + +**Return type**: LPDISPATCH + + +### Function setDataHistory + +![][public] + +``` +void PHXDATAHISTORYLib::PHXDataExplorerPlugIn::setDataHistory(LPDISPATCH dataHistory) +``` + + + +Passes the associated Data History for this page. +**Parameters**: + +* **dataHistory**: The dataHistory object. + + + +**Parameters**: + +* LPDISPATCH **dataHistory** + +**Return type**: void + + +### Function getModelCenter + +![][public] + +``` +LPDISPATCH PHXDATAHISTORYLib::PHXDataExplorerPlugIn::getModelCenter() +``` + + + +Returns the associated ModelCenter object, if one exists. +**Returns**: + +The associated ModelCenter object. + + + +**Return type**: LPDISPATCH + + +### Function setModelCenter + +![][public] + +``` +void PHXDATAHISTORYLib::PHXDataExplorerPlugIn::setModelCenter(LPDISPATCH modelCenter) +``` + + + +Passes the associated ModelCenter object for this Plug-In. Plug-Ins should not expect this to be set and should fail gracefully with reduced functionality if an associated ModelCenter object is not available. +**Parameters**: + +* **modelCenter**: The ModelCenter object. + + + +**Parameters**: + +* LPDISPATCH **modelCenter** + +**Return type**: void + + +### Function getPageTitle + +![][public] + +``` +BSTR PHXDATAHISTORYLib::PHXDataExplorerPlugIn::getPageTitle() +``` + + + +Returns the page title. +**Returns**: + +The page title. + + + +**Return type**: BSTR + + +### Function toString + +![][public] + +``` +BSTR PHXDATAHISTORYLib::PHXDataExplorerPlugIn::toString() +``` + + + +Tells the Plug-In to save its current state into string form so that it can be saved with the file or put on the clipboard as a "Page Template". +**Returns**: + +The string representation of the Plug-In. + + + +**Return type**: BSTR + + +### Function fromString + +![][public] + +``` +void PHXDATAHISTORYLib::PHXDataExplorerPlugIn::fromString(BSTR str) +``` + + + +Tells this Data Explorer Plug-In to load its state from the given string. This data is used for saving/loading a Data Explorer Page and also for cut-n-paste of Data Explorer page templates, therefore the Plug-In should not expect that the data and Variable names in the associated Data History is the same as when the [toString()](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a075c34c41b0461b36077d19c314fdc2a) method was called. + + + + + + +**Parameters**: + +* **str**: The string to load. This will be passed unaltered from a previous call to [toString()](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1a075c34c41b0461b36077d19c314fdc2a). + + + +**Parameters**: + +* BSTR **str** + +**Return type**: void + + +### Function getMenuItems + +![][public] + +``` +void PHXDATAHISTORYLib::PHXDataExplorerPlugIn::getMenuItems(LPDISPATCH iPHXMenuItem) +``` + + + +The Plug-In should fill in the passed in object with any context dependent menu items to put into the Page menu below all the standard items. + + + + + + +**Parameters**: + +* **iPHXMenuItem**: An [IPHXMenuItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems) object which should be filled in by the Plug-In. + + + +**Parameters**: + +* LPDISPATCH **iPHXMenuItem** + +**Return type**: void + + +### Function invokeMenuItem + +![][public] + +``` +void PHXDATAHISTORYLib::PHXDataExplorerPlugIn::invokeMenuItem(long id) +``` + + + +Tells the Plug-In that the user is attempting to invoke a menu item related to this page. + + + + + + +**Parameters**: + +* **id**: May be one of the constants from the PXHMENU_PREDEFS enumeration or a 0 based index into the custom menu items that the Plug-In defined through the [getMenuItems](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ad899f49a6bef9cd0f56292b7c92d8503) call. + + + +**Parameters**: + +* long **id** + +**Return type**: void + + +### Function isMenuItemEnabled + +![][public] + +``` +boolean PHXDATAHISTORYLib::PHXDataExplorerPlugIn::isMenuItemEnabled(long id) +``` + + + +This function should return whether the selected menu item is valid and should be enabled in the menu bar. + + + + + + +**Parameters**: + +* **id**: May be one of the constants from the PXHMENU_PREDEFS enumeration or a 0 based index into the custom menu items that the Plug-In defined through the [getMenuItems](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn_1ad899f49a6bef9cd0f56292b7c92d8503) call. + + +**Returns**: + +True if valid/enabled, else false. + + + +**Parameters**: + +* long **id** + +**Return type**: boolean + + +### Function updateHint + +![][public] + +``` +boolean PHXDATAHISTORYLib::PHXDataExplorerPlugIn::updateHint() +``` + + + +This function is called just before a new thumbnail snapshot is taken. It is used by Plug-Ins which don't update content when they are not visible or selected, but would like an opportunity to update before a thumbnail is drawn. +**Returns**: + +False if an exception is thrown, else true. + + + +**Return type**: boolean + + +### Function setStartContext + +![][public] + +``` +void PHXDATAHISTORYLib::PHXDataExplorerPlugIn::setStartContext(BSTR str) +``` + + + +Passes in the "context" in which this plug-in is being invoked. The context is the name of the Plug-In as defined in [ModelCenter](namespaceModelCenter.md#namespaceModelCenter)'s Plug-In Manager, such as "2D Line". This is useful when a single Plug-In has multiple behaviors. +**Parameters**: + +* **str**: The start context. + + + +**Parameters**: + +* BSTR **str** + +**Return type**: void + + +### Function getThumbnail + +![][public] + +``` +BSTR PHXDATAHISTORYLib::PHXDataExplorerPlugIn::getThumbnail(BSTR hints) +``` + + + +Called by the Data Explorer to get the name of a file that contains the thumbnail image. + + + + + + +**Parameters**: + +* **hints**: + + +**Returns**: + +The name of the file containing the thumbnail image. + + + +**Parameters**: + +* BSTR **hints** + +**Return type**: BSTR + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md index 379aab95ef..5a4d93ff06 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md @@ -1,2302 +1,2301 @@ - -# Interface PHXDATAHISTORYLib::\_DPHXDataHistory - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 139) - - - -The Data History is the back-end data storage piece of a Data Explorer. It contains no GUI. - -**Inherits from**: - -* [PHXDataHistoryEvents](undefined.md#undefined) - -## Members - -* [addCheckpoint](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9e6d72c9c2f589323e745f69426aaefb) -* [addVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9a819127adb7f83be0acfa4e79f4643d) -* [addVariableAt](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a156c9828bc7c8251e68886297349ccab) -* [addVariableStructs](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9bf37e7831e0c32cfe17225f019c9cc4) -* [centerLinkJobConnector](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1af8f87624e919e067935bb5403261b63f) -* [centerLinkQueue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aac2a1a4d2bc65319ac7e94f0f20368b1) -* [centerLinkRunMatrixID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a61514463a5c0f82163d4789cd9e60f8a) -* [centerLinkServer](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a226709acf22397c41215acd7f0ab0605) -* [createDesignVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1adb61a037918e5f45dfc6a43541023970) -* [createVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a68acd508b225f5c74c27daf848f3ae27) -* [dataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a4c0b3167dd18062593fb1a221bce40af) -* [deleteRun](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a0be98d87ed201827314037c9100e8fce) -* [deleteVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1af26d20927c5ef5ccd3304b1c3ba220c4) -* [endRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a0576632449bf05bc8b0274fb341a3332) -* [fromCenterLink](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3ff1b9e535edf561dfa7f575814f1792) -* [fromXML](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a1649ee497672683a575cc6cd6b78c9a6) -* [fromXMLFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3b65f441a218c193aae8863e6354cc2d) -* [fromXMLSaveContext](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ad00d42b514b490170b0d28930b4bd32b) -* [getCheckpointRunNumber](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a71781fe2343b7ef49d1fb80ed91d295a) -* [getCheckpointValue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae28168a3a789a8d8c2413e6c58c635d0) -* [getCompletedRunData](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a76a5d19e76fdfe69e61d6910917acb32) -* [getCompletedRunIndices](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a434f332ecfce0734f8f940da4b722cc6) -* [getDatabaseFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aaecbc010eb87c6a2fbe894a646d83a4e) -* [getErrorID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a90e9fc9cfb0d469c4169504e6f2c9cd4) -* [getErrorMessage](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a876302a3d26eda812e93bdd8b15bb26d) -* [getFailedRunIndexes](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a2acdef5238b168dae7f3294ba1629c77) -* [getFormattedValue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a45bea3dd1938199a0846f46c3d024503) -* [getHighlightedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab7998245db9550b3e7c21a25b37ce7bf) -* [getNumCheckpoints](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae1070b5293d700b8e095477fbb54b80c) -* [getNumCompletedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a023f64de843e0e97d47e37b9cfbac5ae) -* [getNumCustomVars](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a0b2e2ab12279325bc63b9db7330d6bab) -* [getNumDesignVariables](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ade57b335d32a772b6de31d129b6374bc) -* [getNumExpectedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a250340a6fc41c19a43783cd3171db63d) -* [getNumFailedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac08c8abcc799991d7b12548ae1172378) -* [getNumNonEmptyRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac1ad590e863b19678c6e47ae4ff3e521) -* [getNumRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a59b24c674a512a94640f4c5a890e9309) -* [getNumVariables](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aca767f94c4b80412c79eba62214eebfd) -* [getRunName](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a42f819d3a26184898d9487b42894d4e2) -* [getTradeStudySetup](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a5f068466f0c9b18f8ba1681d97c2ddf9) -* [getTradeStudyType](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9f51a8f280c8bc80f4cebcb9de40ab5e) -* [getUniqueID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a01538f2f06fba2512c31fb7a35a04b4d) -* [getValue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a43d806edede4bc2efa5e88c7615189ed) -* [getVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a074ed759e40eb4931c5b6e23f2c72e02) -* [getVariable2](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a03430a06338ca51c6f5c45421a47f320) -* [getVariableTempDir](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aee367d3da3f483f1d9d476e832c7bb9a) -* [getVariableValues](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a03fd55d685a75a6041202d00e676e052) -* [highlight](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a77749479f2bbdf8caa1f90119e6112fd) -* [id](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a1a709440522385b3161831eea313c15d) -* [insertRun](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab64f03fca9f43b3a491393d44c9144d5) -* [isHighlighted](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a81c862c59a3b280376afc1b9bd221116) -* [isModified](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1af7b8598fa12d5b516344517c0593a983) -* [isRunComplete](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ad0d48129784f8ce140ff3dfb76ee8ba3) -* [isRunning](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab045302c25ef3b584eb3736b9071569b) -* [isValid](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a55e6f50a94f58d4c39bb6fe06c5398da) -* [removeAutosave](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a222463b648be93775c026887adf9d75f) -* [setDatabaseFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae38c2eeccd0c6e3c6c2e68063bd7008a) -* [setError](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a51fddca34fae5fbd0a5f5c858eddac26) -* [setFormattedResult](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9d98950fdb4e2e3f07519c40580c8ae9) -* [setHighlightedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aea1fd966af29d2f3d0f7d95ac8f93ce3) -* [setNumExpectedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a8ee93fde7260e85a34331b2c32a1289c) -* [setResult](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9260828e57d6cee2ec51e26dcef48ea7) -* [setResultAsFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a8fe368442becfe48a2642b16d9a73e3c) -* [setRunName](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1adff96af9fbbb349cd4d0d69aab8a1b43) -* [setRunValues](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aa6fcc8d517001f5b1e1c2b4cb9d6a95c) -* [setShortVariableNames](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae53e12cca23a7988b0d8c7dfdbe14308) -* [setTradeStudySetup](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1acfc1654be0cc6fbe5469b487f9576bb9) -* [setTradeStudyType](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a7e9c912ffb74926c67437bf50b8b944f) -* [setUniqueID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1adc572aab955548292d15997e1b519434) -* [setUsernamePassword](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab6b36fde7ab38b09357add72dcbaf225) -* [setVariableValues](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aff837e76c92ab15ac33eebfe3f348c99) -* [startRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a74028f784809522e15bf71133d8fd23c) -* [suggestedCountFrom](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a07162878a7dcf1c2a6ea41a56c9ddb6b) -* [suggestedDependentVars](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae1e8705d32948c759d3ab3e59bf6306b) -* [suggestedIndependantVar](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3b5732bdccab13e2a7ed55c852d4c55b) -* [suggestedIndependentVar](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a1713976f65a0fdc2d37e9606bbc8672b) -* [toCSV](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ada3b86a293b267a74999e35c70fea775) -* [toCSVFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a582bd6a4ad61e03070dcde9e4df76812) -* [toXML](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac6e672dc87278a4037bbf085b76f6aa4) -* [toXMLFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a7d11e224b1eaac4fab085ed9fa3d183b) -* [toXMLSaveContext](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a21df6ed38dc18c8cc9054f40f1f9daaf) -* [tradeStudyModelFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aeecce56460ab6c1c203c9d56433f4371) -* [warmStartStudyComplete](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac68974459907dcaf6b35ea631bba2801) - -## Properties - - -### Property suggestedIndependantVar - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -BSTR PHXDATAHISTORYLib::_DPHXDataHistory::suggestedIndependantVar -``` - - - -The name of the suggested independent Variable. -**Deprecated**: - -(misspelling) - - - -**Return type**: BSTR - - -### Property suggestedIndependentVar - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -BSTR PHXDATAHISTORYLib::_DPHXDataHistory::suggestedIndependentVar -``` - - - -The name of the suggested independent Variable. - - - -**Return type**: BSTR - - -### Property suggestedDependentVars - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -VARIANT PHXDATAHISTORYLib::_DPHXDataHistory::suggestedDependentVars -``` - - - -An array of strings which are the suggested Variable names to use for dependent Variables in plots. - - - -**Return type**: VARIANT - - -### Property suggestedCountFrom - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -long PHXDATAHISTORYLib::_DPHXDataHistory::suggestedCountFrom -``` - - - -Suggested number to use when showing the runs in a GUI as the first run number. Typically 0 or 1. Has no effect on internal API calls. - - - -**Return type**: long - - -### Property id - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 178) - -``` -settingRun PHXDATAHISTORYLib::_DPHXDataHistory::id -``` - - - -[IPHXDataExplorerPointer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer) which gives you access to the associated Data Explorer object. - - - -**Return type**: settingRun - - -### Property centerLinkServer - -![][private] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -BSTR PHXDATAHISTORYLib::_DPHXDataHistory::centerLinkServer -``` - - - - - - - -**Return type**: BSTR - - -### Property centerLinkRunMatrixID - -![][private] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -BSTR PHXDATAHISTORYLib::_DPHXDataHistory::centerLinkRunMatrixID -``` - - - - - - - -**Return type**: BSTR - - -### Property centerLinkJobConnector - -![][private] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -BSTR PHXDATAHISTORYLib::_DPHXDataHistory::centerLinkJobConnector -``` - - - - - - - -**Return type**: BSTR - - -### Property centerLinkQueue - -![][private] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -BSTR PHXDATAHISTORYLib::_DPHXDataHistory::centerLinkQueue -``` - - - - - - - -**Return type**: BSTR - - -### Property dataHistoryToModel - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -LPDISPATCH PHXDATAHISTORYLib::_DPHXDataHistory::dataHistoryToModel -``` - - - -Get or set the Data History to Model object (see [\_DPHXDataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel)). - - - -**Return type**: LPDISPATCH - - -### Property warmStartStudyComplete - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -boolean PHXDATAHISTORYLib::_DPHXDataHistory::warmStartStudyComplete -``` - - - -Gets/Sets warm-start trade study complete flag. - - - -**Return type**: boolean - - -### Property tradeStudyModelFile - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) - -``` -BSTR PHXDATAHISTORYLib::_DPHXDataHistory::tradeStudyModelFile -``` - - - -Gets/Sets the temp model file name saved for crash recovery of trade studies. This file will be DELETED when datahistory destructs. - - - -**Return type**: BSTR - -## Public functions - - -### Function addVariable - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::addVariable(LPDISPATCH var) -``` - - - -Adds a Variable to the Data History. All existing runs are appended with a blank value for this Variable. - - - - - - -**Parameters**: - -* **var**: Pass in a filled in [IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) object from a previous call to [createVariable()](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a68acd508b225f5c74c27daf848f3ae27). - - - -**Parameters**: - -* LPDISPATCH **var** - -**Return type**: void - - -### Function setNumExpectedRuns - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::setNumExpectedRuns(long numRuns) -``` - - - -Sets the expected number of runs. Used for informational and GUI purposes. - - - - - - -**Parameters**: - -* **numRuns**: The expected number of runs. - - - -**Parameters**: - -* long **numRuns** - -**Return type**: void - - -### Function startRuns - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::startRuns() -``` - - - -Identifies that the runs are starting. - - - -**Return type**: void - - -### Function endRuns - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::endRuns() -``` - - - -Tells the Data History that all runs are now complete. It will pass the data along as an event. - - - -**Return type**: void - - -### Function getNumFailedRuns - -![][public] - -``` -long PHXDATAHISTORYLib::_DPHXDataHistory::getNumFailedRuns() -``` - - - -Get the number of runs with an Error ID which is not equal to 0. -**Returns**: - -The number of failed runs. - - - -**Return type**: long - - -### Function getErrorID - -![][public] - -``` -long PHXDATAHISTORYLib::_DPHXDataHistory::getErrorID(long run) -``` - - - -Get the error ID for a particular run. - - - - - - -**Parameters**: - -* **run**: The 0 based index to the run to access. - - -**Returns**: - -The error ID. 0 means success. All other values mean failure. - - - -**Parameters**: - -* long **run** - -**Return type**: long - - -### Function getErrorMessage - -![][public] - -``` -BSTR PHXDATAHISTORYLib::_DPHXDataHistory::getErrorMessage(long run) -``` - - - -Returns the error message for a particular run. - - - - - - -**Parameters**: - -* **run**: The 0 based index to the run to access. - - -**Returns**: - -The error message of the run. - - - -**Parameters**: - -* long **run** - -**Return type**: BSTR - - -### Function setError - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::setError(long run, long errorID, BSTR message) -``` - - - -Sets the error for a run. - - - - - - -**Parameters**: - -* **run**: The 0 based index to the run to access. -* **errorID**: The error ID. 0 is considered success. All other values are failure. -* **message**: The text for the error. - - - -**Parameters**: - -* long **run** -* long **errorID** -* BSTR **message** - -**Return type**: void - - -### Function getNumRuns - -![][public] - -``` -long PHXDATAHISTORYLib::_DPHXDataHistory::getNumRuns() -``` - - - -Returns the number of runs currently in the matrix. -**Returns**: - -The total number of runs. - - - -**Return type**: long - - -### Function getNumVariables - -![][public] - -``` -long PHXDATAHISTORYLib::_DPHXDataHistory::getNumVariables() -``` - - - -Returns the number of Variables currently in the matrix. -**Returns**: - -The number of variables. - - - -**Return type**: long - - -### Function setResult - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::setResult(VARIANT index, long run, VARIANT value, boolean valid, boolean modified) -``` - - - -Sets the result for a run. - - - - - - -**Parameters**: - -* **index**: Either a 0 based index to the Variable, or the name of a Variable. -* **run**: The 0 based index to the run to access. -* **value**: The value of the Variable for this run. -* **valid**: Whether this value is valid. -* **modified**: Whether this value's modified flag is set. - - - -**Parameters**: - -* VARIANT **index** -* long **run** -* VARIANT **value** -* boolean **valid** -* boolean **modified** - -**Return type**: void - - -### Function getValue - -![][public] - -``` -VARIANT PHXDATAHISTORYLib::_DPHXDataHistory::getValue(VARIANT index, long run) -``` - - - -Gets the value of a Variable for a particular run. - - - - - - -**Parameters**: - -* **index**: Either a 0 based index to the Variable, or the name of a Variable. -* **run**: The 0 based index to the run to access. - - -**Returns**: - -The value of the variable. - - - -**Parameters**: - -* VARIANT **index** -* long **run** - -**Return type**: VARIANT - - -### Function isValid - -![][public] - -``` -boolean PHXDATAHISTORYLib::_DPHXDataHistory::isValid(VARIANT index, long run) -``` - - - -Returns whether the valid flag is set for a Variable for a particular run. - - - - - - -**Parameters**: - -* **index**: Either a 0 based index to the Variable, or the name of a Variable. -* **run**: The 0 based index to the run to access. - - -**Returns**: - -True if the variable is valid, else false. - - - -**Parameters**: - -* VARIANT **index** -* long **run** - -**Return type**: boolean - - -### Function isModified - -![][public] - -``` -boolean PHXDATAHISTORYLib::_DPHXDataHistory::isModified(VARIANT index, long run) -``` - - - -Returns whether the modified flag is set on a Variable for a particular run. - - - - - - -**Parameters**: - -* **index**: Either a 0 based index to the Variable, or the name of a Variable. -* **run**: The 0 based index to the run to access. - - -**Returns**: - -True if the modified flag is true, else false. - - - -**Parameters**: - -* VARIANT **index** -* long **run** - -**Return type**: boolean - - -### Function toCSVFile - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::toCSVFile(BSTR fileName, [optional] VARIANT variablesInRows, [optional] VARIANT includeFailed) -``` - - - -Writes a CSV file of all the data in the Data History. - - - - - - -**Parameters**: - -* **fileName**: The file to write. -* **variablesInRows**: If true, variables will be in rows. If false, they will be in columns. -* **includeFailed**: Whether to include failed runs in the output. - - - -**Parameters**: - -* BSTR **fileName** -* _[optional]_ VARIANT **variablesInRows** -* _[optional]_ VARIANT **includeFailed** - -**Return type**: void - - -### Function toXML - -![][public] - -``` -BSTR PHXDATAHISTORYLib::_DPHXDataHistory::toXML([optional]VARIANT includeRunData) -``` - - - -Writes the Data History contents to an XML string. - - - - - - -**Parameters**: - -* **includeRunData**: - - -**Returns**: - -The XML string. - - - -**Parameters**: - -* _[optional]_ VARIANT **includeRunData** - -**Return type**: BSTR - - -### Function toXMLFile - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::toXMLFile(BSTR fileName, [optional]VARIANT includeRunData) -``` - - - -Writes the Data History contents to an XML file. - - - - - - -**Parameters**: - -* **fileName**: The file to write. It will be overwritten if it exists, or created if it doesn't. -* **includeRunData**:
- - - -**Parameters**: - -* BSTR **fileName** -* _[optional]_ VARIANT **includeRunData** - -**Return type**: void - - -### Function fromXML - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::fromXML(BSTR xmlStr, [optional] VARIANT root) -``` - - - -Tells the Data History to load its state from the XML string passed in. - - - - - - -**Parameters**: - -* **xmlStr**: The XML string to read. -* **root**: The node ID of the node to begin reading at. This is useful if you are loading a larger document which contains a Data History node as a child. - - - -**Parameters**: - -* BSTR **xmlStr** -* _[optional]_ VARIANT **root** - -**Return type**: void - - -### Function fromXMLFile - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::fromXMLFile(BSTR fileName, [optional] VARIANT root) -``` - - - -Tells the Data History to load its state from the XML file passed in. - - - - - - -**Parameters**: - -* **fileName**: The name of the file to read. -* **root**: The node ID of the node to begin reading at. This is useful if you are loading a larger document which contains a Data History node as a child. - - - -**Parameters**: - -* BSTR **fileName** -* _[optional]_ VARIANT **root** - -**Return type**: void - - -### Function toCSV - -![][public] - -``` -BSTR PHXDATAHISTORYLib::_DPHXDataHistory::toCSV([optional] VARIANT variablesInRows, [optional] VARIANT includeFailed) -``` - - - -Returns a CSV string of all the data in the Data History. - - - - - - -**Parameters**: - -* **variablesInRows**: If true, variables will be in rows. If false, they will be in columns. -* **includeFailed**: Whether to include failed runs in the output. - - -**Returns**: - -The string of comma-seperated values. - - - -**Parameters**: - -* _[optional]_ VARIANT **variablesInRows** -* _[optional]_ VARIANT **includeFailed** - -**Return type**: BSTR - - -### Function getNumNonEmptyRuns - -![][public] - -``` -long PHXDATAHISTORYLib::_DPHXDataHistory::getNumNonEmptyRuns() -``` - - - -Returns the number of runs which have at least one piece of data filled in. -**Returns**: - -The number of runs that contain data. - - - -**Return type**: long - - -### Function getVariable - -![][public] - -``` -IDispatch * PHXDATAHISTORYLib::_DPHXDataHistory::getVariable(VARIANT index) -``` - - - -Gets the [IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) object for a particular Variable. - - - - - - -**Parameters**: - -* **index**: Either a 0 based index to the Variable, or the name of a Variable. - - -**Returns**: - -An IDispatch* to the [IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) object. - - - -**Parameters**: - -* VARIANT **index** - -**Return type**: IDispatch * - - -### Function createVariable - -![][public] - -``` -IDispatch * PHXDATAHISTORYLib::_DPHXDataHistory::createVariable() -``` - - - -Creates a new [IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) object so that you can fill it in and pass it to addVariable. -**Returns**: - -An IDispatch* to a newly created [IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) object. - - - -**Return type**: IDispatch * - - -### Function isRunning - -![][public] - -``` -boolean PHXDATAHISTORYLib::_DPHXDataHistory::isRunning() -``` - - - -Returns true if the running flag is set. -**Returns**: - -True if running flag is set, else false. - - - -**Return type**: boolean - - -### Function getNumExpectedRuns - -![][public] - -``` -long PHXDATAHISTORYLib::_DPHXDataHistory::getNumExpectedRuns() -``` - - - -Returns the number of runs expected for this Trade Study. -**Returns**: - -The number of expected runs. - - - -**Return type**: long - - -### Function getRunName - -![][public] - -``` -BSTR PHXDATAHISTORYLib::_DPHXDataHistory::getRunName(long runNum) -``` - - - -Returns the human readable name for a particular run. Usually this is blank, but can be used for things like Design Histories and snapshots. - - - - - - -**Parameters**: - -* **runNum**: The 0 based index to the run to access. - - -**Returns**: - -The name of the particular run. - - - -**Parameters**: - -* long **runNum** - -**Return type**: BSTR - - -### Function setRunName - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::setRunName(long runNum, BSTR name) -``` - - - -Sets the name of a run. This name typically will show up in the run header for the Table View and is only used for Snapshots and Design Histories. - - - - - - -**Parameters**: - -* **runNum**: The 0 based index to the run to access. -* **name**: The name of the run. - - - -**Parameters**: - -* long **runNum** -* BSTR **name** - -**Return type**: void - - -### Function insertRun - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::insertRun(long insertBefore) -``` - - - -Inserts a blank run. - - - - - - -**Parameters**: - -* **insertBefore**: The 0 based index to the run to reference. May be -1 to insert at the end. Usually -1 is not needed because setValue call will add runs automatically as necessary. - - - -**Parameters**: - -* long **insertBefore** - -**Return type**: void - - -### Function deleteRun - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::deleteRun(long run) -``` - - - -Deletes all the data for a numbered run. - - - - - - -**Parameters**: - -* **run**: The 0 based index to the run to delete. - - - -**Parameters**: - -* long **run** - -**Return type**: void - - -### Function deleteVariable - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::deleteVariable(VARIANT index) -``` - - - -Deletes a Variable from the Data History - - - - - - -**Parameters**: - -* **index**: Either a 0 based index to the Variable, or the name of a Variable. - - - -**Parameters**: - -* VARIANT **index** - -**Return type**: void - - -### Function getFormattedValue - -![][public] - -``` -BSTR PHXDATAHISTORYLib::_DPHXDataHistory::getFormattedValue(VARIANT index, long run) -``` - - - -Returns the value of a Variable for a run formatted according to the Variable's formatting mode. - - - - - - -**Parameters**: - -* **index**: Either a 0 based index to the Variable, or the name of a Variable. -* **run**: The 0 based index to the run to access. - - -**Returns**: - -The formatted value of the variable. - - - -**Parameters**: - -* VARIANT **index** -* long **run** - -**Return type**: BSTR - - -### Function setFormattedResult - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::setFormattedResult(VARIANT index, long run, BSTR value, boolean valid, boolean modified) -``` - - - -Sets the result for a run using formatted string text. - - - - - - -**Parameters**: - -* **index**: Either a 0 based index to the Variable, or the name of a Variable. -* **run**: The 0 based index to the run to access. -* **value**: The value of the Variable for this run, as a formatted string. -* **valid**: Whether this value is valid. -* **modified**: Whether this value's modified flag is set. - - - -**Parameters**: - -* VARIANT **index** -* long **run** -* BSTR **value** -* boolean **valid** -* boolean **modified** - -**Return type**: void - - -### Function getNumCustomVars - -![][public] - -``` -long PHXDATAHISTORYLib::_DPHXDataHistory::getNumCustomVars() -``` - - - -Returns the number of Variables which are marked as Custom Variables. -**Returns**: - -The number of custom variables. - - - -**Return type**: long - - -### Function getUniqueID - -![][public] - -``` -long PHXDATAHISTORYLib::_DPHXDataHistory::getUniqueID() -``` - - - -Gets an ID that uniquely identifies this Data History with the current running process. Is not unique across multiple processes. -**Returns**: - -The unique ID for this DataHistory object. - - - -**Return type**: long - - -### Function getVariableValues - -![][public] - -``` -VARIANT PHXDATAHISTORYLib::_DPHXDataHistory::getVariableValues(VARIANT index) -``` - - - -Gets all the values of a variable as an array of variants. - - - - - - -**Parameters**: - -* **index**: The 0 based index or name of the variable to query. - - - -**Parameters**: - -* VARIANT **index** - -**Return type**: VARIANT - - -### Function createDesignVariable - -![][public] - -``` -long PHXDATAHISTORYLib::_DPHXDataHistory::createDesignVariable(VARIANT index) -``` - - - -Creates a design variable with the same properties and data as the specified variable. - - - - - - -**Parameters**: - -* **index**: The 0 based index of the variable to copy. - - -**Returns**: - -The index of the newly created variable. - - - -**Parameters**: - -* VARIANT **index** - -**Return type**: long - - -### Function addVariableAt - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::addVariableAt(LPDISPATCH var, long location) -``` - - - -Adds a Variable to the Data History. All existing runs are appended with a blank value for this Variable. - - - - - - -**Parameters**: - -* **var**: Pass in a filled in [IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) object from a previous call to [createVariable()](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a68acd508b225f5c74c27daf848f3ae27). -* **location**: The 0 based index of where to put the variable. Data History will enforce that variables are grouped first by design variables, then non-design variables. - - - -**Parameters**: - -* LPDISPATCH **var** -* long **location** - -**Return type**: void - - -### Function setVariableValues - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::setVariableValues(VARIANT index, long run, VARIANT values, boolean valid, boolean modified) -``` - - - -Sets all values of a variable as a chunk. - - - - - - -**Parameters**: - -* **index**: Variable ID (0-based index). -* **run**: Run ID (0-based index). -* **values**: Array of values. -* **valid**: Whether values are valid. -* **modified**: Whether values should appear as modified. - - - -**Parameters**: - -* VARIANT **index** -* long **run** -* VARIANT **values** -* boolean **valid** -* boolean **modified** - -**Return type**: void - - -### Function isHighlighted - -![][public] - -``` -boolean PHXDATAHISTORYLib::_DPHXDataHistory::isHighlighted(long run) -``` - - - -Check highlight state. - - - - - - -**Parameters**: - -* **run**: Run ID (0-based index). - - -**Returns**: - -True if hightlighted, false otherwise. - - - -**Parameters**: - -* long **run** - -**Return type**: boolean - - -### Function highlight - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::highlight(long run, boolean highlight, boolean handleEvent) -``` - - - -Highlight or unhighlight a run. - - - - - - -?> setting this will reset your highlighted items to just this item, or in the case of unhighlighting it will unhighlight all items. - - -**Parameters**: - -* **run**: Run ID (0-based index). -* **highlight**: True to highlight, false to remove highlight. -* **handleEvent**: Handle highlight event in the listener. - - - -**Parameters**: - -* long **run** -* boolean **highlight** -* boolean **handleEvent** - -**Return type**: void - - -### Function getNumDesignVariables - -![][public] - -``` -long PHXDATAHISTORYLib::_DPHXDataHistory::getNumDesignVariables() -``` - - - -Returns the number of Variables which are marked as Design Variables. -**Returns**: - -The number of design variables. - - - -**Return type**: long - - -### Function setTradeStudySetup - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::setTradeStudySetup(BSTR setup) -``` - - - -Sets the trade study XML setup data. -**Parameters**: - -* **setup**: The XML string to set up the trade study. - - - -**Parameters**: - -* BSTR **setup** - -**Return type**: void - - -### Function getTradeStudySetup - -![][public] - -``` -BSTR PHXDATAHISTORYLib::_DPHXDataHistory::getTradeStudySetup() -``` - - - -Gets the trade study setup, in XML form, used for generating the data. -**Returns**: - -The XML representaion of the trady study setup. - - - -**Return type**: BSTR - - -### Function setTradeStudyType - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::setTradeStudyType(BSTR type) -``` - - - -Sets the trade study type that generated the data ("DOE", "PAT", etc). -**Parameters**: - -* **type**: The type of trade study. - - - -**Parameters**: - -* BSTR **type** - -**Return type**: void - - -### Function getTradeStudyType - -![][public] - -``` -BSTR PHXDATAHISTORYLib::_DPHXDataHistory::getTradeStudyType() -``` - - - -Gets the trade study type that generated the data ("DOE", "PAT", etc). -**Returns**: - -The type of trade study. - - - -**Return type**: BSTR - - -### Function setShortVariableNames - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::setShortVariableNames(boolean shortenVariableNames) -``` - - - -Sets a flag that determines if variables will be returned in long or short form. - - - - - - -**Parameters**: - -* **shortenVariableNames**: True to shorten variable names. - - - -**Parameters**: - -* boolean **shortenVariableNames** - -**Return type**: void - - -### Function setRunValues - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::setRunValues(long run, VARIANT values, BOOL valid, BOOL modified) -``` - - - -Sets all values of a variable as a chunk. - - - - - - -**Parameters**: - -* **run**: Run ID (0-based index). -* **values**: Array of values. -* **valid**: Whether values are valid. -* **modified**: Whether values should appear as modified. - - - -**Parameters**: - -* long **run** -* VARIANT **values** -* BOOL **valid** -* BOOL **modified** - -**Return type**: void - - -### Function getFailedRunIndexes - -![][public] - -``` -VARIANT PHXDATAHISTORYLib::_DPHXDataHistory::getFailedRunIndexes() -``` - - - -Gets an array which contains all the indexes of runs which have errors. -**Returns**: - -An array of long values. - - - -**Return type**: VARIANT - - -### Function toXMLSaveContext - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::toXMLSaveContext(LPDISPATCH saveContext, [optional] VARIANT includeRunData) -``` - - - -Writes the Data History contents to an XML file. - - - - - - -**Parameters**: - -* **saveContext**: Context to use when loading this file, used for storing large files and other data contained in the save file but not directly in the XML. -* **includeRunData**:
- - - -**Parameters**: - -* LPDISPATCH **saveContext** -* _[optional]_ VARIANT **includeRunData** - -**Return type**: void - - -### Function fromXMLSaveContext - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::fromXMLSaveContext(LPDISPATCH saveContext, [optional] VARIANT root) -``` - - - -Tells the Data History to load its state from the XML file passed in. - - - - - - -**Parameters**: - -* **saveContext**: Context to use when loading this file, used for storing large files and other data contained in the save file but not directly in the XML.
-* **root**: The node ID of the node to begin reading at. This is useful if you are loading a larger document which contains a Data History node as a child. - - - -**Parameters**: - -* LPDISPATCH **saveContext** -* _[optional]_ VARIANT **root** - -**Return type**: void - - -### Function getCompletedRunIndices - -![][public] - -``` -VARIANT PHXDATAHISTORYLib::_DPHXDataHistory::getCompletedRunIndices() -``` - - - -Gets an array which contains all the indices of runs which completed -**Returns**: - -An array of long values. - - - -**Return type**: VARIANT - - -### Function isRunComplete - -![][public] - -``` -boolean PHXDATAHISTORYLib::_DPHXDataHistory::isRunComplete(long run) -``` - - - -Gets whether the run is complete or not -**Parameters**: - -* **run**: Run ID (0-based index). - - -**Returns**: - -Whether the run has completed or not - - - -**Parameters**: - -* long **run** - -**Return type**: boolean - - -### Function addCheckpoint - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::addCheckpoint(long runNumber, BSTR value) -``` - - - -Add a warm start checkpoint to the cache -**Parameters**: - -* **name**: name for the checkpoint -* **value**: value for the checkpoint - - - -**Parameters**: - -* long **runNumber** -* BSTR **value** - -**Return type**: void - - -### Function getNumCheckpoints - -![][public] - -``` -long PHXDATAHISTORYLib::_DPHXDataHistory::getNumCheckpoints() -``` - - - -Gets the number of warm start checkpoints available -**Returns**: - -the number of warm start checkpoints available - - - -**Return type**: long - - -### Function getCheckpointValue - -![][public] - -``` -BSTR PHXDATAHISTORYLib::_DPHXDataHistory::getCheckpointValue(long checkpointIndex) -``` - - - -Gets the wam start checkpoint's value, the caller is responsible for releasing the BSTR memory. -**Parameters**: - -* **checkpointIndex**: Checkpoint Index (0-based index) - - -**Returns**: - -the checkpoint value - - - -**Parameters**: - -* long **checkpointIndex** - -**Return type**: BSTR - - -### Function getCheckpointRunNumber - -![][public] - -``` -long PHXDATAHISTORYLib::_DPHXDataHistory::getCheckpointRunNumber(long checkpointIndex) -``` - - - -Gets the warm start checkpoint's run number -**Parameters**: - -* **checkpointIndex**: Checkpoint Index (0-based index) - - -**Returns**: - -the checkpoint run number - - - -**Parameters**: - -* long **checkpointIndex** - -**Return type**: long - - -### Function setUniqueID - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::setUniqueID(long identifier) -``` - - - -Sets an ID that uniquely identifies this Data History. -**Parameters**: - -* **identifier**: The unique ID for this DataHistory object. - - - -**Parameters**: - -* long **identifier** - -**Return type**: void - - -### Function getNumCompletedRuns - -![][public] - -``` -long PHXDATAHISTORYLib::_DPHXDataHistory::getNumCompletedRuns() -``` - - - -Retrieves the number of completed runs for the current trade study. - - - - - - -**Returns**: - -The number of completed runs for the current trade study - - - -**Return type**: long - - -### Function getCompletedRunData - -![][public] - -``` -ULONG PHXDATAHISTORYLib::_DPHXDataHistory::getCompletedRunData([out] VARIANT *runIDs, [out] VARIANT *errorIDs, [out] VARIANT *errorMessages, [out] VARIANT *variableValues, [out] LONG *endSequenceNumber, [in, defaultvalue(0)] ULONG startSequenceNumber, [in, defaultvalue(0xFFFFFFFF)] ULONG maxLength, [in, defaultvalue(FALSE)] boolean allVariables) -``` - - - -Gets runIDs, error IDs, error messages, and variable values for completed runs of only design variables unless allVariables param is set to true. -?> If the PHXDataHistoryEvents::dataChanged event is fired with a runIndex of -1, the completed-run list is purged and reconstructed. Therefore the next call to this method should restart startSequenceNumber with 0. - - -?> If a startSequenceNumber is given that is greater than the number of items in the completed-run list (out of range), this method will act as if a startSequenceNumber of 0 had been given. - - -**Parameters**: - -* **runIDs**: array of longs, runIDs that have recently completed. -* **errorIDs**: array of longs, error IDs for each corresponding run in runIDs.
- 0 indicates success, all other values indicate failure. -* **errorMessages**: array of strings, error messages for each corresponding run in runIDs. -* **variableValues**: multi-dimensional array of VARIANTs, variable values. First index is for each run in runIDs and the second index is for each variable. -* **endSequenceNumber**: index of the last avalable completed run. Will be -1 if there are no completed runs avalable. -* **startSequenceNumber**: index in the completed-run list to begin fetching from. Defaults to 0, the start of the list. -* **maxLength**: maximum number of completed runs to fetch. Defaults to requesting all available runs. -* **allVariables**: flag if true will result in run data returned for all variables else only design variable data will be returned - - -**Returns**: - -next startSequenceNumber to use in next call to getCompletedRunData. This value may be greater than (startSequenceNumber + runs) if a given run completed multiple times due to re-runs. - - - -**Parameters**: - -* _[out]_ VARIANT * **runIDs** -* _[out]_ VARIANT * **errorIDs** -* _[out]_ VARIANT * **errorMessages** -* _[out]_ VARIANT * **variableValues** -* _[out]_ LONG * **endSequenceNumber** -* _[in, defaultvalue(0)]_ ULONG **startSequenceNumber** -* _[in, defaultvalue(0xFFFFFFFF)]_ ULONG **maxLength** -* _[in, defaultvalue(FALSE)]_ boolean **allVariables** - -**Return type**: ULONG - - -### Function getHighlightedRuns - -![][public] - -``` -VARIANT PHXDATAHISTORYLib::_DPHXDataHistory::getHighlightedRuns() -``` - - - -Retrieve the set of currently highlighted run indices -**Returns**: - -the set of currently highlighted run indices as an array of integers - - - -**Return type**: VARIANT - - -### Function setHighlightedRuns - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::setHighlightedRuns(VARIANT selectedRunIndices) -``` - - - -Specify the set of currently highlighted run indices. -?> This will overwrite the existing highlighted runs. - - -**Parameters**: - -* **selectedRunIndices**: the set of run indices to highlight, specified by either a single integer, numeric string, array of integers, or array of numeric strings. Specifying an empty or null value will remove all highlighted run indices. - - -**Exceptions**: - -* **COM**: exception thrown if passed non-numeric types or arrays of non-numeric types. - - - -**Parameters**: - -* VARIANT **selectedRunIndices** - -**Return type**: void - - -### Function addVariableStructs - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::addVariableStructs(VARIANT dhVarStructs, long run) -``` - - - -Sets the results for a run. This method will add variables to the DataHistory if they are not already present File variables are not supported, their value cannot be represented in a [DataHistoryVariableStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct) -**Parameters**: - -* **dhVarStructs**: SAFEARRAY of DataHistoryVariableStructs to add -* **run**: The 0 based index to the run to set. - - - -**Parameters**: - -* VARIANT **dhVarStructs** -* long **run** - -**Return type**: void - -## Private functions - - -### Function fromCenterLink - -![][private] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::fromCenterLink(BSTR serverName, BSTR runMatrixID, BSTR userName, BSTR password) -``` - - - - - - - -**Parameters**: - -* BSTR **serverName** -* BSTR **runMatrixID** -* BSTR **userName** -* BSTR **password** - -**Return type**: void - - -### Function setUsernamePassword - -![][private] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::setUsernamePassword(BSTR username, BSTR password) -``` - - - - - - - -**Parameters**: - -* BSTR **username** -* BSTR **password** - -**Return type**: void - - -### Function setResultAsFile - -![][private] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::setResultAsFile(VARIANT index, long run, boolean valid, boolean modified, BSTR tempFileName, BSTR tempFileDir) -``` - - - - - - - -**Parameters**: - -* VARIANT **index** -* long **run** -* boolean **valid** -* boolean **modified** -* BSTR **tempFileName** -* BSTR **tempFileDir** - -**Return type**: void - - -### Function getDatabaseFile - -![][private] - -``` -BSTR PHXDATAHISTORYLib::_DPHXDataHistory::getDatabaseFile() -``` - - - - - - - -**Return type**: BSTR - - -### Function setDatabaseFile - -![][private] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::setDatabaseFile(BSTR filename) -``` - - - - - - - -**Parameters**: - -* BSTR **filename** - -**Return type**: void - - -### Function removeAutosave - -![][private] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistory::removeAutosave() -``` - - - - - - - -**Return type**: void - - -### Function getVariable2 - -![][private] - -``` -IDispatch * PHXDATAHISTORYLib::_DPHXDataHistory::getVariable2(VARIANT index) -``` - - - - - - - -**Parameters**: - -* VARIANT **index** - -**Return type**: IDispatch * - - -### Function getVariableTempDir - -![][private] - -``` -BSTR PHXDATAHISTORYLib::_DPHXDataHistory::getVariableTempDir(VARIANT index) -``` - - - - - - - -**Parameters**: - -* VARIANT **index** - -**Return type**: BSTR - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface PHXDATAHISTORYLib::\_DPHXDataHistory + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 139) + + + +The Data History is the back-end data storage piece of a Data Explorer. It contains no GUI. + +**Inherits from**: + +* [PHXDataHistoryEvents](undefined.md#undefined) + +## Members + +* [addCheckpoint](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9e6d72c9c2f589323e745f69426aaefb) +* [addVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9a819127adb7f83be0acfa4e79f4643d) +* [addVariableAt](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a156c9828bc7c8251e68886297349ccab) +* [addVariableStructs](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9bf37e7831e0c32cfe17225f019c9cc4) +* [centerLinkJobConnector](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1af8f87624e919e067935bb5403261b63f) +* [centerLinkQueue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aac2a1a4d2bc65319ac7e94f0f20368b1) +* [centerLinkRunMatrixID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a61514463a5c0f82163d4789cd9e60f8a) +* [centerLinkServer](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a226709acf22397c41215acd7f0ab0605) +* [createDesignVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1adb61a037918e5f45dfc6a43541023970) +* [createVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a68acd508b225f5c74c27daf848f3ae27) +* [dataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a4c0b3167dd18062593fb1a221bce40af) +* [deleteRun](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a0be98d87ed201827314037c9100e8fce) +* [deleteVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1af26d20927c5ef5ccd3304b1c3ba220c4) +* [endRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a0576632449bf05bc8b0274fb341a3332) +* [fromCenterLink](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3ff1b9e535edf561dfa7f575814f1792) +* [fromXML](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a1649ee497672683a575cc6cd6b78c9a6) +* [fromXMLFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3b65f441a218c193aae8863e6354cc2d) +* [fromXMLSaveContext](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ad00d42b514b490170b0d28930b4bd32b) +* [getCheckpointRunNumber](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a71781fe2343b7ef49d1fb80ed91d295a) +* [getCheckpointValue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae28168a3a789a8d8c2413e6c58c635d0) +* [getCompletedRunData](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a76a5d19e76fdfe69e61d6910917acb32) +* [getCompletedRunIndices](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a434f332ecfce0734f8f940da4b722cc6) +* [getDatabaseFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aaecbc010eb87c6a2fbe894a646d83a4e) +* [getErrorID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a90e9fc9cfb0d469c4169504e6f2c9cd4) +* [getErrorMessage](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a876302a3d26eda812e93bdd8b15bb26d) +* [getFailedRunIndexes](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a2acdef5238b168dae7f3294ba1629c77) +* [getFormattedValue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a45bea3dd1938199a0846f46c3d024503) +* [getHighlightedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab7998245db9550b3e7c21a25b37ce7bf) +* [getNumCheckpoints](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae1070b5293d700b8e095477fbb54b80c) +* [getNumCompletedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a023f64de843e0e97d47e37b9cfbac5ae) +* [getNumCustomVars](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a0b2e2ab12279325bc63b9db7330d6bab) +* [getNumDesignVariables](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ade57b335d32a772b6de31d129b6374bc) +* [getNumExpectedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a250340a6fc41c19a43783cd3171db63d) +* [getNumFailedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac08c8abcc799991d7b12548ae1172378) +* [getNumNonEmptyRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac1ad590e863b19678c6e47ae4ff3e521) +* [getNumRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a59b24c674a512a94640f4c5a890e9309) +* [getNumVariables](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aca767f94c4b80412c79eba62214eebfd) +* [getRunName](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a42f819d3a26184898d9487b42894d4e2) +* [getTradeStudySetup](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a5f068466f0c9b18f8ba1681d97c2ddf9) +* [getTradeStudyType](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9f51a8f280c8bc80f4cebcb9de40ab5e) +* [getUniqueID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a01538f2f06fba2512c31fb7a35a04b4d) +* [getValue](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a43d806edede4bc2efa5e88c7615189ed) +* [getVariable](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a074ed759e40eb4931c5b6e23f2c72e02) +* [getVariable2](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a03430a06338ca51c6f5c45421a47f320) +* [getVariableTempDir](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aee367d3da3f483f1d9d476e832c7bb9a) +* [getVariableValues](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a03fd55d685a75a6041202d00e676e052) +* [highlight](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a77749479f2bbdf8caa1f90119e6112fd) +* [id](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a1a709440522385b3161831eea313c15d) +* [insertRun](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab64f03fca9f43b3a491393d44c9144d5) +* [isHighlighted](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a81c862c59a3b280376afc1b9bd221116) +* [isModified](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1af7b8598fa12d5b516344517c0593a983) +* [isRunComplete](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ad0d48129784f8ce140ff3dfb76ee8ba3) +* [isRunning](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab045302c25ef3b584eb3736b9071569b) +* [isValid](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a55e6f50a94f58d4c39bb6fe06c5398da) +* [removeAutosave](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a222463b648be93775c026887adf9d75f) +* [setDatabaseFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae38c2eeccd0c6e3c6c2e68063bd7008a) +* [setError](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a51fddca34fae5fbd0a5f5c858eddac26) +* [setFormattedResult](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9d98950fdb4e2e3f07519c40580c8ae9) +* [setHighlightedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aea1fd966af29d2f3d0f7d95ac8f93ce3) +* [setNumExpectedRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a8ee93fde7260e85a34331b2c32a1289c) +* [setResult](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a9260828e57d6cee2ec51e26dcef48ea7) +* [setResultAsFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a8fe368442becfe48a2642b16d9a73e3c) +* [setRunName](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1adff96af9fbbb349cd4d0d69aab8a1b43) +* [setRunValues](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aa6fcc8d517001f5b1e1c2b4cb9d6a95c) +* [setShortVariableNames](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae53e12cca23a7988b0d8c7dfdbe14308) +* [setTradeStudySetup](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1acfc1654be0cc6fbe5469b487f9576bb9) +* [setTradeStudyType](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a7e9c912ffb74926c67437bf50b8b944f) +* [setUniqueID](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1adc572aab955548292d15997e1b519434) +* [setUsernamePassword](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ab6b36fde7ab38b09357add72dcbaf225) +* [setVariableValues](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aff837e76c92ab15ac33eebfe3f348c99) +* [startRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a74028f784809522e15bf71133d8fd23c) +* [suggestedCountFrom](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a07162878a7dcf1c2a6ea41a56c9ddb6b) +* [suggestedDependentVars](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ae1e8705d32948c759d3ab3e59bf6306b) +* [suggestedIndependantVar](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a3b5732bdccab13e2a7ed55c852d4c55b) +* [suggestedIndependentVar](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a1713976f65a0fdc2d37e9606bbc8672b) +* [toCSV](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ada3b86a293b267a74999e35c70fea775) +* [toCSVFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a582bd6a4ad61e03070dcde9e4df76812) +* [toXML](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac6e672dc87278a4037bbf085b76f6aa4) +* [toXMLFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a7d11e224b1eaac4fab085ed9fa3d183b) +* [toXMLSaveContext](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a21df6ed38dc18c8cc9054f40f1f9daaf) +* [tradeStudyModelFile](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1aeecce56460ab6c1c203c9d56433f4371) +* [warmStartStudyComplete](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1ac68974459907dcaf6b35ea631bba2801) + +## Properties + + +### Property suggestedIndependantVar + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +BSTR PHXDATAHISTORYLib::_DPHXDataHistory::suggestedIndependantVar +``` + + + +The name of the suggested independent Variable. +**Deprecated**: + +(misspelling) + + + +**Return type**: BSTR + + +### Property suggestedIndependentVar + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +BSTR PHXDATAHISTORYLib::_DPHXDataHistory::suggestedIndependentVar +``` + + + +The name of the suggested independent Variable. + + + +**Return type**: BSTR + + +### Property suggestedDependentVars + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +VARIANT PHXDATAHISTORYLib::_DPHXDataHistory::suggestedDependentVars +``` + + + +An array of strings which are the suggested Variable names to use for dependent Variables in plots. + + + +**Return type**: VARIANT + + +### Property suggestedCountFrom + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +long PHXDATAHISTORYLib::_DPHXDataHistory::suggestedCountFrom +``` + + + +Suggested number to use when showing the runs in a GUI as the first run number. Typically 0 or 1. Has no effect on internal API calls. + + + +**Return type**: long + + +### Property id + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 178) + +``` +settingRun PHXDATAHISTORYLib::_DPHXDataHistory::id +``` + + + +[IPHXDataExplorerPointer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer) which gives you access to the associated Data Explorer object. + + + +**Return type**: settingRun + + +### Property centerLinkServer + +![][private] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +BSTR PHXDATAHISTORYLib::_DPHXDataHistory::centerLinkServer +``` + + + + + + + +**Return type**: BSTR + + +### Property centerLinkRunMatrixID + +![][private] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +BSTR PHXDATAHISTORYLib::_DPHXDataHistory::centerLinkRunMatrixID +``` + + + + + + + +**Return type**: BSTR + + +### Property centerLinkJobConnector + +![][private] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +BSTR PHXDATAHISTORYLib::_DPHXDataHistory::centerLinkJobConnector +``` + + + + + + + +**Return type**: BSTR + + +### Property centerLinkQueue + +![][private] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +BSTR PHXDATAHISTORYLib::_DPHXDataHistory::centerLinkQueue +``` + + + + + + + +**Return type**: BSTR + + +### Property dataHistoryToModel + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +LPDISPATCH PHXDATAHISTORYLib::_DPHXDataHistory::dataHistoryToModel +``` + + + +Get or set the Data History to Model object (see [\_DPHXDataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel)). + + + +**Return type**: LPDISPATCH + + +### Property warmStartStudyComplete + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +boolean PHXDATAHISTORYLib::_DPHXDataHistory::warmStartStudyComplete +``` + + + +Gets/Sets warm-start trade study complete flag. + + + +**Return type**: boolean + + +### Property tradeStudyModelFile + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1) + +``` +BSTR PHXDATAHISTORYLib::_DPHXDataHistory::tradeStudyModelFile +``` + + + +Gets/Sets the temp model file name saved for crash recovery of trade studies. This file will be DELETED when datahistory destructs. + + + +**Return type**: BSTR + +## Public functions + + +### Function addVariable + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::addVariable(LPDISPATCH var) +``` + + + +Adds a Variable to the Data History. All existing runs are appended with a blank value for this Variable. + + + + + + +**Parameters**: + +* **var**: Pass in a filled in [IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) object from a previous call to [createVariable()](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a68acd508b225f5c74c27daf848f3ae27). + + + +**Parameters**: + +* LPDISPATCH **var** + +**Return type**: void + + +### Function setNumExpectedRuns + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::setNumExpectedRuns(long numRuns) +``` + + + +Sets the expected number of runs. Used for informational and GUI purposes. + + + + + + +**Parameters**: + +* **numRuns**: The expected number of runs. + + + +**Parameters**: + +* long **numRuns** + +**Return type**: void + + +### Function startRuns + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::startRuns() +``` + + + +Identifies that the runs are starting. + + + +**Return type**: void + + +### Function endRuns + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::endRuns() +``` + + + +Tells the Data History that all runs are now complete. It will pass the data along as an event. + + + +**Return type**: void + + +### Function getNumFailedRuns + +![][public] + +``` +long PHXDATAHISTORYLib::_DPHXDataHistory::getNumFailedRuns() +``` + + + +Get the number of runs with an Error ID which is not equal to 0. +**Returns**: + +The number of failed runs. + + + +**Return type**: long + + +### Function getErrorID + +![][public] + +``` +long PHXDATAHISTORYLib::_DPHXDataHistory::getErrorID(long run) +``` + + + +Get the error ID for a particular run. + + + + + + +**Parameters**: + +* **run**: The 0 based index to the run to access. + + +**Returns**: + +The error ID. 0 means success. All other values mean failure. + + + +**Parameters**: + +* long **run** + +**Return type**: long + + +### Function getErrorMessage + +![][public] + +``` +BSTR PHXDATAHISTORYLib::_DPHXDataHistory::getErrorMessage(long run) +``` + + + +Returns the error message for a particular run. + + + + + + +**Parameters**: + +* **run**: The 0 based index to the run to access. + + +**Returns**: + +The error message of the run. + + + +**Parameters**: + +* long **run** + +**Return type**: BSTR + + +### Function setError + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::setError(long run, long errorID, BSTR message) +``` + + + +Sets the error for a run. + + + + + + +**Parameters**: + +* **run**: The 0 based index to the run to access. +* **errorID**: The error ID. 0 is considered success. All other values are failure. +* **message**: The text for the error. + + + +**Parameters**: + +* long **run** +* long **errorID** +* BSTR **message** + +**Return type**: void + + +### Function getNumRuns + +![][public] + +``` +long PHXDATAHISTORYLib::_DPHXDataHistory::getNumRuns() +``` + + + +Returns the number of runs currently in the matrix. +**Returns**: + +The total number of runs. + + + +**Return type**: long + + +### Function getNumVariables + +![][public] + +``` +long PHXDATAHISTORYLib::_DPHXDataHistory::getNumVariables() +``` + + + +Returns the number of Variables currently in the matrix. +**Returns**: + +The number of variables. + + + +**Return type**: long + + +### Function setResult + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::setResult(VARIANT index, long run, VARIANT value, boolean valid, boolean modified) +``` + + + +Sets the result for a run. + + + + + + +**Parameters**: + +* **index**: Either a 0 based index to the Variable, or the name of a Variable. +* **run**: The 0 based index to the run to access. +* **value**: The value of the Variable for this run. +* **valid**: Whether this value is valid. +* **modified**: Whether this value's modified flag is set. + + + +**Parameters**: + +* VARIANT **index** +* long **run** +* VARIANT **value** +* boolean **valid** +* boolean **modified** + +**Return type**: void + + +### Function getValue + +![][public] + +``` +VARIANT PHXDATAHISTORYLib::_DPHXDataHistory::getValue(VARIANT index, long run) +``` + + + +Gets the value of a Variable for a particular run. + + + + + + +**Parameters**: + +* **index**: Either a 0 based index to the Variable, or the name of a Variable. +* **run**: The 0 based index to the run to access. + + +**Returns**: + +The value of the variable. + + + +**Parameters**: + +* VARIANT **index** +* long **run** + +**Return type**: VARIANT + + +### Function isValid + +![][public] + +``` +boolean PHXDATAHISTORYLib::_DPHXDataHistory::isValid(VARIANT index, long run) +``` + + + +Returns whether the valid flag is set for a Variable for a particular run. + + + + + + +**Parameters**: + +* **index**: Either a 0 based index to the Variable, or the name of a Variable. +* **run**: The 0 based index to the run to access. + + +**Returns**: + +True if the variable is valid, else false. + + + +**Parameters**: + +* VARIANT **index** +* long **run** + +**Return type**: boolean + + +### Function isModified + +![][public] + +``` +boolean PHXDATAHISTORYLib::_DPHXDataHistory::isModified(VARIANT index, long run) +``` + + + +Returns whether the modified flag is set on a Variable for a particular run. + + + + + + +**Parameters**: + +* **index**: Either a 0 based index to the Variable, or the name of a Variable. +* **run**: The 0 based index to the run to access. + + +**Returns**: + +True if the modified flag is true, else false. + + + +**Parameters**: + +* VARIANT **index** +* long **run** + +**Return type**: boolean + + +### Function toCSVFile + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::toCSVFile(BSTR fileName, [optional] VARIANT variablesInRows, [optional] VARIANT includeFailed) +``` + + + +Writes a CSV file of all the data in the Data History. + + + + + + +**Parameters**: + +* **fileName**: The file to write. +* **variablesInRows**: If true, variables will be in rows. If false, they will be in columns. +* **includeFailed**: Whether to include failed runs in the output. + + + +**Parameters**: + +* BSTR **fileName** +* _[optional]_ VARIANT **variablesInRows** +* _[optional]_ VARIANT **includeFailed** + +**Return type**: void + + +### Function toXML + +![][public] + +``` +BSTR PHXDATAHISTORYLib::_DPHXDataHistory::toXML([optional]VARIANT includeRunData) +``` + + + +Writes the Data History contents to an XML string. + + + + + + +**Parameters**: + +* **includeRunData**: + + +**Returns**: + +The XML string. + + + +**Parameters**: + +* _[optional]_ VARIANT **includeRunData** + +**Return type**: BSTR + + +### Function toXMLFile + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::toXMLFile(BSTR fileName, [optional]VARIANT includeRunData) +``` + + + +Writes the Data History contents to an XML file. + + + + + + +**Parameters**: + +* **fileName**: The file to write. It will be overwritten if it exists, or created if it doesn't. +* **includeRunData**:
+ + + +**Parameters**: + +* BSTR **fileName** +* _[optional]_ VARIANT **includeRunData** + +**Return type**: void + + +### Function fromXML + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::fromXML(BSTR xmlStr, [optional] VARIANT root) +``` + + + +Tells the Data History to load its state from the XML string passed in. + + + + + + +**Parameters**: + +* **xmlStr**: The XML string to read. +* **root**: The node ID of the node to begin reading at. This is useful if you are loading a larger document which contains a Data History node as a child. + + + +**Parameters**: + +* BSTR **xmlStr** +* _[optional]_ VARIANT **root** + +**Return type**: void + + +### Function fromXMLFile + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::fromXMLFile(BSTR fileName, [optional] VARIANT root) +``` + + + +Tells the Data History to load its state from the XML file passed in. + + + + + + +**Parameters**: + +* **fileName**: The name of the file to read. +* **root**: The node ID of the node to begin reading at. This is useful if you are loading a larger document which contains a Data History node as a child. + + + +**Parameters**: + +* BSTR **fileName** +* _[optional]_ VARIANT **root** + +**Return type**: void + + +### Function toCSV + +![][public] + +``` +BSTR PHXDATAHISTORYLib::_DPHXDataHistory::toCSV([optional] VARIANT variablesInRows, [optional] VARIANT includeFailed) +``` + + + +Returns a CSV string of all the data in the Data History. + + + + + + +**Parameters**: + +* **variablesInRows**: If true, variables will be in rows. If false, they will be in columns. +* **includeFailed**: Whether to include failed runs in the output. + + +**Returns**: + +The string of comma-seperated values. + + + +**Parameters**: + +* _[optional]_ VARIANT **variablesInRows** +* _[optional]_ VARIANT **includeFailed** + +**Return type**: BSTR + + +### Function getNumNonEmptyRuns + +![][public] + +``` +long PHXDATAHISTORYLib::_DPHXDataHistory::getNumNonEmptyRuns() +``` + + + +Returns the number of runs which have at least one piece of data filled in. +**Returns**: + +The number of runs that contain data. + + + +**Return type**: long + + +### Function getVariable + +![][public] + +``` +IDispatch * PHXDATAHISTORYLib::_DPHXDataHistory::getVariable(VARIANT index) +``` + + + +Gets the [IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) object for a particular Variable. + + + + + + +**Parameters**: + +* **index**: Either a 0 based index to the Variable, or the name of a Variable. + + +**Returns**: + +An IDispatch* to the [IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) object. + + + +**Parameters**: + +* VARIANT **index** + +**Return type**: IDispatch * + + +### Function createVariable + +![][public] + +``` +IDispatch * PHXDATAHISTORYLib::_DPHXDataHistory::createVariable() +``` + + + +Creates a new [IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) object so that you can fill it in and pass it to addVariable. +**Returns**: + +An IDispatch* to a newly created [IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) object. + + + +**Return type**: IDispatch * + + +### Function isRunning + +![][public] + +``` +boolean PHXDATAHISTORYLib::_DPHXDataHistory::isRunning() +``` + + + +Returns true if the running flag is set. +**Returns**: + +True if running flag is set, else false. + + + +**Return type**: boolean + + +### Function getNumExpectedRuns + +![][public] + +``` +long PHXDATAHISTORYLib::_DPHXDataHistory::getNumExpectedRuns() +``` + + + +Returns the number of runs expected for this Trade Study. +**Returns**: + +The number of expected runs. + + + +**Return type**: long + + +### Function getRunName + +![][public] + +``` +BSTR PHXDATAHISTORYLib::_DPHXDataHistory::getRunName(long runNum) +``` + + + +Returns the human readable name for a particular run. Usually this is blank, but can be used for things like Design Histories and snapshots. + + + + + + +**Parameters**: + +* **runNum**: The 0 based index to the run to access. + + +**Returns**: + +The name of the particular run. + + + +**Parameters**: + +* long **runNum** + +**Return type**: BSTR + + +### Function setRunName + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::setRunName(long runNum, BSTR name) +``` + + + +Sets the name of a run. This name typically will show up in the run header for the Table View and is only used for Snapshots and Design Histories. + + + + + + +**Parameters**: + +* **runNum**: The 0 based index to the run to access. +* **name**: The name of the run. + + + +**Parameters**: + +* long **runNum** +* BSTR **name** + +**Return type**: void + + +### Function insertRun + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::insertRun(long insertBefore) +``` + + + +Inserts a blank run. + + + + + + +**Parameters**: + +* **insertBefore**: The 0 based index to the run to reference. May be -1 to insert at the end. Usually -1 is not needed because setValue call will add runs automatically as necessary. + + + +**Parameters**: + +* long **insertBefore** + +**Return type**: void + + +### Function deleteRun + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::deleteRun(long run) +``` + + + +Deletes all the data for a numbered run. + + + + + + +**Parameters**: + +* **run**: The 0 based index to the run to delete. + + + +**Parameters**: + +* long **run** + +**Return type**: void + + +### Function deleteVariable + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::deleteVariable(VARIANT index) +``` + + + +Deletes a Variable from the Data History + + + + + + +**Parameters**: + +* **index**: Either a 0 based index to the Variable, or the name of a Variable. + + + +**Parameters**: + +* VARIANT **index** + +**Return type**: void + + +### Function getFormattedValue + +![][public] + +``` +BSTR PHXDATAHISTORYLib::_DPHXDataHistory::getFormattedValue(VARIANT index, long run) +``` + + + +Returns the value of a Variable for a run formatted according to the Variable's formatting mode. + + + + + + +**Parameters**: + +* **index**: Either a 0 based index to the Variable, or the name of a Variable. +* **run**: The 0 based index to the run to access. + + +**Returns**: + +The formatted value of the variable. + + + +**Parameters**: + +* VARIANT **index** +* long **run** + +**Return type**: BSTR + + +### Function setFormattedResult + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::setFormattedResult(VARIANT index, long run, BSTR value, boolean valid, boolean modified) +``` + + + +Sets the result for a run using formatted string text. + + + + + + +**Parameters**: + +* **index**: Either a 0 based index to the Variable, or the name of a Variable. +* **run**: The 0 based index to the run to access. +* **value**: The value of the Variable for this run, as a formatted string. +* **valid**: Whether this value is valid. +* **modified**: Whether this value's modified flag is set. + + + +**Parameters**: + +* VARIANT **index** +* long **run** +* BSTR **value** +* boolean **valid** +* boolean **modified** + +**Return type**: void + + +### Function getNumCustomVars + +![][public] + +``` +long PHXDATAHISTORYLib::_DPHXDataHistory::getNumCustomVars() +``` + + + +Returns the number of Variables which are marked as Custom Variables. +**Returns**: + +The number of custom variables. + + + +**Return type**: long + + +### Function getUniqueID + +![][public] + +``` +long PHXDATAHISTORYLib::_DPHXDataHistory::getUniqueID() +``` + + + +Gets an ID that uniquely identifies this Data History with the current running process. Is not unique across multiple processes. +**Returns**: + +The unique ID for this DataHistory object. + + + +**Return type**: long + + +### Function getVariableValues + +![][public] + +``` +VARIANT PHXDATAHISTORYLib::_DPHXDataHistory::getVariableValues(VARIANT index) +``` + + + +Gets all the values of a variable as an array of variants. + + + + + + +**Parameters**: + +* **index**: The 0 based index or name of the variable to query. + + + +**Parameters**: + +* VARIANT **index** + +**Return type**: VARIANT + + +### Function createDesignVariable + +![][public] + +``` +long PHXDATAHISTORYLib::_DPHXDataHistory::createDesignVariable(VARIANT index) +``` + + + +Creates a design variable with the same properties and data as the specified variable. + + + + + + +**Parameters**: + +* **index**: The 0 based index of the variable to copy. + + +**Returns**: + +The index of the newly created variable. + + + +**Parameters**: + +* VARIANT **index** + +**Return type**: long + + +### Function addVariableAt + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::addVariableAt(LPDISPATCH var, long location) +``` + + + +Adds a Variable to the Data History. All existing runs are appended with a blank value for this Variable. + + + + + + +**Parameters**: + +* **var**: Pass in a filled in [IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) object from a previous call to [createVariable()](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory_1a68acd508b225f5c74c27daf848f3ae27). +* **location**: The 0 based index of where to put the variable. Data History will enforce that variables are grouped first by design variables, then non-design variables. + + + +**Parameters**: + +* LPDISPATCH **var** +* long **location** + +**Return type**: void + + +### Function setVariableValues + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::setVariableValues(VARIANT index, long run, VARIANT values, boolean valid, boolean modified) +``` + + + +Sets all values of a variable as a chunk. + + + + + + +**Parameters**: + +* **index**: Variable ID (0-based index). +* **run**: Run ID (0-based index). +* **values**: Array of values. +* **valid**: Whether values are valid. +* **modified**: Whether values should appear as modified. + + + +**Parameters**: + +* VARIANT **index** +* long **run** +* VARIANT **values** +* boolean **valid** +* boolean **modified** + +**Return type**: void + + +### Function isHighlighted + +![][public] + +``` +boolean PHXDATAHISTORYLib::_DPHXDataHistory::isHighlighted(long run) +``` + + + +Check highlight state. + + + + + + +**Parameters**: + +* **run**: Run ID (0-based index). + + +**Returns**: + +True if hightlighted, false otherwise. + + + +**Parameters**: + +* long **run** + +**Return type**: boolean + + +### Function highlight + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::highlight(long run, boolean highlight, boolean handleEvent) +``` + + + +Highlight or unhighlight a run. + + + + + + +?> setting this will reset your highlighted items to just this item, or in the case of unhighlighting it will unhighlight all items. + + +**Parameters**: + +* **run**: Run ID (0-based index). +* **highlight**: True to highlight, false to remove highlight. +* **handleEvent**: Handle highlight event in the listener. + + + +**Parameters**: + +* long **run** +* boolean **highlight** +* boolean **handleEvent** + +**Return type**: void + + +### Function getNumDesignVariables + +![][public] + +``` +long PHXDATAHISTORYLib::_DPHXDataHistory::getNumDesignVariables() +``` + + + +Returns the number of Variables which are marked as Design Variables. +**Returns**: + +The number of design variables. + + + +**Return type**: long + + +### Function setTradeStudySetup + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::setTradeStudySetup(BSTR setup) +``` + + + +Sets the trade study XML setup data. +**Parameters**: + +* **setup**: The XML string to set up the trade study. + + + +**Parameters**: + +* BSTR **setup** + +**Return type**: void + + +### Function getTradeStudySetup + +![][public] + +``` +BSTR PHXDATAHISTORYLib::_DPHXDataHistory::getTradeStudySetup() +``` + + + +Gets the trade study setup, in XML form, used for generating the data. +**Returns**: + +The XML representaion of the trady study setup. + + + +**Return type**: BSTR + + +### Function setTradeStudyType + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::setTradeStudyType(BSTR type) +``` + + + +Sets the trade study type that generated the data ("DOE", "PAT", etc). +**Parameters**: + +* **type**: The type of trade study. + + + +**Parameters**: + +* BSTR **type** + +**Return type**: void + + +### Function getTradeStudyType + +![][public] + +``` +BSTR PHXDATAHISTORYLib::_DPHXDataHistory::getTradeStudyType() +``` + + + +Gets the trade study type that generated the data ("DOE", "PAT", etc). +**Returns**: + +The type of trade study. + + + +**Return type**: BSTR + + +### Function setShortVariableNames + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::setShortVariableNames(boolean shortenVariableNames) +``` + + + +Sets a flag that determines if variables will be returned in long or short form. + + + + + + +**Parameters**: + +* **shortenVariableNames**: True to shorten variable names. + + + +**Parameters**: + +* boolean **shortenVariableNames** + +**Return type**: void + + +### Function setRunValues + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::setRunValues(long run, VARIANT values, BOOL valid, BOOL modified) +``` + + + +Sets all values of a variable as a chunk. + + + + + + +**Parameters**: + +* **run**: Run ID (0-based index). +* **values**: Array of values. +* **valid**: Whether values are valid. +* **modified**: Whether values should appear as modified. + + + +**Parameters**: + +* long **run** +* VARIANT **values** +* BOOL **valid** +* BOOL **modified** + +**Return type**: void + + +### Function getFailedRunIndexes + +![][public] + +``` +VARIANT PHXDATAHISTORYLib::_DPHXDataHistory::getFailedRunIndexes() +``` + + + +Gets an array which contains all the indexes of runs which have errors. +**Returns**: + +An array of long values. + + + +**Return type**: VARIANT + + +### Function toXMLSaveContext + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::toXMLSaveContext(LPDISPATCH saveContext, [optional] VARIANT includeRunData) +``` + + + +Writes the Data History contents to an XML file. + + + + + + +**Parameters**: + +* **saveContext**: Context to use when loading this file, used for storing large files and other data contained in the save file but not directly in the XML. +* **includeRunData**:
+ + + +**Parameters**: + +* LPDISPATCH **saveContext** +* _[optional]_ VARIANT **includeRunData** + +**Return type**: void + + +### Function fromXMLSaveContext + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::fromXMLSaveContext(LPDISPATCH saveContext, [optional] VARIANT root) +``` + + + +Tells the Data History to load its state from the XML file passed in. + + + + + + +**Parameters**: + +* **saveContext**: Context to use when loading this file, used for storing large files and other data contained in the save file but not directly in the XML.
+* **root**: The node ID of the node to begin reading at. This is useful if you are loading a larger document which contains a Data History node as a child. + + + +**Parameters**: + +* LPDISPATCH **saveContext** +* _[optional]_ VARIANT **root** + +**Return type**: void + + +### Function getCompletedRunIndices + +![][public] + +``` +VARIANT PHXDATAHISTORYLib::_DPHXDataHistory::getCompletedRunIndices() +``` + + + +Gets an array which contains all the indices of runs which completed +**Returns**: + +An array of long values. + + + +**Return type**: VARIANT + + +### Function isRunComplete + +![][public] + +``` +boolean PHXDATAHISTORYLib::_DPHXDataHistory::isRunComplete(long run) +``` + + + +Gets whether the run is complete or not +**Parameters**: + +* **run**: Run ID (0-based index). + + +**Returns**: + +Whether the run has completed or not + + + +**Parameters**: + +* long **run** + +**Return type**: boolean + + +### Function addCheckpoint + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::addCheckpoint(long runNumber, BSTR value) +``` + + + +Add a warm start checkpoint to the cache +**Parameters**: + +* **name**: name for the checkpoint +* **value**: value for the checkpoint + + + +**Parameters**: + +* long **runNumber** +* BSTR **value** + +**Return type**: void + + +### Function getNumCheckpoints + +![][public] + +``` +long PHXDATAHISTORYLib::_DPHXDataHistory::getNumCheckpoints() +``` + + + +Gets the number of warm start checkpoints available +**Returns**: + +the number of warm start checkpoints available + + + +**Return type**: long + + +### Function getCheckpointValue + +![][public] + +``` +BSTR PHXDATAHISTORYLib::_DPHXDataHistory::getCheckpointValue(long checkpointIndex) +``` + + + +Gets the wam start checkpoint's value, the caller is responsible for releasing the BSTR memory. +**Parameters**: + +* **checkpointIndex**: Checkpoint Index (0-based index) + + +**Returns**: + +the checkpoint value + + + +**Parameters**: + +* long **checkpointIndex** + +**Return type**: BSTR + + +### Function getCheckpointRunNumber + +![][public] + +``` +long PHXDATAHISTORYLib::_DPHXDataHistory::getCheckpointRunNumber(long checkpointIndex) +``` + + + +Gets the warm start checkpoint's run number +**Parameters**: + +* **checkpointIndex**: Checkpoint Index (0-based index) + + +**Returns**: + +the checkpoint run number + + + +**Parameters**: + +* long **checkpointIndex** + +**Return type**: long + + +### Function setUniqueID + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::setUniqueID(long identifier) +``` + + + +Sets an ID that uniquely identifies this Data History. +**Parameters**: + +* **identifier**: The unique ID for this DataHistory object. + + + +**Parameters**: + +* long **identifier** + +**Return type**: void + + +### Function getNumCompletedRuns + +![][public] + +``` +long PHXDATAHISTORYLib::_DPHXDataHistory::getNumCompletedRuns() +``` + + + +Retrieves the number of completed runs for the current trade study. + + + + + + +**Returns**: + +The number of completed runs for the current trade study + + + +**Return type**: long + + +### Function getCompletedRunData + +![][public] + +``` +ULONG PHXDATAHISTORYLib::_DPHXDataHistory::getCompletedRunData([out] VARIANT *runIDs, [out] VARIANT *errorIDs, [out] VARIANT *errorMessages, [out] VARIANT *variableValues, [out] LONG *endSequenceNumber, [in, defaultvalue(0)] ULONG startSequenceNumber, [in, defaultvalue(0xFFFFFFFF)] ULONG maxLength, [in, defaultvalue(FALSE)] boolean allVariables) +``` + + + +Gets runIDs, error IDs, error messages, and variable values for completed runs of only design variables unless allVariables param is set to true. +?> If the PHXDataHistoryEvents::dataChanged event is fired with a runIndex of -1, the completed-run list is purged and reconstructed. Therefore the next call to this method should restart startSequenceNumber with 0. + + +?> If a startSequenceNumber is given that is greater than the number of items in the completed-run list (out of range), this method will act as if a startSequenceNumber of 0 had been given. + + +**Parameters**: + +* **runIDs**: array of longs, runIDs that have recently completed. +* **errorIDs**: array of longs, error IDs for each corresponding run in runIDs.
+ 0 indicates success, all other values indicate failure. +* **errorMessages**: array of strings, error messages for each corresponding run in runIDs. +* **variableValues**: multi-dimensional array of VARIANTs, variable values. First index is for each run in runIDs and the second index is for each variable. +* **endSequenceNumber**: index of the last avalable completed run. Will be -1 if there are no completed runs avalable. +* **startSequenceNumber**: index in the completed-run list to begin fetching from. Defaults to 0, the start of the list. +* **maxLength**: maximum number of completed runs to fetch. Defaults to requesting all available runs. +* **allVariables**: flag if true will result in run data returned for all variables else only design variable data will be returned + + +**Returns**: + +next startSequenceNumber to use in next call to getCompletedRunData. This value may be greater than (startSequenceNumber + runs) if a given run completed multiple times due to re-runs. + + + +**Parameters**: + +* _[out]_ VARIANT * **runIDs** +* _[out]_ VARIANT * **errorIDs** +* _[out]_ VARIANT * **errorMessages** +* _[out]_ VARIANT * **variableValues** +* _[out]_ LONG * **endSequenceNumber** +* _[in, defaultvalue(0)]_ ULONG **startSequenceNumber** +* _[in, defaultvalue(0xFFFFFFFF)]_ ULONG **maxLength** +* _[in, defaultvalue(FALSE)]_ boolean **allVariables** + +**Return type**: ULONG + + +### Function getHighlightedRuns + +![][public] + +``` +VARIANT PHXDATAHISTORYLib::_DPHXDataHistory::getHighlightedRuns() +``` + + + +Retrieve the set of currently highlighted run indices +**Returns**: + +the set of currently highlighted run indices as an array of integers + + + +**Return type**: VARIANT + + +### Function setHighlightedRuns + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::setHighlightedRuns(VARIANT selectedRunIndices) +``` + + + +Specify the set of currently highlighted run indices. +?> This will overwrite the existing highlighted runs. + + +**Parameters**: + +* **selectedRunIndices**: the set of run indices to highlight, specified by either a single integer, numeric string, array of integers, or array of numeric strings. Specifying an empty or null value will remove all highlighted run indices. + + +**Exceptions**: + +* **COM**: exception thrown if passed non-numeric types or arrays of non-numeric types. + + + +**Parameters**: + +* VARIANT **selectedRunIndices** + +**Return type**: void + + +### Function addVariableStructs + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::addVariableStructs(VARIANT dhVarStructs, long run) +``` + + + +Sets the results for a run. This method will add variables to the DataHistory if they are not already present File variables are not supported, their value cannot be represented in a [DataHistoryVariableStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct) +**Parameters**: + +* **dhVarStructs**: SAFEARRAY of DataHistoryVariableStructs to add +* **run**: The 0 based index to the run to set. + + + +**Parameters**: + +* VARIANT **dhVarStructs** +* long **run** + +**Return type**: void + +## Private functions + + +### Function fromCenterLink + +![][private] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::fromCenterLink(BSTR serverName, BSTR runMatrixID, BSTR userName, BSTR password) +``` + + + + + + + +**Parameters**: + +* BSTR **serverName** +* BSTR **runMatrixID** +* BSTR **userName** +* BSTR **password** + +**Return type**: void + + +### Function setUsernamePassword + +![][private] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::setUsernamePassword(BSTR username, BSTR password) +``` + + + + + + + +**Parameters**: + +* BSTR **username** +* BSTR **password** + +**Return type**: void + + +### Function setResultAsFile + +![][private] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::setResultAsFile(VARIANT index, long run, boolean valid, boolean modified, BSTR tempFileName, BSTR tempFileDir) +``` + + + + + + + +**Parameters**: + +* VARIANT **index** +* long **run** +* boolean **valid** +* boolean **modified** +* BSTR **tempFileName** +* BSTR **tempFileDir** + +**Return type**: void + + +### Function getDatabaseFile + +![][private] + +``` +BSTR PHXDATAHISTORYLib::_DPHXDataHistory::getDatabaseFile() +``` + + + + + + + +**Return type**: BSTR + + +### Function setDatabaseFile + +![][private] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::setDatabaseFile(BSTR filename) +``` + + + + + + + +**Parameters**: + +* BSTR **filename** + +**Return type**: void + + +### Function removeAutosave + +![][private] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistory::removeAutosave() +``` + + + + + + + +**Return type**: void + + +### Function getVariable2 + +![][private] + +``` +IDispatch * PHXDATAHISTORYLib::_DPHXDataHistory::getVariable2(VARIANT index) +``` + + + + + + + +**Parameters**: + +* VARIANT **index** + +**Return type**: IDispatch * + + +### Function getVariableTempDir + +![][private] + +``` +BSTR PHXDATAHISTORYLib::_DPHXDataHistory::getVariableTempDir(VARIANT index) +``` + + + + + + + +**Parameters**: + +* VARIANT **index** + +**Return type**: BSTR + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md index 73d24baa01..cdafa3f068 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md @@ -1,200 +1,199 @@ - -# Interface PHXDATAHISTORYLib::\_DPHXDataHistoryEvents - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 796) - - - -Events interface for [PHXDataHistory](classPHXDATAHISTORYLib_1_1PHXDataHistory.md#classPHXDATAHISTORYLib_1_1PHXDataHistory); not actually a separate interface - -## Members - -* [dataChanged](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1aa6f5dbeba5082e060cb68696cd07d44f) -* [highlightChanged](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a84baf9536c489fbb318a5e13cbf6fef5) -* [progressMeterChange](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a2f121535f7eedf77ce9e6edb9b512a51) -* [progressMeterEstimate](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1af43f03e636994de756db750668ac86d6) -* [progressMeterStart](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1aca4688267a060ab301972886d0c04d6e) -* [progressMeterStop](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a0fb85ceb307de0a1c2a449be77890447) -* [variablesChanged](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a9a2402c1679d7707f2f274399276107d) - -## Public functions - - -### Function variablesChanged - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::variablesChanged() -``` - - - -This event is called anytime Variables are added or removed. - - - -**Return type**: void - - -### Function progressMeterChange - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::progressMeterChange(long completed, long total) -``` - - - -This event is fired any time a new progress meter information is available, typically due to runs coming in. - - - - - - -**Parameters**: - -* **completed**: The number of runs with data. -* **total**: The total number of expected runs. - - - -**Parameters**: - -* long **completed** -* long **total** - -**Return type**: void - - -### Function progressMeterStart - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::progressMeterStart() -``` - - - -This event is fired when startRuns is called. - - - -**Return type**: void - - -### Function progressMeterStop - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::progressMeterStop() -``` - - - -This event is fired when endRuns is called. - - - -**Return type**: void - - -### Function dataChanged - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::dataChanged(long varIndex, long runIndex) -``` - - - -This event is fired any time any data item within the Data History is changed. - - - - - - -**Parameters**: - -* **varIndex**: The 0 based index to the Variable which changed. May be -1 to indicate a large sweeping change that might affect all Variables. -* **runIndex**: The 0 based index to the run which changed. May be -1 to indicate that a large changed happened, possibly involving all the runs. - - - -**Parameters**: - -* long **varIndex** -* long **runIndex** - -**Return type**: void - - -### Function progressMeterEstimate - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::progressMeterEstimate(long estimate) -``` - - - -This event is fired when the process attempts to determine how long the job is going to take time-wise based off of previous run result timings. - - - - - - -**Parameters**: - -* **estimate**: Value of the estimate of how long the job is going to take. - - - -**Parameters**: - -* long **estimate** - -**Return type**: void - - -### Function highlightChanged - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::highlightChanged(long runIndex, boolean highlight, boolean handleEvent) -``` - - - -This event is fired when a different run is selected. -**Parameters**: - -* **runIndex**: The index of the run. -* **highlight**: Whether to visibly highlight the newly selected run. -* **handleEvent**: If false, will just return. - - - -**Parameters**: - -* long **runIndex** -* boolean **highlight** -* boolean **handleEvent** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface PHXDATAHISTORYLib::\_DPHXDataHistoryEvents + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 796) + + + +Events interface for [PHXDataHistory](classPHXDATAHISTORYLib_1_1PHXDataHistory.md#classPHXDATAHISTORYLib_1_1PHXDataHistory); not actually a separate interface + +## Members + +* [dataChanged](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1aa6f5dbeba5082e060cb68696cd07d44f) +* [highlightChanged](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a84baf9536c489fbb318a5e13cbf6fef5) +* [progressMeterChange](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a2f121535f7eedf77ce9e6edb9b512a51) +* [progressMeterEstimate](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1af43f03e636994de756db750668ac86d6) +* [progressMeterStart](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1aca4688267a060ab301972886d0c04d6e) +* [progressMeterStop](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a0fb85ceb307de0a1c2a449be77890447) +* [variablesChanged](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents_1a9a2402c1679d7707f2f274399276107d) + +## Public functions + + +### Function variablesChanged + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::variablesChanged() +``` + + + +This event is called anytime Variables are added or removed. + + + +**Return type**: void + + +### Function progressMeterChange + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::progressMeterChange(long completed, long total) +``` + + + +This event is fired any time a new progress meter information is available, typically due to runs coming in. + + + + + + +**Parameters**: + +* **completed**: The number of runs with data. +* **total**: The total number of expected runs. + + + +**Parameters**: + +* long **completed** +* long **total** + +**Return type**: void + + +### Function progressMeterStart + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::progressMeterStart() +``` + + + +This event is fired when startRuns is called. + + + +**Return type**: void + + +### Function progressMeterStop + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::progressMeterStop() +``` + + + +This event is fired when endRuns is called. + + + +**Return type**: void + + +### Function dataChanged + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::dataChanged(long varIndex, long runIndex) +``` + + + +This event is fired any time any data item within the Data History is changed. + + + + + + +**Parameters**: + +* **varIndex**: The 0 based index to the Variable which changed. May be -1 to indicate a large sweeping change that might affect all Variables. +* **runIndex**: The 0 based index to the run which changed. May be -1 to indicate that a large changed happened, possibly involving all the runs. + + + +**Parameters**: + +* long **varIndex** +* long **runIndex** + +**Return type**: void + + +### Function progressMeterEstimate + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::progressMeterEstimate(long estimate) +``` + + + +This event is fired when the process attempts to determine how long the job is going to take time-wise based off of previous run result timings. + + + + + + +**Parameters**: + +* **estimate**: Value of the estimate of how long the job is going to take. + + + +**Parameters**: + +* long **estimate** + +**Return type**: void + + +### Function highlightChanged + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistoryEvents::highlightChanged(long runIndex, boolean highlight, boolean handleEvent) +``` + + + +This event is fired when a different run is selected. +**Parameters**: + +* **runIndex**: The index of the run. +* **highlight**: Whether to visibly highlight the newly selected run. +* **handleEvent**: If false, will just return. + + + +**Parameters**: + +* long **runIndex** +* boolean **highlight** +* boolean **handleEvent** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md index 84cafc7216..5134b37cda 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md @@ -1,199 +1,198 @@ - -# Interface PHXDATAHISTORYLib::\_DPHXDataHistoryToModel - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 715) - - - -The Data History to Model connector is the piece that connects a Data History to a [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) instance, for the purpose of restoring a run or re-running runs. It allows a user to override the default behaviors of the "Save to Model" and "Rerun Runs" capabilities of Data Explorer. - -## Members - -* [canRerunRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a080673db51fe153fd870e46b9dd4f221) -* [canSaveToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a3123522cb86b3daa95c56f60b99a4f9e) -* [closeDataHistory](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a9ead478fc2486a3ac01b73ee8b3962be) -* [rerunRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a2d1c0808d8fcdfe748d3194c45eda87a) -* [saveToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a6efbbc76935609344ddfe8b48eaac5c1) - -## Public functions - - -### Function canSaveToModel - -![][public] - -``` -BOOL PHXDATAHISTORYLib::_DPHXDataHistoryToModel::canSaveToModel(LPDISPATCH dataHistory, long run) -``` - - - -Determine if a run could be saved to the model; returning FALSE means that option should be disabled in any menus. - - - - - - -**Parameters**: - -* **dataHistory**: the data history to check in regards to -* **run**: the index of the run to check - - -**Returns**: - -TRUE if the run could be saved, FALSE if not - - - -**Parameters**: - -* LPDISPATCH **dataHistory** -* long **run** - -**Return type**: BOOL - - -### Function saveToModel - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistoryToModel::saveToModel(LPDISPATCH dataHistory, long run) -``` - - - -Notify that a user has requested to save the indicated run to the model.
- - - - - - - -**Parameters**: - -* **dataHistory**: the data history to supply the data -* **run**: the index of the run to save - - - -**Parameters**: - -* LPDISPATCH **dataHistory** -* long **run** - -**Return type**: void - - -### Function canRerunRuns - -![][public] - -``` -BOOL PHXDATAHISTORYLib::_DPHXDataHistoryToModel::canRerunRuns(LPDISPATCH dataHistory, VARIANT runs) -``` - - - -Determine if the specified runs can be re-run. Returning FALSE means that the option should be disabled in any menus. - - - - - - -**Parameters**: - -* **dataHistory**: the data history to check in regards to -* **runs**: an array of run indexes - - -**Returns**: - -True if the runs can be re-run, false if not. - - - -**Parameters**: - -* LPDISPATCH **dataHistory** -* VARIANT **runs** - -**Return type**: BOOL - - -### Function rerunRuns - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistoryToModel::rerunRuns(LPDISPATCH dataHistory, VARIANT runs) -``` - - - -Notify that the user has requested to re-run a set of runs. Does not wait for the runs to complete. endRuns from [PHXDataHistory](classPHXDATAHISTORYLib_1_1PHXDataHistory.md#classPHXDATAHISTORYLib_1_1PHXDataHistory) will be called when completed. - - - - - - -**Parameters**: - -* **dataHistory**: the data history to read and write from -* **runs**: an array of run indexes - - - -**Parameters**: - -* LPDISPATCH **dataHistory** -* VARIANT **runs** - -**Return type**: void - - -### Function closeDataHistory - -![][public] - -``` -void PHXDATAHISTORYLib::_DPHXDataHistoryToModel::closeDataHistory(LPDISPATCH dataHistory) -``` - - - -Notify that the user is attempting to close the given data history. - - - - - - -**Parameters**: - -* **dataHistory**: the data history the user is attempting to close - - -**Exceptions**: - -* **Exception**: on error - - - -**Parameters**: - -* LPDISPATCH **dataHistory** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface PHXDATAHISTORYLib::\_DPHXDataHistoryToModel + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 715) + + + +The Data History to Model connector is the piece that connects a Data History to a [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) instance, for the purpose of restoring a run or re-running runs. It allows a user to override the default behaviors of the "Save to Model" and "Rerun Runs" capabilities of Data Explorer. + +## Members + +* [canRerunRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a080673db51fe153fd870e46b9dd4f221) +* [canSaveToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a3123522cb86b3daa95c56f60b99a4f9e) +* [closeDataHistory](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a9ead478fc2486a3ac01b73ee8b3962be) +* [rerunRuns](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a2d1c0808d8fcdfe748d3194c45eda87a) +* [saveToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel_1a6efbbc76935609344ddfe8b48eaac5c1) + +## Public functions + + +### Function canSaveToModel + +![][public] + +``` +BOOL PHXDATAHISTORYLib::_DPHXDataHistoryToModel::canSaveToModel(LPDISPATCH dataHistory, long run) +``` + + + +Determine if a run could be saved to the model; returning FALSE means that option should be disabled in any menus. + + + + + + +**Parameters**: + +* **dataHistory**: the data history to check in regards to +* **run**: the index of the run to check + + +**Returns**: + +TRUE if the run could be saved, FALSE if not + + + +**Parameters**: + +* LPDISPATCH **dataHistory** +* long **run** + +**Return type**: BOOL + + +### Function saveToModel + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistoryToModel::saveToModel(LPDISPATCH dataHistory, long run) +``` + + + +Notify that a user has requested to save the indicated run to the model.
+ + + + + + + +**Parameters**: + +* **dataHistory**: the data history to supply the data +* **run**: the index of the run to save + + + +**Parameters**: + +* LPDISPATCH **dataHistory** +* long **run** + +**Return type**: void + + +### Function canRerunRuns + +![][public] + +``` +BOOL PHXDATAHISTORYLib::_DPHXDataHistoryToModel::canRerunRuns(LPDISPATCH dataHistory, VARIANT runs) +``` + + + +Determine if the specified runs can be re-run. Returning FALSE means that the option should be disabled in any menus. + + + + + + +**Parameters**: + +* **dataHistory**: the data history to check in regards to +* **runs**: an array of run indexes + + +**Returns**: + +True if the runs can be re-run, false if not. + + + +**Parameters**: + +* LPDISPATCH **dataHistory** +* VARIANT **runs** + +**Return type**: BOOL + + +### Function rerunRuns + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistoryToModel::rerunRuns(LPDISPATCH dataHistory, VARIANT runs) +``` + + + +Notify that the user has requested to re-run a set of runs. Does not wait for the runs to complete. endRuns from [PHXDataHistory](classPHXDATAHISTORYLib_1_1PHXDataHistory.md#classPHXDATAHISTORYLib_1_1PHXDataHistory) will be called when completed. + + + + + + +**Parameters**: + +* **dataHistory**: the data history to read and write from +* **runs**: an array of run indexes + + + +**Parameters**: + +* LPDISPATCH **dataHistory** +* VARIANT **runs** + +**Return type**: void + + +### Function closeDataHistory + +![][public] + +``` +void PHXDATAHISTORYLib::_DPHXDataHistoryToModel::closeDataHistory(LPDISPATCH dataHistory) +``` + + + +Notify that the user is attempting to close the given data history. + + + + + + +**Parameters**: + +* **dataHistory**: the data history the user is attempting to close + + +**Exceptions**: + +* **Exception**: on error + + + +**Parameters**: + +* LPDISPATCH **dataHistory** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePlugInMetaData_1_1IPlugInMetaData.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePlugInMetaData_1_1IPlugInMetaData.md index 14fe355f76..68472da34b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePlugInMetaData_1_1IPlugInMetaData.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfacePlugInMetaData_1_1IPlugInMetaData.md @@ -1,128 +1,127 @@ - -# Interface PlugInMetaData::IPlugInMetaData - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_PlugInMetaData/PlugInMetaData.odl` (line 18) - - - - - -## Members - -* [getAuthor](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a302223e3912f3e34a512a5ef323e0939) -* [getDescription](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1aea971d69e4505696518f69057dde4863) -* [getHelpURL](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a81605db892f6e5dc71aa7a4f2d00686e) -* [getIconLocation](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1af49ffd75001ae0bfd3dade7f5b9562db) -* [getKeywords](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a38d839895f9ee3493710062d2bf67c34) -* [getVersion](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a7cb8178dec412b370f22e7a9905eb3d9) - -## Public functions - - -### Function getDescription - -![][public] - -``` -BSTR PlugInMetaData::IPlugInMetaData::getDescription() -``` - - - - - - - -**Return type**: BSTR - - -### Function getAuthor - -![][public] - -``` -BSTR PlugInMetaData::IPlugInMetaData::getAuthor() -``` - - - - - - - -**Return type**: BSTR - - -### Function getVersion - -![][public] - -``` -BSTR PlugInMetaData::IPlugInMetaData::getVersion() -``` - - - - - - - -**Return type**: BSTR - - -### Function getHelpURL - -![][public] - -``` -BSTR PlugInMetaData::IPlugInMetaData::getHelpURL() -``` - - - - - - - -**Return type**: BSTR - - -### Function getKeywords - -![][public] - -``` -BSTR PlugInMetaData::IPlugInMetaData::getKeywords() -``` - - - - - - - -**Return type**: BSTR - - -### Function getIconLocation - -![][public] - -``` -BSTR PlugInMetaData::IPlugInMetaData::getIconLocation() -``` - - - - - - - -**Return type**: BSTR - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface PlugInMetaData::IPlugInMetaData + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_PlugInMetaData/PlugInMetaData.odl` (line 18) + + + + + +## Members + +* [getAuthor](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a302223e3912f3e34a512a5ef323e0939) +* [getDescription](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1aea971d69e4505696518f69057dde4863) +* [getHelpURL](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a81605db892f6e5dc71aa7a4f2d00686e) +* [getIconLocation](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1af49ffd75001ae0bfd3dade7f5b9562db) +* [getKeywords](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a38d839895f9ee3493710062d2bf67c34) +* [getVersion](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData_1a7cb8178dec412b370f22e7a9905eb3d9) + +## Public functions + + +### Function getDescription + +![][public] + +``` +BSTR PlugInMetaData::IPlugInMetaData::getDescription() +``` + + + + + + + +**Return type**: BSTR + + +### Function getAuthor + +![][public] + +``` +BSTR PlugInMetaData::IPlugInMetaData::getAuthor() +``` + + + + + + + +**Return type**: BSTR + + +### Function getVersion + +![][public] + +``` +BSTR PlugInMetaData::IPlugInMetaData::getVersion() +``` + + + + + + + +**Return type**: BSTR + + +### Function getHelpURL + +![][public] + +``` +BSTR PlugInMetaData::IPlugInMetaData::getHelpURL() +``` + + + + + + + +**Return type**: BSTR + + +### Function getKeywords + +![][public] + +``` +BSTR PlugInMetaData::IPlugInMetaData::getKeywords() +``` + + + + + + + +**Return type**: BSTR + + +### Function getIconLocation + +![][public] + +``` +BSTR PlugInMetaData::IPlugInMetaData::getIconLocation() +``` + + + + + + + +**Return type**: BSTR + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ICombinedPlugIn.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ICombinedPlugIn.md index 020a74c03b..2722602cdf 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ICombinedPlugIn.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ICombinedPlugIn.md @@ -1,27 +1,26 @@ - -# Interface TradeStudyPlugIn::ICombinedPlugIn - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 586) - - - -This interface is used for cases where a plug-in must be both an IComponentPlugIn and an [ITradeStudyPlugIn](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn). In most cases using this interface is not necessary, but in specific circumstances where COM types are directly instantiated and used between processes such as via Activator.CreateInstance and MarshalForExternalProcess.ComObjectToMarshalInfo. - -**Inherits from**: - -* [IComponentPlugIn](undefined.md#undefined) -* [TradeStudyPlugIn::ITradeStudyPlugIn](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn) - -## Members - -* [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a2b883bd3725cefb35daf8b629124a57f) -* [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a8c4352f776b3919a9a56aa61ff78c5d0) -* [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a7238385b054e9afddbe65c65644826e4) -* [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a58cdb46e4e8dca27761d7bd976c8fcf2) - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface TradeStudyPlugIn::ICombinedPlugIn + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 586) + + + +This interface is used for cases where a plug-in must be both an IComponentPlugIn and an [ITradeStudyPlugIn](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn). In most cases using this interface is not necessary, but in specific circumstances where COM types are directly instantiated and used between processes such as via Activator.CreateInstance and MarshalForExternalProcess.ComObjectToMarshalInfo. + +**Inherits from**: + +* [IComponentPlugIn](undefined.md#undefined) +* [TradeStudyPlugIn::ITradeStudyPlugIn](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn) + +## Members + +* [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a2b883bd3725cefb35daf8b629124a57f) +* [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a8c4352f776b3919a9a56aa61ff78c5d0) +* [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a7238385b054e9afddbe65c65644826e4) +* [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a58cdb46e4e8dca27761d7bd976c8fcf2) + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md index 416f3a38bf..c126cc4b0d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md @@ -1,178 +1,177 @@ - -# Interface TradeStudyPlugIn::ITradeStudy3JobInfo - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 193) - - - - - -## Members - -* [getVariableDisplayName](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1a6e0f4277d79e93bd5d08fa7e548394a0) -* [getVariableEquation](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1aed1386a6f6cef8c6c4ec1d94b3d07009) -* [isDesignVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1abbcbe48e293004c4cd609b574ecf94fa) -* [isInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1a02ddc66a224fd3c8fe04ec8ec60959e5) -* [numRuns](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1a27982338f106af2e2b89a29c66c2d8f1) -* [numVariables](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1ae684750b56d166406294cfc78bda83b3) - -## Properties - - -### Property numRuns - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 201) - -``` -TradeStudyPlugIn::ITradeStudy3JobInfo::numRuns -``` - -Get the number of runs. - - - - - -**Return type**: - - -### Property numVariables - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 206) - -``` -TradeStudyPlugIn::ITradeStudy3JobInfo::numVariables -``` - -Get the number of inputs. - - - - - -**Return type**: - -## Public functions - - -### Function getVariableEquation - -![][public] - -``` -BSTR TradeStudyPlugIn::ITradeStudy3JobInfo::getVariableEquation(long index) -``` - -Get the equation for the variable at the specified index. - -**Parameters**: - -* **index**: The index. - - -**Returns**: - -The equation. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - - -### Function getVariableDisplayName - -![][public] - -``` -BSTR TradeStudyPlugIn::ITradeStudy3JobInfo::getVariableDisplayName(long index) -``` - -Get the unique display name of a variable. - -**Parameters**: - -* **index**: The index. - - -**Returns**: - -The display name. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - - -### Function isDesignVariable - -![][public] - -``` -boolean TradeStudyPlugIn::ITradeStudy3JobInfo::isDesignVariable(VARIANT which) -``` - -Get the type associated with the specified variable. - -**Parameters**: - -* **which**: The name or index of the variable. - - -**Returns**: - -The variable type. - - - -**Parameters**: - -* VARIANT **which** - -**Return type**: boolean - - -### Function isInput - -![][public] - -``` -boolean TradeStudyPlugIn::ITradeStudy3JobInfo::isInput(VARIANT which) -``` - -Get the type associated with the specified variable. - -**Parameters**: - -* **which**: The name or index of the variable. - - -**Returns**: - -The variable type. - - - -**Parameters**: - -* VARIANT **which** - -**Return type**: boolean - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface TradeStudyPlugIn::ITradeStudy3JobInfo + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 193) + + + + + +## Members + +* [getVariableDisplayName](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1a6e0f4277d79e93bd5d08fa7e548394a0) +* [getVariableEquation](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1aed1386a6f6cef8c6c4ec1d94b3d07009) +* [isDesignVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1abbcbe48e293004c4cd609b574ecf94fa) +* [isInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1a02ddc66a224fd3c8fe04ec8ec60959e5) +* [numRuns](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1a27982338f106af2e2b89a29c66c2d8f1) +* [numVariables](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo_1ae684750b56d166406294cfc78bda83b3) + +## Properties + + +### Property numRuns + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 201) + +``` +TradeStudyPlugIn::ITradeStudy3JobInfo::numRuns +``` + +Get the number of runs. + + + + + +**Return type**: + + +### Property numVariables + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 206) + +``` +TradeStudyPlugIn::ITradeStudy3JobInfo::numVariables +``` + +Get the number of inputs. + + + + + +**Return type**: + +## Public functions + + +### Function getVariableEquation + +![][public] + +``` +BSTR TradeStudyPlugIn::ITradeStudy3JobInfo::getVariableEquation(long index) +``` + +Get the equation for the variable at the specified index. + +**Parameters**: + +* **index**: The index. + + +**Returns**: + +The equation. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + + +### Function getVariableDisplayName + +![][public] + +``` +BSTR TradeStudyPlugIn::ITradeStudy3JobInfo::getVariableDisplayName(long index) +``` + +Get the unique display name of a variable. + +**Parameters**: + +* **index**: The index. + + +**Returns**: + +The display name. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + + +### Function isDesignVariable + +![][public] + +``` +boolean TradeStudyPlugIn::ITradeStudy3JobInfo::isDesignVariable(VARIANT which) +``` + +Get the type associated with the specified variable. + +**Parameters**: + +* **which**: The name or index of the variable. + + +**Returns**: + +The variable type. + + + +**Parameters**: + +* VARIANT **which** + +**Return type**: boolean + + +### Function isInput + +![][public] + +``` +boolean TradeStudyPlugIn::ITradeStudy3JobInfo::isInput(VARIANT which) +``` + +Get the type associated with the specified variable. + +**Parameters**: + +* **which**: The name or index of the variable. + + +**Returns**: + +The variable type. + + + +**Parameters**: + +* VARIANT **which** + +**Return type**: boolean + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md index 1255e961ba..c25af463a0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md @@ -1,495 +1,494 @@ - -# Interface TradeStudyPlugIn::ITradeStudy3JobManager - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 342) - -Class which does everything that a combination of a DataHistory and a JobManager can do. Can be implemented using the inputs to a normal construct(...) call, but can do something else entirely. Thread-safe. - - - -## Members - -* [addVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a44f6cc3111c89abd357dfcfeed23cf4a) -* [canNewJob](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a0736cdac1a4c8573ec1332477849458b) -* [clear](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aeb34f0cf410ef02f4eee10d611b4a740) -* [dataHistory](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aec4a15702e1f9565f7564914cfef534a) -* [getMetaDataProvider](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a2f8bcf1cea9355a81d408919e479013f) -* [getVariableDisplayName](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a6fbac6e4218e6b82ed61d2f38f9b7af6) -* [getVariableEquation](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1ae152b41da461434289f61a5f4c327fb6) -* [isDesignVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aa53ea93d24fd4476de06e3226a5b2e69) -* [isInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a4f1199571453c7b851c484e88fb43a1a) -* [newJob](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a49263a87ff0aacb9e2231bbe0e726d1a) -* [numRuns](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1ac665a3e053e07b9bf007c5b798af743e) -* [numThreads](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a2b92bb066c911d4102902525a3feae5f) -* [numVariables](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aafb31c9ee4a9e013e3f7f77900217492) -* [runInParallel](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a1e97168b7c275486400eaaf14e9a88d2) -* [runJobAsync](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a7cdc64aa2ca295ed608347a61e79b8ac) -* [setInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a44b3d2bd5e6037197449aaa92c6fd725) -* [setRunInputs](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a2d73e6a448ba816d2f4025d5f95b285e) -* [setVariableInputs](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a5f77ca1741019e90b1d348a7b4c20b04) -* [supportsParallelExecution](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1afc7560080c238a34ac8d339d80175327) -* [validateAll](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a913715f9bb137763d7b099cfe8bd9b57) - -## Properties - - -### Property dataHistory - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 1) - -``` -LPDISPATCH TradeStudyPlugIn::ITradeStudy3JobManager::dataHistory -``` - -Get or set the data history to use; one may be created if you don't specify it. - - - - - -**Return type**: LPDISPATCH - - -### Property validateAll - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 1) - -``` -boolean TradeStudyPlugIn::ITradeStudy3JobManager::validateAll -``` - -Hint on whether to force all outputs in the model to evaluate regardless of whether it would be necessary to get the responses/outputs that have been requested. Default: false. - - - - - -**Return type**: boolean - - -### Property runInParallel - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 1) - -``` -boolean TradeStudyPlugIn::ITradeStudy3JobManager::runInParallel -``` - -Whether to run runs in parallel. May be ignored. - - - - - -**Return type**: boolean - - -### Property numThreads - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 1) - -``` -long TradeStudyPlugIn::ITradeStudy3JobManager::numThreads -``` - -The number of threads or instances to use for parallel execution. May be ignored. - - - - - -**Return type**: long - - -### Property numRuns - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 376) - -``` -TradeStudyPlugIn::ITradeStudy3JobManager::numRuns -``` - -Get the number of runs. - - - - - -**Return type**: - - -### Property numVariables - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 381) - -``` -TradeStudyPlugIn::ITradeStudy3JobManager::numVariables -``` - -Get the number of inputs. - - - - - -**Return type**: - - -### Property supportsParallelExecution - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 413) - -``` -TradeStudyPlugIn::ITradeStudy3JobManager::supportsParallelExecution -``` - -Can this job manager support parallel execution? If false, runInParallel and numThreads are ignored. - - - - - -**Return type**: - - -### Property canNewJob - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 418) - -``` -TradeStudyPlugIn::ITradeStudy3JobManager::canNewJob -``` - -Can a new job be started now? - - - - - -**Return type**: - -## Public functions - - -### Function getVariableEquation - -![][public] - -``` -BSTR TradeStudyPlugIn::ITradeStudy3JobManager::getVariableEquation(long index) -``` - -Get the equation for the variable at the specified index. - -**Parameters**: - -* **index**: The index. - - -**Returns**: - -The equation. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - - -### Function getVariableDisplayName - -![][public] - -``` -BSTR TradeStudyPlugIn::ITradeStudy3JobManager::getVariableDisplayName(long index) -``` - -Get the unique display name of a variable. - -**Parameters**: - -* **index**: The index. - - -**Returns**: - -The display name. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - - -### Function isDesignVariable - -![][public] - -``` -boolean TradeStudyPlugIn::ITradeStudy3JobManager::isDesignVariable(VARIANT which) -``` - -Get the type associated with the specified variable. - -**Parameters**: - -* **which**: The name or index of the variable. - - -**Returns**: - -The variable type. - - - -**Parameters**: - -* VARIANT **which** - -**Return type**: boolean - - -### Function isInput - -![][public] - -``` -boolean TradeStudyPlugIn::ITradeStudy3JobManager::isInput(VARIANT which) -``` - -Get the type associated with the specified variable. - -**Parameters**: - -* **which**: The name or index of the variable. - - -**Returns**: - -The variable type. - - - -**Parameters**: - -* VARIANT **which** - -**Return type**: boolean - - -### Function newJob - -![][public] - -``` -void TradeStudyPlugIn::ITradeStudy3JobManager::newJob(long numRuns) -``` - -Start a new job. Discards existing data and run info. Does not clear out variables. Note: whether you can start a new job while one is running depends on implementation. - -**Parameters**: - -* **numRuns**: The number of runs to execute. - - -**Exceptions**: - -* **InvalidOperationException**: If a job is running but the current implementation does not support concurrent jobs. - - - -**Parameters**: - -* long **numRuns** - -**Return type**: void - - -### Function clear - -![][public] - -``` -void TradeStudyPlugIn::ITradeStudy3JobManager::clear() -``` - -Clear out the current job and all variables. - - - - - -**Return type**: void - - -### Function addVariable - -![][public] - -``` -void TradeStudyPlugIn::ITradeStudy3JobManager::addVariable(BSTR equation, BSTR displayName, boolean isInput) -``` - -Add a variable. - -**Parameters**: - -* **equation**: The equation of the variable. -* **displayName**: The display name to use for the value. -* **isInput**: Whether the variable is an input. - - - -**Parameters**: - -* BSTR **equation** -* BSTR **displayName** -* boolean **isInput** - -**Return type**: void - - -### Function setInput - -![][public] - -``` -void TradeStudyPlugIn::ITradeStudy3JobManager::setInput(long runIndex, VARIANT which, VARIANT value) -``` - -Set an input value. - -**Parameters**: - -* **runIndex**: The index of the run. -* **which**: The name or index of the variable. -* **value**: The value to set (in native format; do not convert to string) - - - -**Parameters**: - -* long **runIndex** -* VARIANT **which** -* VARIANT **value** - -**Return type**: void - - -### Function setRunInputs - -![][public] - -``` -void TradeStudyPlugIn::ITradeStudy3JobManager::setRunInputs(long runIndex, SAFEARRAY(VARIANT) values, [optional] SAFEARRAY(VARIANT) which) -``` - -Set all of the inputs for a run. - -**Parameters**: - -* **runIndex**: The index of the run. -* **values**: The values, which must have the same number of elements as -* **which**: The indices or names of the variables to set, omit for all - - - -**Parameters**: - -* long **runIndex** -* SAFEARRAY(VARIANT) **values** -* _[optional]_ SAFEARRAY(VARIANT) **which** - -**Return type**: void - - -### Function setVariableInputs - -![][public] - -``` -void TradeStudyPlugIn::ITradeStudy3JobManager::setVariableInputs(VARIANT which, SAFEARRAY(VARIANT) values, [optional] SAFEARRAY(long) runIndices) -``` - -Set all of the inputs for one variable. - -**Parameters**: - -* **which**: Which variable (index or name). -* **values**: The values to set. -* **runIndices**: The runs to set values for; if null/empty, assume all. - - - -**Parameters**: - -* VARIANT **which** -* SAFEARRAY(VARIANT) **values** -* _[optional]_ SAFEARRAY(long) **runIndices** - -**Return type**: void - - -### Function runJobAsync - -![][public] - -``` -ITradeStudy3JobResult * TradeStudyPlugIn::ITradeStudy3JobManager::runJobAsync() -``` - -Execute the job. - -**Returns**: - -The result of the job, which will be populated in real-time. - - - -**Return type**: [ITradeStudy3JobResult](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult) * - - -### Function getMetaDataProvider - -![][public] - -``` -IVariableMetaDataProvider * TradeStudyPlugIn::ITradeStudy3JobManager::getMetaDataProvider() -``` - -Get the metadata provider for this job manager. - - - - - -**Return type**: [IVariableMetaDataProvider](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider) * - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface TradeStudyPlugIn::ITradeStudy3JobManager + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 342) + +Class which does everything that a combination of a DataHistory and a JobManager can do. Can be implemented using the inputs to a normal construct(...) call, but can do something else entirely. Thread-safe. + + + +## Members + +* [addVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a44f6cc3111c89abd357dfcfeed23cf4a) +* [canNewJob](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a0736cdac1a4c8573ec1332477849458b) +* [clear](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aeb34f0cf410ef02f4eee10d611b4a740) +* [dataHistory](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aec4a15702e1f9565f7564914cfef534a) +* [getMetaDataProvider](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a2f8bcf1cea9355a81d408919e479013f) +* [getVariableDisplayName](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a6fbac6e4218e6b82ed61d2f38f9b7af6) +* [getVariableEquation](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1ae152b41da461434289f61a5f4c327fb6) +* [isDesignVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aa53ea93d24fd4476de06e3226a5b2e69) +* [isInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a4f1199571453c7b851c484e88fb43a1a) +* [newJob](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a49263a87ff0aacb9e2231bbe0e726d1a) +* [numRuns](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1ac665a3e053e07b9bf007c5b798af743e) +* [numThreads](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a2b92bb066c911d4102902525a3feae5f) +* [numVariables](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1aafb31c9ee4a9e013e3f7f77900217492) +* [runInParallel](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a1e97168b7c275486400eaaf14e9a88d2) +* [runJobAsync](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a7cdc64aa2ca295ed608347a61e79b8ac) +* [setInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a44b3d2bd5e6037197449aaa92c6fd725) +* [setRunInputs](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a2d73e6a448ba816d2f4025d5f95b285e) +* [setVariableInputs](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a5f77ca1741019e90b1d348a7b4c20b04) +* [supportsParallelExecution](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1afc7560080c238a34ac8d339d80175327) +* [validateAll](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager_1a913715f9bb137763d7b099cfe8bd9b57) + +## Properties + + +### Property dataHistory + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 1) + +``` +LPDISPATCH TradeStudyPlugIn::ITradeStudy3JobManager::dataHistory +``` + +Get or set the data history to use; one may be created if you don't specify it. + + + + + +**Return type**: LPDISPATCH + + +### Property validateAll + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 1) + +``` +boolean TradeStudyPlugIn::ITradeStudy3JobManager::validateAll +``` + +Hint on whether to force all outputs in the model to evaluate regardless of whether it would be necessary to get the responses/outputs that have been requested. Default: false. + + + + + +**Return type**: boolean + + +### Property runInParallel + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 1) + +``` +boolean TradeStudyPlugIn::ITradeStudy3JobManager::runInParallel +``` + +Whether to run runs in parallel. May be ignored. + + + + + +**Return type**: boolean + + +### Property numThreads + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 1) + +``` +long TradeStudyPlugIn::ITradeStudy3JobManager::numThreads +``` + +The number of threads or instances to use for parallel execution. May be ignored. + + + + + +**Return type**: long + + +### Property numRuns + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 376) + +``` +TradeStudyPlugIn::ITradeStudy3JobManager::numRuns +``` + +Get the number of runs. + + + + + +**Return type**: + + +### Property numVariables + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 381) + +``` +TradeStudyPlugIn::ITradeStudy3JobManager::numVariables +``` + +Get the number of inputs. + + + + + +**Return type**: + + +### Property supportsParallelExecution + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 413) + +``` +TradeStudyPlugIn::ITradeStudy3JobManager::supportsParallelExecution +``` + +Can this job manager support parallel execution? If false, runInParallel and numThreads are ignored. + + + + + +**Return type**: + + +### Property canNewJob + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 418) + +``` +TradeStudyPlugIn::ITradeStudy3JobManager::canNewJob +``` + +Can a new job be started now? + + + + + +**Return type**: + +## Public functions + + +### Function getVariableEquation + +![][public] + +``` +BSTR TradeStudyPlugIn::ITradeStudy3JobManager::getVariableEquation(long index) +``` + +Get the equation for the variable at the specified index. + +**Parameters**: + +* **index**: The index. + + +**Returns**: + +The equation. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + + +### Function getVariableDisplayName + +![][public] + +``` +BSTR TradeStudyPlugIn::ITradeStudy3JobManager::getVariableDisplayName(long index) +``` + +Get the unique display name of a variable. + +**Parameters**: + +* **index**: The index. + + +**Returns**: + +The display name. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + + +### Function isDesignVariable + +![][public] + +``` +boolean TradeStudyPlugIn::ITradeStudy3JobManager::isDesignVariable(VARIANT which) +``` + +Get the type associated with the specified variable. + +**Parameters**: + +* **which**: The name or index of the variable. + + +**Returns**: + +The variable type. + + + +**Parameters**: + +* VARIANT **which** + +**Return type**: boolean + + +### Function isInput + +![][public] + +``` +boolean TradeStudyPlugIn::ITradeStudy3JobManager::isInput(VARIANT which) +``` + +Get the type associated with the specified variable. + +**Parameters**: + +* **which**: The name or index of the variable. + + +**Returns**: + +The variable type. + + + +**Parameters**: + +* VARIANT **which** + +**Return type**: boolean + + +### Function newJob + +![][public] + +``` +void TradeStudyPlugIn::ITradeStudy3JobManager::newJob(long numRuns) +``` + +Start a new job. Discards existing data and run info. Does not clear out variables. Note: whether you can start a new job while one is running depends on implementation. + +**Parameters**: + +* **numRuns**: The number of runs to execute. + + +**Exceptions**: + +* **InvalidOperationException**: If a job is running but the current implementation does not support concurrent jobs. + + + +**Parameters**: + +* long **numRuns** + +**Return type**: void + + +### Function clear + +![][public] + +``` +void TradeStudyPlugIn::ITradeStudy3JobManager::clear() +``` + +Clear out the current job and all variables. + + + + + +**Return type**: void + + +### Function addVariable + +![][public] + +``` +void TradeStudyPlugIn::ITradeStudy3JobManager::addVariable(BSTR equation, BSTR displayName, boolean isInput) +``` + +Add a variable. + +**Parameters**: + +* **equation**: The equation of the variable. +* **displayName**: The display name to use for the value. +* **isInput**: Whether the variable is an input. + + + +**Parameters**: + +* BSTR **equation** +* BSTR **displayName** +* boolean **isInput** + +**Return type**: void + + +### Function setInput + +![][public] + +``` +void TradeStudyPlugIn::ITradeStudy3JobManager::setInput(long runIndex, VARIANT which, VARIANT value) +``` + +Set an input value. + +**Parameters**: + +* **runIndex**: The index of the run. +* **which**: The name or index of the variable. +* **value**: The value to set (in native format; do not convert to string) + + + +**Parameters**: + +* long **runIndex** +* VARIANT **which** +* VARIANT **value** + +**Return type**: void + + +### Function setRunInputs + +![][public] + +``` +void TradeStudyPlugIn::ITradeStudy3JobManager::setRunInputs(long runIndex, SAFEARRAY(VARIANT) values, [optional] SAFEARRAY(VARIANT) which) +``` + +Set all of the inputs for a run. + +**Parameters**: + +* **runIndex**: The index of the run. +* **values**: The values, which must have the same number of elements as +* **which**: The indices or names of the variables to set, omit for all + + + +**Parameters**: + +* long **runIndex** +* SAFEARRAY(VARIANT) **values** +* _[optional]_ SAFEARRAY(VARIANT) **which** + +**Return type**: void + + +### Function setVariableInputs + +![][public] + +``` +void TradeStudyPlugIn::ITradeStudy3JobManager::setVariableInputs(VARIANT which, SAFEARRAY(VARIANT) values, [optional] SAFEARRAY(long) runIndices) +``` + +Set all of the inputs for one variable. + +**Parameters**: + +* **which**: Which variable (index or name). +* **values**: The values to set. +* **runIndices**: The runs to set values for; if null/empty, assume all. + + + +**Parameters**: + +* VARIANT **which** +* SAFEARRAY(VARIANT) **values** +* _[optional]_ SAFEARRAY(long) **runIndices** + +**Return type**: void + + +### Function runJobAsync + +![][public] + +``` +ITradeStudy3JobResult * TradeStudyPlugIn::ITradeStudy3JobManager::runJobAsync() +``` + +Execute the job. + +**Returns**: + +The result of the job, which will be populated in real-time. + + + +**Return type**: [ITradeStudy3JobResult](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult) * + + +### Function getMetaDataProvider + +![][public] + +``` +IVariableMetaDataProvider * TradeStudyPlugIn::ITradeStudy3JobManager::getMetaDataProvider() +``` + +Get the metadata provider for this job manager. + + + + + +**Return type**: [IVariableMetaDataProvider](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider) * + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md index 941dc3f191..a6b2fc5f30 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md @@ -1,276 +1,275 @@ - -# Interface TradeStudyPlugIn::ITradeStudy3JobResult - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 240) - -Interface representing the results of running a job. May be backed internally by a PHXDataCollector, or not. - - - -## Members - -* [cancelAsync](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1aa5d136ea9f5d9dce819e2c6414f1febe) -* [dataHistory](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a5889d5d7712934aa30c0983452c875bb) -* [getVariableDisplayName](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a84850e887d89eb20d7793933316ad752) -* [getVariableEquation](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ad63d367bc060e84ccd0edc96747bd082) -* [isCanceled](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a2248d0fcfa9dbf3b0de48e5b75ff4df5) -* [isDesignVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ac933f79559b7a0cf45fe49a6cb1e77d0) -* [isInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a01b2afba0cae246a236a56555ffd3e05) -* [isRunning](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a56114078a1e476ce5e5ec70314f6fb73) -* [numRuns](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ae5299ad977b8ef2294350733bdff6912) -* [numVariables](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a3d8795dd3559fce3f610e63872b8808b) -* [waitForCompletion](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ad76c0b31771a31a827235d0306529ebc) - -## Properties - - -### Property numRuns - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 249) - -``` -TradeStudyPlugIn::ITradeStudy3JobResult::numRuns -``` - -Get the number of runs. - - - - - -**Return type**: - - -### Property numVariables - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 254) - -``` -TradeStudyPlugIn::ITradeStudy3JobResult::numVariables -``` - -Get the number of inputs. - - - - - -**Return type**: - - -### Property dataHistory - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 285) - -``` -TradeStudyPlugIn::ITradeStudy3JobResult::dataHistory -``` - -Get the data history associated with this job result, if any. - - - - - -**Return type**: - - -### Property isRunning - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 289) - -``` -TradeStudyPlugIn::ITradeStudy3JobResult::isRunning -``` - -Is the current job still running. - - - - - -**Return type**: - - -### Property isCanceled - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 293) - -``` -TradeStudyPlugIn::ITradeStudy3JobResult::isCanceled -``` - -Was the current job canceled? - - - - - -**Return type**: - -## Public functions - - -### Function getVariableEquation - -![][public] - -``` -BSTR TradeStudyPlugIn::ITradeStudy3JobResult::getVariableEquation(long index) -``` - -Get the equation for the variable at the specified index. - -**Parameters**: - -* **index**: The index. - - -**Returns**: - -The equation. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - - -### Function getVariableDisplayName - -![][public] - -``` -BSTR TradeStudyPlugIn::ITradeStudy3JobResult::getVariableDisplayName(long index) -``` - -Get the unique display name of a variable. - -**Parameters**: - -* **index**: The index. - - -**Returns**: - -The display name. - - - -**Parameters**: - -* long **index** - -**Return type**: BSTR - - -### Function isDesignVariable - -![][public] - -``` -boolean TradeStudyPlugIn::ITradeStudy3JobResult::isDesignVariable(VARIANT which) -``` - -Get the type associated with the specified variable. - -**Parameters**: - -* **which**: The name or index of the variable. - - -**Returns**: - -The variable type. - - - -**Parameters**: - -* VARIANT **which** - -**Return type**: boolean - - -### Function isInput - -![][public] - -``` -boolean TradeStudyPlugIn::ITradeStudy3JobResult::isInput(VARIANT which) -``` - -Get the type associated with the specified variable. - -**Parameters**: - -* **which**: The name or index of the variable. - - -**Returns**: - -The variable type. - - - -**Parameters**: - -* VARIANT **which** - -**Return type**: boolean - - -### Function cancelAsync - -![][public] - -``` -void TradeStudyPlugIn::ITradeStudy3JobResult::cancelAsync() -``` - -Halt the current job asynchronously. - - - - - -**Return type**: void - - -### Function waitForCompletion - -![][public] - -``` -void TradeStudyPlugIn::ITradeStudy3JobResult::waitForCompletion() -``` - -Wait for the trade study to finish. - -**Exceptions**: - -* **OperationCanceledException**: If the operation was halted. - - - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface TradeStudyPlugIn::ITradeStudy3JobResult + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 240) + +Interface representing the results of running a job. May be backed internally by a PHXDataCollector, or not. + + + +## Members + +* [cancelAsync](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1aa5d136ea9f5d9dce819e2c6414f1febe) +* [dataHistory](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a5889d5d7712934aa30c0983452c875bb) +* [getVariableDisplayName](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a84850e887d89eb20d7793933316ad752) +* [getVariableEquation](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ad63d367bc060e84ccd0edc96747bd082) +* [isCanceled](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a2248d0fcfa9dbf3b0de48e5b75ff4df5) +* [isDesignVariable](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ac933f79559b7a0cf45fe49a6cb1e77d0) +* [isInput](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a01b2afba0cae246a236a56555ffd3e05) +* [isRunning](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a56114078a1e476ce5e5ec70314f6fb73) +* [numRuns](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ae5299ad977b8ef2294350733bdff6912) +* [numVariables](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1a3d8795dd3559fce3f610e63872b8808b) +* [waitForCompletion](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult_1ad76c0b31771a31a827235d0306529ebc) + +## Properties + + +### Property numRuns + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 249) + +``` +TradeStudyPlugIn::ITradeStudy3JobResult::numRuns +``` + +Get the number of runs. + + + + + +**Return type**: + + +### Property numVariables + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 254) + +``` +TradeStudyPlugIn::ITradeStudy3JobResult::numVariables +``` + +Get the number of inputs. + + + + + +**Return type**: + + +### Property dataHistory + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 285) + +``` +TradeStudyPlugIn::ITradeStudy3JobResult::dataHistory +``` + +Get the data history associated with this job result, if any. + + + + + +**Return type**: + + +### Property isRunning + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 289) + +``` +TradeStudyPlugIn::ITradeStudy3JobResult::isRunning +``` + +Is the current job still running. + + + + + +**Return type**: + + +### Property isCanceled + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 293) + +``` +TradeStudyPlugIn::ITradeStudy3JobResult::isCanceled +``` + +Was the current job canceled? + + + + + +**Return type**: + +## Public functions + + +### Function getVariableEquation + +![][public] + +``` +BSTR TradeStudyPlugIn::ITradeStudy3JobResult::getVariableEquation(long index) +``` + +Get the equation for the variable at the specified index. + +**Parameters**: + +* **index**: The index. + + +**Returns**: + +The equation. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + + +### Function getVariableDisplayName + +![][public] + +``` +BSTR TradeStudyPlugIn::ITradeStudy3JobResult::getVariableDisplayName(long index) +``` + +Get the unique display name of a variable. + +**Parameters**: + +* **index**: The index. + + +**Returns**: + +The display name. + + + +**Parameters**: + +* long **index** + +**Return type**: BSTR + + +### Function isDesignVariable + +![][public] + +``` +boolean TradeStudyPlugIn::ITradeStudy3JobResult::isDesignVariable(VARIANT which) +``` + +Get the type associated with the specified variable. + +**Parameters**: + +* **which**: The name or index of the variable. + + +**Returns**: + +The variable type. + + + +**Parameters**: + +* VARIANT **which** + +**Return type**: boolean + + +### Function isInput + +![][public] + +``` +boolean TradeStudyPlugIn::ITradeStudy3JobResult::isInput(VARIANT which) +``` + +Get the type associated with the specified variable. + +**Parameters**: + +* **which**: The name or index of the variable. + + +**Returns**: + +The variable type. + + + +**Parameters**: + +* VARIANT **which** + +**Return type**: boolean + + +### Function cancelAsync + +![][public] + +``` +void TradeStudyPlugIn::ITradeStudy3JobResult::cancelAsync() +``` + +Halt the current job asynchronously. + + + + + +**Return type**: void + + +### Function waitForCompletion + +![][public] + +``` +void TradeStudyPlugIn::ITradeStudy3JobResult::waitForCompletion() +``` + +Wait for the trade study to finish. + +**Exceptions**: + +* **OperationCanceledException**: If the operation was halted. + + + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md index 156b82e91b..9aafbc1e1c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md @@ -1,163 +1,162 @@ - -# Interface TradeStudyPlugIn::ITradeStudyCallback - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 131) - - - -The Trade Study Callback connector is the piece that connects a Trade Study Plug-In (v2) back to the hosting Analyzer Tool, for the purpose of signaling when runs are about to begin and end, when a new Data Collector has been created, and when the Trade Study is closing. - -## Members - -* [dataCollectorCreated](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1a21e1253a708b1e6177c5998ad7583c59) -* [runEnded](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1af1ec5576a28a72b94eca35294a49dff1) -* [runStarting](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1a05d371f3256cbd0515c1786d4ca42b46) -* [tradeStudyClosed](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1a9434138abbfd489946e6657ce904dcac) - -## Public functions - - -### Function dataCollectorCreated - -![][public] - -``` -void TradeStudyPlugIn::ITradeStudyCallback::dataCollectorCreated(LPDISPATCH tradeStudy, LPDISPATCH dataCollector) -``` - - - -Called when the trade study creates a new data collector for it to use. - - - - - -The data collector should not be shown before being passed. - - - - - - -**Parameters**: - -* **tradeStudy**: the trade study associated with the data collector. -* **dataCollector**: the new data collector. - - - -**Parameters**: - -* LPDISPATCH **tradeStudy** -* LPDISPATCH **dataCollector** - -**Return type**: void - - -### Function runStarting - -![][public] - -``` -BOOL TradeStudyPlugIn::ITradeStudyCallback::runStarting(LPDISPATCH tradeStudy) -``` - - - -Called when the trade study is about to start running. - - - - - -If runStarting is called, then runEnded must also be called. Not doing so can result in a deadlock situation. If the trade study is closed before the run has completed, the run must be canceled and runEnded must be called. - - - - - - -**Parameters**: - -* **tradeStudy**: the trade study asking to run. - - -**Returns**: - -returns true if trade study is allowed to continue running; otherwise false. - - - -**Parameters**: - -* LPDISPATCH **tradeStudy** - -**Return type**: BOOL - - -### Function runEnded - -![][public] - -``` -void TradeStudyPlugIn::ITradeStudyCallback::runEnded(LPDISPATCH tradeStudy) -``` - - - -Called when the trade study has completed it's run. - - - - - - -**Parameters**: - -* **tradeStudy**: the trade study that has finished running. - - - -**Parameters**: - -* LPDISPATCH **tradeStudy** - -**Return type**: void - - -### Function tradeStudyClosed - -![][public] - -``` -void TradeStudyPlugIn::ITradeStudyCallback::tradeStudyClosed(LPDISPATCH tradeStudy) -``` - - - -Called to signal that the trade study has closed. - - - - - - -**Parameters**: - -* **tradeStudy**: the trade study that is closing. - - - -**Parameters**: - -* LPDISPATCH **tradeStudy** - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface TradeStudyPlugIn::ITradeStudyCallback + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 131) + + + +The Trade Study Callback connector is the piece that connects a Trade Study Plug-In (v2) back to the hosting Analyzer Tool, for the purpose of signaling when runs are about to begin and end, when a new Data Collector has been created, and when the Trade Study is closing. + +## Members + +* [dataCollectorCreated](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1a21e1253a708b1e6177c5998ad7583c59) +* [runEnded](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1af1ec5576a28a72b94eca35294a49dff1) +* [runStarting](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1a05d371f3256cbd0515c1786d4ca42b46) +* [tradeStudyClosed](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback_1a9434138abbfd489946e6657ce904dcac) + +## Public functions + + +### Function dataCollectorCreated + +![][public] + +``` +void TradeStudyPlugIn::ITradeStudyCallback::dataCollectorCreated(LPDISPATCH tradeStudy, LPDISPATCH dataCollector) +``` + + + +Called when the trade study creates a new data collector for it to use. + + + + + +The data collector should not be shown before being passed. + + + + + + +**Parameters**: + +* **tradeStudy**: the trade study associated with the data collector. +* **dataCollector**: the new data collector. + + + +**Parameters**: + +* LPDISPATCH **tradeStudy** +* LPDISPATCH **dataCollector** + +**Return type**: void + + +### Function runStarting + +![][public] + +``` +BOOL TradeStudyPlugIn::ITradeStudyCallback::runStarting(LPDISPATCH tradeStudy) +``` + + + +Called when the trade study is about to start running. + + + + + +If runStarting is called, then runEnded must also be called. Not doing so can result in a deadlock situation. If the trade study is closed before the run has completed, the run must be canceled and runEnded must be called. + + + + + + +**Parameters**: + +* **tradeStudy**: the trade study asking to run. + + +**Returns**: + +returns true if trade study is allowed to continue running; otherwise false. + + + +**Parameters**: + +* LPDISPATCH **tradeStudy** + +**Return type**: BOOL + + +### Function runEnded + +![][public] + +``` +void TradeStudyPlugIn::ITradeStudyCallback::runEnded(LPDISPATCH tradeStudy) +``` + + + +Called when the trade study has completed it's run. + + + + + + +**Parameters**: + +* **tradeStudy**: the trade study that has finished running. + + + +**Parameters**: + +* LPDISPATCH **tradeStudy** + +**Return type**: void + + +### Function tradeStudyClosed + +![][public] + +``` +void TradeStudyPlugIn::ITradeStudyCallback::tradeStudyClosed(LPDISPATCH tradeStudy) +``` + + + +Called to signal that the trade study has closed. + + + + + + +**Parameters**: + +* **tradeStudy**: the trade study that is closing. + + + +**Parameters**: + +* LPDISPATCH **tradeStudy** + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md index de0b0465b5..e9952733e4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md @@ -1,123 +1,122 @@ - -# Interface TradeStudyPlugIn::ITradeStudyPlugIn - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 15) - - - - - -**Inherited by**: - -* [TradeStudyPlugIn::ICombinedPlugIn](interfaceTradeStudyPlugIn_1_1ICombinedPlugIn.md#interfaceTradeStudyPlugIn_1_1ICombinedPlugIn) -* [TradeStudyPlugIn::ITradeStudyPlugIn2](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2) - -## Members - -* [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a2b883bd3725cefb35daf8b629124a57f) -* [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a8c4352f776b3919a9a56aa61ff78c5d0) -* [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a7238385b054e9afddbe65c65644826e4) -* [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a58cdb46e4e8dca27761d7bd976c8fcf2) - -## Public functions - - -### Function construct - -![][public] - -``` -void TradeStudyPlugIn::ITradeStudyPlugIn::construct(IDispatch *modelCenter, IDispatch *addToModel, [defaultvalue(NULL)]IDispatch *dataCollector) -``` - - - - - - - -**Parameters**: - -* IDispatch * **modelCenter** -* IDispatch * **addToModel** -* _[defaultvalue(NULL)]_ IDispatch * **dataCollector** - -**Return type**: void - -**Reimplemented by**: - -* [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ad233e5489d31c81b6b1fe09d9a3a886e) - - -### Function show - -![][public] - -``` -boolean TradeStudyPlugIn::ITradeStudyPlugIn::show() -``` - - - - - - - -**Return type**: boolean - -**Reimplemented by**: - -* [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a81aebef74679c6364f184219c22da93a) - - -### Function toString - -![][public] - -``` -BSTR TradeStudyPlugIn::ITradeStudyPlugIn::toString() -``` - - - - - - - -**Return type**: BSTR - -**Reimplemented by**: - -* [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1aaff0d58b0b3d2d90566fae1277ea4a45) - - -### Function fromString - -![][public] - -``` -void TradeStudyPlugIn::ITradeStudyPlugIn::fromString(BSTR setupString) -``` - - - - - - - -**Parameters**: - -* BSTR **setupString** - -**Return type**: void - -**Reimplemented by**: - -* [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a3dd50d2ce70b8e0534dd9be60e9bec5c) - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface TradeStudyPlugIn::ITradeStudyPlugIn + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 15) + + + + + +**Inherited by**: + +* [TradeStudyPlugIn::ICombinedPlugIn](interfaceTradeStudyPlugIn_1_1ICombinedPlugIn.md#interfaceTradeStudyPlugIn_1_1ICombinedPlugIn) +* [TradeStudyPlugIn::ITradeStudyPlugIn2](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2) + +## Members + +* [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a2b883bd3725cefb35daf8b629124a57f) +* [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a8c4352f776b3919a9a56aa61ff78c5d0) +* [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a7238385b054e9afddbe65c65644826e4) +* [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a58cdb46e4e8dca27761d7bd976c8fcf2) + +## Public functions + + +### Function construct + +![][public] + +``` +void TradeStudyPlugIn::ITradeStudyPlugIn::construct(IDispatch *modelCenter, IDispatch *addToModel, [defaultvalue(NULL)]IDispatch *dataCollector) +``` + + + + + + + +**Parameters**: + +* IDispatch * **modelCenter** +* IDispatch * **addToModel** +* _[defaultvalue(NULL)]_ IDispatch * **dataCollector** + +**Return type**: void + +**Reimplemented by**: + +* [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ad233e5489d31c81b6b1fe09d9a3a886e) + + +### Function show + +![][public] + +``` +boolean TradeStudyPlugIn::ITradeStudyPlugIn::show() +``` + + + + + + + +**Return type**: boolean + +**Reimplemented by**: + +* [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a81aebef74679c6364f184219c22da93a) + + +### Function toString + +![][public] + +``` +BSTR TradeStudyPlugIn::ITradeStudyPlugIn::toString() +``` + + + + + + + +**Return type**: BSTR + +**Reimplemented by**: + +* [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1aaff0d58b0b3d2d90566fae1277ea4a45) + + +### Function fromString + +![][public] + +``` +void TradeStudyPlugIn::ITradeStudyPlugIn::fromString(BSTR setupString) +``` + + + + + + + +**Parameters**: + +* BSTR **setupString** + +**Return type**: void + +**Reimplemented by**: + +* [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a3dd50d2ce70b8e0534dd9be60e9bec5c) + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md index 93b8263942..c3633c305f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md @@ -1,272 +1,271 @@ - -# Interface TradeStudyPlugIn::ITradeStudyPlugIn2 - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 41) - - - -COM Instance. - -**Inherits from**: - -* [TradeStudyPlugIn::ITradeStudyPlugIn](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn) - -**Inherited by**: - -* [TradeStudyPlugIn::ITradeStudyPlugIn3](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3) - -## Members - -* [addAnalyzerVariable](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a614a39c2d8dd38f47d840aa6d5bb34f2) -* [clearAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ae184db6af8802c77918103c4bf0f0564) -* [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ad233e5489d31c81b6b1fe09d9a3a886e) -* [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a3dd50d2ce70b8e0534dd9be60e9bec5c) -* [onEnd](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a955659c71fd798c3d2be2d98a277e28d) -* [saveAllAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1afeb8dd96abface7ec4a37de262c88c85) -* [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a81aebef74679c6364f184219c22da93a) -* [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1aaff0d58b0b3d2d90566fae1277ea4a45) -* [TradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ad9db0e1ec3dee4b67da4fd2bd197f497) - -## Properties - - -### Property TradeStudyCallback - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 1) - -``` -LPDISPATCH TradeStudyPlugIn::ITradeStudyPlugIn2::TradeStudyCallback -``` - - - -Gets or sets the trade study callback object. - - - -**Return type**: LPDISPATCH - - -### Property saveAllAnalyzerVariables - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 1) - -``` -boolean TradeStudyPlugIn::ITradeStudyPlugIn2::saveAllAnalyzerVariables -``` - - - -Gets or sets whether all analyzer variables are saved in the data history when the trade study is run. Only affects variables added using [addAnalyzerVariable()](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a614a39c2d8dd38f47d840aa6d5bb34f2), otherwise the global [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) setting is used (as per usual). The default is false. - - - - - -NOTE: not fully supported in MC 10.2 - you can (and should) set this value as appropriate but setting to true may not have an effect until all of the requisite functionality is added. - - - -**Return type**: boolean - -## Public functions - - -### Function construct - -![][public] - -``` -void TradeStudyPlugIn::ITradeStudyPlugIn2::construct(IDispatch *modelCenter, IDispatch *addToModel, [defaultvalue(NULL)]IDispatch *dataCollector) -``` - - - -Called when the plug-in is launched from [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) - - - - - - -**Parameters**: - -* **modelCenter**: the [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) object -* **addToModel**: the AddToModel API object - - - -**Parameters**: - -* IDispatch * **modelCenter** -* IDispatch * **addToModel** -* _[defaultvalue(NULL)]_ IDispatch * **dataCollector** - -**Return type**: void - -**Reimplements**: [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a2b883bd3725cefb35daf8b629124a57f) - - -### Function show - -![][public] - -``` -boolean TradeStudyPlugIn::ITradeStudyPlugIn2::show() -``` - - - -Called to display the trade study. - - - - - - -**Returns**: - -false always - - - -**Return type**: boolean - -**Reimplements**: [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a7238385b054e9afddbe65c65644826e4) - - -### Function toString - -![][public] - -``` -BSTR TradeStudyPlugIn::ITradeStudyPlugIn2::toString() -``` - - - -Called to save the state of the plug-in. - - - - - - -**Returns**: - -a string containing state information - - - -**Return type**: BSTR - -**Reimplements**: [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a58cdb46e4e8dca27761d7bd976c8fcf2) - - -### Function fromString - -![][public] - -``` -void TradeStudyPlugIn::ITradeStudyPlugIn2::fromString(BSTR setupString) -``` - - - -Called to restore the state of a plug-in - - - - - - -**Parameters**: - -* **setupString**: the state string - - - -**Parameters**: - -* BSTR **setupString** - -**Return type**: void - -**Reimplements**: [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a8c4352f776b3919a9a56aa61ff78c5d0) - - -### Function onEnd - -![][public] - -``` -void TradeStudyPlugIn::ITradeStudyPlugIn2::onEnd() -``` - - - -Called when the plug-in is about to be deleted. Informs the plug-in to do any necessary clean up. - - - -**Return type**: void - - -### Function addAnalyzerVariable - -![][public] - -``` -void TradeStudyPlugIn::ITradeStudyPlugIn2::addAnalyzerVariable(BSTR formula, [optional]VARIANT analyzerName) -``` - - - -Call to add a variable from an analyzer product. If there are any analyzer variables, the plugin should only accept analyzer variables as trade study parameters. - - - - - - -**Parameters**: - -* **formula**: the formula of the variable or expression in the [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) model -* **analyzerName**: the name of the variable used by the analyzer product; if not specified, the formula is used instead. The plugin should only display and accept aliases. - - - -**Parameters**: - -* BSTR **formula** -* _[optional]_ VARIANT **analyzerName** - -**Return type**: void - - -### Function clearAnalyzerVariables - -![][public] - -``` -void TradeStudyPlugIn::ITradeStudyPlugIn2::clearAnalyzerVariables() -``` - - - -Remove all analyzer variables. - - - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface TradeStudyPlugIn::ITradeStudyPlugIn2 + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 41) + + + +COM Instance. + +**Inherits from**: + +* [TradeStudyPlugIn::ITradeStudyPlugIn](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn) + +**Inherited by**: + +* [TradeStudyPlugIn::ITradeStudyPlugIn3](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3) + +## Members + +* [addAnalyzerVariable](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a614a39c2d8dd38f47d840aa6d5bb34f2) +* [clearAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ae184db6af8802c77918103c4bf0f0564) +* [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ad233e5489d31c81b6b1fe09d9a3a886e) +* [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a3dd50d2ce70b8e0534dd9be60e9bec5c) +* [onEnd](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a955659c71fd798c3d2be2d98a277e28d) +* [saveAllAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1afeb8dd96abface7ec4a37de262c88c85) +* [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a81aebef74679c6364f184219c22da93a) +* [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1aaff0d58b0b3d2d90566fae1277ea4a45) +* [TradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ad9db0e1ec3dee4b67da4fd2bd197f497) + +## Properties + + +### Property TradeStudyCallback + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 1) + +``` +LPDISPATCH TradeStudyPlugIn::ITradeStudyPlugIn2::TradeStudyCallback +``` + + + +Gets or sets the trade study callback object. + + + +**Return type**: LPDISPATCH + + +### Property saveAllAnalyzerVariables + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 1) + +``` +boolean TradeStudyPlugIn::ITradeStudyPlugIn2::saveAllAnalyzerVariables +``` + + + +Gets or sets whether all analyzer variables are saved in the data history when the trade study is run. Only affects variables added using [addAnalyzerVariable()](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a614a39c2d8dd38f47d840aa6d5bb34f2), otherwise the global [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) setting is used (as per usual). The default is false. + + + + + +NOTE: not fully supported in MC 10.2 - you can (and should) set this value as appropriate but setting to true may not have an effect until all of the requisite functionality is added. + + + +**Return type**: boolean + +## Public functions + + +### Function construct + +![][public] + +``` +void TradeStudyPlugIn::ITradeStudyPlugIn2::construct(IDispatch *modelCenter, IDispatch *addToModel, [defaultvalue(NULL)]IDispatch *dataCollector) +``` + + + +Called when the plug-in is launched from [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) + + + + + + +**Parameters**: + +* **modelCenter**: the [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) object +* **addToModel**: the AddToModel API object + + + +**Parameters**: + +* IDispatch * **modelCenter** +* IDispatch * **addToModel** +* _[defaultvalue(NULL)]_ IDispatch * **dataCollector** + +**Return type**: void + +**Reimplements**: [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a2b883bd3725cefb35daf8b629124a57f) + + +### Function show + +![][public] + +``` +boolean TradeStudyPlugIn::ITradeStudyPlugIn2::show() +``` + + + +Called to display the trade study. + + + + + + +**Returns**: + +false always + + + +**Return type**: boolean + +**Reimplements**: [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a7238385b054e9afddbe65c65644826e4) + + +### Function toString + +![][public] + +``` +BSTR TradeStudyPlugIn::ITradeStudyPlugIn2::toString() +``` + + + +Called to save the state of the plug-in. + + + + + + +**Returns**: + +a string containing state information + + + +**Return type**: BSTR + +**Reimplements**: [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a58cdb46e4e8dca27761d7bd976c8fcf2) + + +### Function fromString + +![][public] + +``` +void TradeStudyPlugIn::ITradeStudyPlugIn2::fromString(BSTR setupString) +``` + + + +Called to restore the state of a plug-in + + + + + + +**Parameters**: + +* **setupString**: the state string + + + +**Parameters**: + +* BSTR **setupString** + +**Return type**: void + +**Reimplements**: [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn_1a8c4352f776b3919a9a56aa61ff78c5d0) + + +### Function onEnd + +![][public] + +``` +void TradeStudyPlugIn::ITradeStudyPlugIn2::onEnd() +``` + + + +Called when the plug-in is about to be deleted. Informs the plug-in to do any necessary clean up. + + + +**Return type**: void + + +### Function addAnalyzerVariable + +![][public] + +``` +void TradeStudyPlugIn::ITradeStudyPlugIn2::addAnalyzerVariable(BSTR formula, [optional]VARIANT analyzerName) +``` + + + +Call to add a variable from an analyzer product. If there are any analyzer variables, the plugin should only accept analyzer variables as trade study parameters. + + + + + + +**Parameters**: + +* **formula**: the formula of the variable or expression in the [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) model +* **analyzerName**: the name of the variable used by the analyzer product; if not specified, the formula is used instead. The plugin should only display and accept aliases. + + + +**Parameters**: + +* BSTR **formula** +* _[optional]_ VARIANT **analyzerName** + +**Return type**: void + + +### Function clearAnalyzerVariables + +![][public] + +``` +void TradeStudyPlugIn::ITradeStudyPlugIn2::clearAnalyzerVariables() +``` + + + +Remove all analyzer variables. + + + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md index c14405257c..5bd5e76c95 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md @@ -1,250 +1,249 @@ - -# Interface TradeStudyPlugIn::ITradeStudyPlugIn3 - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 479) - - - -COM Instance. - -**Inherits from**: - -* [TradeStudyPlugIn::ITradeStudyPlugIn2](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2) - -## Members - -* [addAnalyzerVariable](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a9e044579568a49b3f42c8771ccf8bbc3) -* [addAnalyzerVariable](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a614a39c2d8dd38f47d840aa6d5bb34f2) -* [clearAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a1a94e6d8431bf19dee3fcf446e781070) -* [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ad233e5489d31c81b6b1fe09d9a3a886e) -* [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a541ccb54affa550f0ea2694b39e16c7c) -* [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a3dd50d2ce70b8e0534dd9be60e9bec5c) -* [id](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a2c98e62414b0d01303d7a009449f0871) -* [onEnd](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1afa9a6faf24f730938ea94ba9e846a381) -* [saveAllAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a98649448b98aa71aef4adc1e33c47570) -* [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1ac84a2866cfcedd306eeabd757d8c0877) -* [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a3f6d767abcf9b50ee14ac7be20ef964a) -* [TradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a781692e887426951e2913672d9f94a78) - -## Properties - - -### Property TradeStudyCallback - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 1) - -``` -LPDISPATCH TradeStudyPlugIn::ITradeStudyPlugIn3::TradeStudyCallback -``` - - - -Gets or sets the trade study callback object. - - - -**Return type**: LPDISPATCH - - -### Property saveAllAnalyzerVariables - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 1) - -``` -boolean TradeStudyPlugIn::ITradeStudyPlugIn3::saveAllAnalyzerVariables -``` - - - -Gets or sets whether all analyzer variables are saved in the data history when the trade study is run. Only affects variables added using [addAnalyzerVariable()](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a9e044579568a49b3f42c8771ccf8bbc3), otherwise the global [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) setting is used (as per usual). The default is false. - - - - - -NOTE: not fully supported in MC 10.2 - you can (and should) set this value as appropriate but setting to true may not have an effect until all of the requisite functionality is added. - - - -**Return type**: boolean - - -### Property id - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 515) - -``` -IDispatch TradeStudyPlugIn::ITradeStudyPlugIn3::id( IDispatch modelCenter, IDispatch addToModel)(IDispatch modelCenter, IDispatch addToModel) -``` - - - -Gets or sets the job manager to use. - - - -**Return type**: IDispatch - - -### Property show - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 522) - -``` -boolean TradeStudyPlugIn::ITradeStudyPlugIn3::show -``` - - - -Called to display the trade study. - - - - - - -**Returns**: - -false always - - - -**Return type**: boolean - - -### Property toString - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 529) - -``` -BSTR TradeStudyPlugIn::ITradeStudyPlugIn3::toString -``` - - - -Called to save the state of the plug-in. - - - - - - -**Returns**: - -a string containing state information - - - -**Return type**: BSTR - - -### Property fromString - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 536) - -``` -BSTR TradeStudyPlugIn::ITradeStudyPlugIn3::fromString -``` - - - -Called to restore the state of a plug-in - - - - - - -**Parameters**: - -* **setupString**: the state string - - - -**Return type**: BSTR - - -### Property onEnd - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 542) - -``` -void TradeStudyPlugIn::ITradeStudyPlugIn3::onEnd -``` - - - -Called when the plug-in is about to be deleted. Informs the plug-in to do any necessary clean up. - - - -**Return type**: void - - -### Property addAnalyzerVariable - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 555) - -``` -VARIANT TradeStudyPlugIn::ITradeStudyPlugIn3::addAnalyzerVariable( BSTR formula)(BSTR formula) -``` - - - -Call to add a variable from an analyzer product. If there are any analyzer variables, the plugin should only accept analyzer variables as trade study parameters. - - - - - - -**Parameters**: - -* **formula**: the formula of the variable or expression in the [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) model -* **analyzerName**: the name of the variable used by the analyzer product; if not specified, the formula is used instead. The plugin should only display and accept aliases. - - - -**Return type**: VARIANT - - -### Property clearAnalyzerVariables - -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 560) - -``` -void TradeStudyPlugIn::ITradeStudyPlugIn3::clearAnalyzerVariables -``` - - - -Remove all analyzer variables. - - - -**Return type**: void - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface TradeStudyPlugIn::ITradeStudyPlugIn3 + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 479) + + + +COM Instance. + +**Inherits from**: + +* [TradeStudyPlugIn::ITradeStudyPlugIn2](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2) + +## Members + +* [addAnalyzerVariable](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a9e044579568a49b3f42c8771ccf8bbc3) +* [addAnalyzerVariable](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a614a39c2d8dd38f47d840aa6d5bb34f2) +* [clearAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a1a94e6d8431bf19dee3fcf446e781070) +* [construct](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1ad233e5489d31c81b6b1fe09d9a3a886e) +* [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a541ccb54affa550f0ea2694b39e16c7c) +* [fromString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2_1a3dd50d2ce70b8e0534dd9be60e9bec5c) +* [id](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a2c98e62414b0d01303d7a009449f0871) +* [onEnd](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1afa9a6faf24f730938ea94ba9e846a381) +* [saveAllAnalyzerVariables](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a98649448b98aa71aef4adc1e33c47570) +* [show](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1ac84a2866cfcedd306eeabd757d8c0877) +* [toString](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a3f6d767abcf9b50ee14ac7be20ef964a) +* [TradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a781692e887426951e2913672d9f94a78) + +## Properties + + +### Property TradeStudyCallback + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 1) + +``` +LPDISPATCH TradeStudyPlugIn::ITradeStudyPlugIn3::TradeStudyCallback +``` + + + +Gets or sets the trade study callback object. + + + +**Return type**: LPDISPATCH + + +### Property saveAllAnalyzerVariables + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 1) + +``` +boolean TradeStudyPlugIn::ITradeStudyPlugIn3::saveAllAnalyzerVariables +``` + + + +Gets or sets whether all analyzer variables are saved in the data history when the trade study is run. Only affects variables added using [addAnalyzerVariable()](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3_1a9e044579568a49b3f42c8771ccf8bbc3), otherwise the global [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) setting is used (as per usual). The default is false. + + + + + +NOTE: not fully supported in MC 10.2 - you can (and should) set this value as appropriate but setting to true may not have an effect until all of the requisite functionality is added. + + + +**Return type**: boolean + + +### Property id + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 515) + +``` +IDispatch TradeStudyPlugIn::ITradeStudyPlugIn3::id( IDispatch modelCenter, IDispatch addToModel)(IDispatch modelCenter, IDispatch addToModel) +``` + + + +Gets or sets the job manager to use. + + + +**Return type**: IDispatch + + +### Property show + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 522) + +``` +boolean TradeStudyPlugIn::ITradeStudyPlugIn3::show +``` + + + +Called to display the trade study. + + + + + + +**Returns**: + +false always + + + +**Return type**: boolean + + +### Property toString + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 529) + +``` +BSTR TradeStudyPlugIn::ITradeStudyPlugIn3::toString +``` + + + +Called to save the state of the plug-in. + + + + + + +**Returns**: + +a string containing state information + + + +**Return type**: BSTR + + +### Property fromString + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 536) + +``` +BSTR TradeStudyPlugIn::ITradeStudyPlugIn3::fromString +``` + + + +Called to restore the state of a plug-in + + + + + + +**Parameters**: + +* **setupString**: the state string + + + +**Return type**: BSTR + + +### Property onEnd + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 542) + +``` +void TradeStudyPlugIn::ITradeStudyPlugIn3::onEnd +``` + + + +Called when the plug-in is about to be deleted. Informs the plug-in to do any necessary clean up. + + + +**Return type**: void + + +### Property addAnalyzerVariable + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 555) + +``` +VARIANT TradeStudyPlugIn::ITradeStudyPlugIn3::addAnalyzerVariable( BSTR formula)(BSTR formula) +``` + + + +Call to add a variable from an analyzer product. If there are any analyzer variables, the plugin should only accept analyzer variables as trade study parameters. + + + + + + +**Parameters**: + +* **formula**: the formula of the variable or expression in the [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) model +* **analyzerName**: the name of the variable used by the analyzer product; if not specified, the formula is used instead. The plugin should only display and accept aliases. + + + +**Return type**: VARIANT + + +### Property clearAnalyzerVariables + +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 560) + +``` +void TradeStudyPlugIn::ITradeStudyPlugIn3::clearAnalyzerVariables +``` + + + +Remove all analyzer variables. + + + +**Return type**: void + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md index 7f9a04c81e..bd2f140a59 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md @@ -1,80 +1,79 @@ - -# Interface TradeStudyPlugIn::IVariableMetaDataProvider - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 311) - - - -Class which provides variable metadata. Since a job manager is not always backed by a model anymore, we can't rely on IModelCenter::getVariable(). - -## Members - -* [getVariableMetaData](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider_1ab17303c17efd43f87d95991b2245bc72) -* [SAFEARRAY](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider_1aa2d00c56cf6df0f49ed49a864e281f45) - -## Public functions - - -### Function getVariableMetaData - -![][public] - -``` -LPDISPATCH TradeStudyPlugIn::IVariableMetaDataProvider::getVariableMetaData(BSTR fullName) -``` - - - -Get the metadata for a variable. Throws an exception if not found. -**Parameters**: - -* **fullName**: the full name of the variable - - -**Returns**: - -the metadata object (IDHVariable, from DataHistory plugin) - - - -**Parameters**: - -* BSTR **fullName** - -**Return type**: LPDISPATCH - - -### Function SAFEARRAY - -![][public] - -``` -TradeStudyPlugIn::IVariableMetaDataProvider::SAFEARRAY(IDispatch *) getAllVariableMetaData(BSTR path) -``` - - - -Get the metadata for all variables identified by the specified path. -**Parameters**: - -* **path**: the path - - -**Returns**: - -the list of variables (as IDHVariable objects, from DataHistory plugin) - - - -**Parameters**: - -* IDispatch * - -**Return type**: - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface TradeStudyPlugIn::IVariableMetaDataProvider + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 311) + + + +Class which provides variable metadata. Since a job manager is not always backed by a model anymore, we can't rely on IModelCenter::getVariable(). + +## Members + +* [getVariableMetaData](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider_1ab17303c17efd43f87d95991b2245bc72) +* [SAFEARRAY](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider_1aa2d00c56cf6df0f49ed49a864e281f45) + +## Public functions + + +### Function getVariableMetaData + +![][public] + +``` +LPDISPATCH TradeStudyPlugIn::IVariableMetaDataProvider::getVariableMetaData(BSTR fullName) +``` + + + +Get the metadata for a variable. Throws an exception if not found. +**Parameters**: + +* **fullName**: the full name of the variable + + +**Returns**: + +the metadata object (IDHVariable, from DataHistory plugin) + + + +**Parameters**: + +* BSTR **fullName** + +**Return type**: LPDISPATCH + + +### Function SAFEARRAY + +![][public] + +``` +TradeStudyPlugIn::IVariableMetaDataProvider::SAFEARRAY(IDispatch *) getAllVariableMetaData(BSTR path) +``` + + + +Get the metadata for all variables identified by the specified path. +**Parameters**: + +* **path**: the path + + +**Returns**: + +the list of variables (as IDHVariable objects, from DataHistory plugin) + + + +**Parameters**: + +* IDispatch * + +**Return type**: + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1IWindowed.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1IWindowed.md index 8d75b97212..5e514f4ada 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1IWindowed.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interfaceTradeStudyPlugIn_1_1IWindowed.md @@ -1,41 +1,40 @@ - -# Interface TradeStudyPlugIn::IWindowed - -![][IDL] -![][public] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 566) - - - - - -## Members - -* [closeWindow](interfaceTradeStudyPlugIn_1_1IWindowed.md#interfaceTradeStudyPlugIn_1_1IWindowed_1af9dab02ffb5223028fae48563bbab27b) - -## Public functions - - -### Function closeWindow - -![][public] - -``` -boolean TradeStudyPlugIn::IWindowed::closeWindow() -``` - - - -Close this trade study plug-in's window. -**Returns**: - -true if the user allowed the window to close. - - - -**Return type**: boolean - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Interface TradeStudyPlugIn::IWindowed + +![][IDL] +![][public] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 566) + + + + + +## Members + +* [closeWindow](interfaceTradeStudyPlugIn_1_1IWindowed.md#interfaceTradeStudyPlugIn_1_1IWindowed_1af9dab02ffb5223028fae48563bbab27b) + +## Public functions + + +### Function closeWindow + +![][public] + +``` +boolean TradeStudyPlugIn::IWindowed::closeWindow() +``` + + + +Close this trade study plug-in's window. +**Returns**: + +true if the user allowed the window to close. + + + +**Return type**: boolean + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interface_contents.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interface_contents.md index c6ccf22038..0bdfa47c65 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interface_contents.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interface_contents.md @@ -1,76 +1,76 @@ -# Interfaces - -* [PHXDATAEXPLORERLib::\_DPHXDataExplorer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer) -* [PHXDATAEXPLORERLib::\_DPHXDataExplorerEvents](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents) -* [PHXDATAHISTORYLib::\_DPHXDataHistory](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory) -* [PHXDATAHISTORYLib::\_DPHXDataHistoryEvents](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents) -* [PHXDATAHISTORYLib::\_DPHXDataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel) -* [ModelCenter::IAddToModel](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel) -* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) -* [ModelCenter::IAssemblies](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies) -* [ModelCenter::IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) -* [ModelCenter::IBooleanArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray) -* [ModelCenter::IBooleanVariable](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable) -* [ModelCenter::ICachePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin) -* [TradeStudyPlugIn::ICombinedPlugIn](interfaceTradeStudyPlugIn_1_1ICombinedPlugIn.md#interfaceTradeStudyPlugIn_1_1ICombinedPlugIn) -* [ModelCenter::IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) -* [ComponentPlugIn::IComponentPlugIn](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn) -* [ModelCenter::IComponents](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents) -* [ModelCenter::ICustomDesignPoint](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint) -* [ModelCenter::IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) -* [PHXDATAEXPLORERLib::IDataExplorerFacadeOwner](interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner.md#interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner) -* [ModelCenter::IDataMonitor](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor) -* [PHXDATAHISTORYLib::IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) -* [ModelCenter::IDoubleArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray) -* [ModelCenter::IDoubleVariable](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable) -* [ModelCenter::IFeature](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature) -* [ModelCenter::IFileArray](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray) -* [ModelCenter::IFileSystemInfo](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo) -* [ModelCenter::IFileVariable](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable) -* [ModelCenter::IGeometryVariable](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable) -* [ModelCenter::IGlobalParameters](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters) -* [ModelCenter::IGroup](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup) -* [ModelCenter::IGroups](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups) -* [ModelCenter::IIfComponent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent) -* [ModelCenter::IIntegerArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray) -* [ModelCenter::IIntegerVariable](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable) -* [ModelCenter::IJobManager](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager) -* [PHXDATAEXPLORERLib::ILegacyVisiblity](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity) -* [ModelCenter::ILogger](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger) -* [ModelCenter::ILoginCallback](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback) -* [ModelCenter::IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) -* [ModelCenter::INetworkLocations](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations) -* [ModelCenter::IObjectVariable](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable) -* [PHXDATAEXPLORERLib::IPageVisibility](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility) -* [PHXDATAEXPLORERLib::IPHXDataExplorerPointer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer) -* [PHXDATAEXPLORERLib::IPHXDEKeepalive](interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive.md#interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive) -* [ModelCenter::IPHXFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat) -* [PHXDATAHISTORYLib::IPHXMenuItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems) -* [PlugInMetaData::IPlugInMetaData](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData) -* [ModelCenter::IRefArrayProp](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp) -* [ModelCenter::IReferenceArray](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray) -* [ModelCenter::IReferenceVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable) -* [ModelCenter::IRefProp](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp) -* [PHXDATAHISTORYLib::ISaveContext](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext) -* [ModelCenter::IScriptComponent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent) -* [ModelCenter::IShowHelpEvents](interfaceModelCenter_1_1IShowHelpEvents.md#interfaceModelCenter_1_1IShowHelpEvents) -* [ModelCenter::IStringArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray) -* [ModelCenter::IStringVariable](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable) -* [TradeStudyPlugIn::ITradeStudy3JobInfo](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo) -* [TradeStudyPlugIn::ITradeStudy3JobManager](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager): Class which does everything that a combination of a DataHistory and a JobManager can do. Can be implemented using the inputs to a normal construct(...) call, but can do something else entirely. Thread-safe. -* [TradeStudyPlugIn::ITradeStudy3JobResult](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult): Interface representing the results of running a job. May be backed internally by a PHXDataCollector, or not. -* [TradeStudyPlugIn::ITradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback) -* [ModelCenter::ITradeStudyEvents](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents) -* [TradeStudyPlugIn::ITradeStudyPlugIn](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn) -* [TradeStudyPlugIn::ITradeStudyPlugIn2](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2) -* [TradeStudyPlugIn::ITradeStudyPlugIn3](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3) -* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) -* [ModelCenter::IVariableDescription](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription) -* [ModelCenter::IVariableLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink) -* [ModelCenter::IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) -* [TradeStudyPlugIn::IVariableMetaDataProvider](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider) -* [ModelCenter::IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) -* [ModelCenter::IVizContainer](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer) -* [TradeStudyPlugIn::IWindowed](interfaceTradeStudyPlugIn_1_1IWindowed.md#interfaceTradeStudyPlugIn_1_1IWindowed) -* [PHXDATAHISTORYLib::PHXDataExplorerExportPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn) +# Interfaces + +* [PHXDATAEXPLORERLib::\_DPHXDataExplorer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer) +* [PHXDATAEXPLORERLib::\_DPHXDataExplorerEvents](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents) +* [PHXDATAHISTORYLib::\_DPHXDataHistory](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory) +* [PHXDATAHISTORYLib::\_DPHXDataHistoryEvents](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents) +* [PHXDATAHISTORYLib::\_DPHXDataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel) +* [ModelCenter::IAddToModel](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel) +* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) +* [ModelCenter::IAssemblies](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies) +* [ModelCenter::IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) +* [ModelCenter::IBooleanArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray) +* [ModelCenter::IBooleanVariable](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable) +* [ModelCenter::ICachePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin) +* [TradeStudyPlugIn::ICombinedPlugIn](interfaceTradeStudyPlugIn_1_1ICombinedPlugIn.md#interfaceTradeStudyPlugIn_1_1ICombinedPlugIn) +* [ModelCenter::IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) +* [ComponentPlugIn::IComponentPlugIn](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn) +* [ModelCenter::IComponents](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents) +* [ModelCenter::ICustomDesignPoint](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint) +* [ModelCenter::IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) +* [PHXDATAEXPLORERLib::IDataExplorerFacadeOwner](interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner.md#interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner) +* [ModelCenter::IDataMonitor](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor) +* [PHXDATAHISTORYLib::IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) +* [ModelCenter::IDoubleArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray) +* [ModelCenter::IDoubleVariable](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable) +* [ModelCenter::IFeature](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature) +* [ModelCenter::IFileArray](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray) +* [ModelCenter::IFileSystemInfo](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo) +* [ModelCenter::IFileVariable](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable) +* [ModelCenter::IGeometryVariable](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable) +* [ModelCenter::IGlobalParameters](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters) +* [ModelCenter::IGroup](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup) +* [ModelCenter::IGroups](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups) +* [ModelCenter::IIfComponent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent) +* [ModelCenter::IIntegerArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray) +* [ModelCenter::IIntegerVariable](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable) +* [ModelCenter::IJobManager](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager) +* [PHXDATAEXPLORERLib::ILegacyVisiblity](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity) +* [ModelCenter::ILogger](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger) +* [ModelCenter::ILoginCallback](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback) +* [ModelCenter::IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) +* [ModelCenter::INetworkLocations](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations) +* [ModelCenter::IObjectVariable](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable) +* [PHXDATAEXPLORERLib::IPageVisibility](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility) +* [PHXDATAEXPLORERLib::IPHXDataExplorerPointer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer) +* [PHXDATAEXPLORERLib::IPHXDEKeepalive](interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive.md#interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive) +* [ModelCenter::IPHXFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat) +* [PHXDATAHISTORYLib::IPHXMenuItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems) +* [PlugInMetaData::IPlugInMetaData](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData) +* [ModelCenter::IRefArrayProp](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp) +* [ModelCenter::IReferenceArray](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray) +* [ModelCenter::IReferenceVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable) +* [ModelCenter::IRefProp](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp) +* [PHXDATAHISTORYLib::ISaveContext](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext) +* [ModelCenter::IScriptComponent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent) +* [ModelCenter::IShowHelpEvents](interfaceModelCenter_1_1IShowHelpEvents.md#interfaceModelCenter_1_1IShowHelpEvents) +* [ModelCenter::IStringArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray) +* [ModelCenter::IStringVariable](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable) +* [TradeStudyPlugIn::ITradeStudy3JobInfo](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo) +* [TradeStudyPlugIn::ITradeStudy3JobManager](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager): Class which does everything that a combination of a DataHistory and a JobManager can do. Can be implemented using the inputs to a normal construct(...) call, but can do something else entirely. Thread-safe. +* [TradeStudyPlugIn::ITradeStudy3JobResult](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult): Interface representing the results of running a job. May be backed internally by a PHXDataCollector, or not. +* [TradeStudyPlugIn::ITradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback) +* [ModelCenter::ITradeStudyEvents](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents) +* [TradeStudyPlugIn::ITradeStudyPlugIn](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn) +* [TradeStudyPlugIn::ITradeStudyPlugIn2](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2) +* [TradeStudyPlugIn::ITradeStudyPlugIn3](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3) +* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) +* [ModelCenter::IVariableDescription](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription) +* [ModelCenter::IVariableLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink) +* [ModelCenter::IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) +* [TradeStudyPlugIn::IVariableMetaDataProvider](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider) +* [ModelCenter::IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) +* [ModelCenter::IVizContainer](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer) +* [TradeStudyPlugIn::IWindowed](interfaceTradeStudyPlugIn_1_1IWindowed.md#interfaceTradeStudyPlugIn_1_1IWindowed) +* [PHXDATAHISTORYLib::PHXDataExplorerExportPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn) * [PHXDATAHISTORYLib::PHXDataExplorerPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interface_index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interface_index.md index a61774c510..2390fcbee9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interface_index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/interface_index.md @@ -1,87 +1,87 @@ -# Index of Interfaces - -## C - -* [ComponentPlugIn::IComponentPlugIn](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn) - -## M - -* [ModelCenter::IAddToModel](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel) -* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) -* [ModelCenter::IAssemblies](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies) -* [ModelCenter::IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) -* [ModelCenter::IBooleanArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray) -* [ModelCenter::IBooleanVariable](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable) -* [ModelCenter::ICachePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin) -* [ModelCenter::IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) -* [ModelCenter::IComponents](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents) -* [ModelCenter::ICustomDesignPoint](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint) -* [ModelCenter::IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) -* [ModelCenter::IDataMonitor](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor) -* [ModelCenter::IDoubleArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray) -* [ModelCenter::IDoubleVariable](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable) -* [ModelCenter::IFeature](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature) -* [ModelCenter::IFileArray](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray) -* [ModelCenter::IFileSystemInfo](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo) -* [ModelCenter::IFileVariable](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable) -* [ModelCenter::IGeometryVariable](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable) -* [ModelCenter::IGlobalParameters](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters) -* [ModelCenter::IGroup](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup) -* [ModelCenter::IGroups](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups) -* [ModelCenter::IIfComponent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent) -* [ModelCenter::IIntegerArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray) -* [ModelCenter::IIntegerVariable](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable) -* [ModelCenter::IJobManager](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager) -* [ModelCenter::ILogger](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger) -* [ModelCenter::ILoginCallback](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback) -* [ModelCenter::IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) -* [ModelCenter::INetworkLocations](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations) -* [ModelCenter::IObjectVariable](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable) -* [ModelCenter::IPHXFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat) -* [ModelCenter::IRefArrayProp](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp) -* [ModelCenter::IReferenceArray](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray) -* [ModelCenter::IReferenceVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable) -* [ModelCenter::IRefProp](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp) -* [ModelCenter::IScriptComponent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent) -* [ModelCenter::IShowHelpEvents](interfaceModelCenter_1_1IShowHelpEvents.md#interfaceModelCenter_1_1IShowHelpEvents) -* [ModelCenter::IStringArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray) -* [ModelCenter::IStringVariable](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable) -* [ModelCenter::ITradeStudyEvents](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents) -* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) -* [ModelCenter::IVariableDescription](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription) -* [ModelCenter::IVariableLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink) -* [ModelCenter::IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) -* [ModelCenter::IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) -* [ModelCenter::IVizContainer](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer) - -## P - -* [PHXDATAEXPLORERLib::\_DPHXDataExplorer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer) -* [PHXDATAEXPLORERLib::\_DPHXDataExplorerEvents](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents) -* [PHXDATAHISTORYLib::\_DPHXDataHistory](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory) -* [PHXDATAHISTORYLib::\_DPHXDataHistoryEvents](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents) -* [PHXDATAHISTORYLib::\_DPHXDataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel) -* [PHXDATAEXPLORERLib::IDataExplorerFacadeOwner](interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner.md#interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner) -* [PHXDATAHISTORYLib::IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) -* [PHXDATAEXPLORERLib::ILegacyVisiblity](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity) -* [PHXDATAEXPLORERLib::IPageVisibility](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility) -* [PHXDATAEXPLORERLib::IPHXDataExplorerPointer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer) -* [PHXDATAEXPLORERLib::IPHXDEKeepalive](interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive.md#interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive) -* [PHXDATAHISTORYLib::IPHXMenuItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems) -* [PlugInMetaData::IPlugInMetaData](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData) -* [PHXDATAHISTORYLib::ISaveContext](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext) -* [PHXDATAHISTORYLib::PHXDataExplorerExportPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn) -* [PHXDATAHISTORYLib::PHXDataExplorerPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) - -## T - -* [TradeStudyPlugIn::ICombinedPlugIn](interfaceTradeStudyPlugIn_1_1ICombinedPlugIn.md#interfaceTradeStudyPlugIn_1_1ICombinedPlugIn) -* [TradeStudyPlugIn::ITradeStudy3JobInfo](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo) -* [TradeStudyPlugIn::ITradeStudy3JobManager](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager): Class which does everything that a combination of a DataHistory and a JobManager can do. Can be implemented using the inputs to a normal construct(...) call, but can do something else entirely. Thread-safe. -* [TradeStudyPlugIn::ITradeStudy3JobResult](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult): Interface representing the results of running a job. May be backed internally by a PHXDataCollector, or not. -* [TradeStudyPlugIn::ITradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback) -* [TradeStudyPlugIn::ITradeStudyPlugIn](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn) -* [TradeStudyPlugIn::ITradeStudyPlugIn2](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2) -* [TradeStudyPlugIn::ITradeStudyPlugIn3](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3) -* [TradeStudyPlugIn::IVariableMetaDataProvider](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider) +# Index of Interfaces + +## C + +* [ComponentPlugIn::IComponentPlugIn](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn) + +## M + +* [ModelCenter::IAddToModel](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel) +* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) +* [ModelCenter::IAssemblies](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies) +* [ModelCenter::IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) +* [ModelCenter::IBooleanArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray) +* [ModelCenter::IBooleanVariable](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable) +* [ModelCenter::ICachePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin) +* [ModelCenter::IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) +* [ModelCenter::IComponents](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents) +* [ModelCenter::ICustomDesignPoint](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint) +* [ModelCenter::IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) +* [ModelCenter::IDataMonitor](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor) +* [ModelCenter::IDoubleArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray) +* [ModelCenter::IDoubleVariable](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable) +* [ModelCenter::IFeature](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature) +* [ModelCenter::IFileArray](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray) +* [ModelCenter::IFileSystemInfo](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo) +* [ModelCenter::IFileVariable](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable) +* [ModelCenter::IGeometryVariable](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable) +* [ModelCenter::IGlobalParameters](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters) +* [ModelCenter::IGroup](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup) +* [ModelCenter::IGroups](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups) +* [ModelCenter::IIfComponent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent) +* [ModelCenter::IIntegerArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray) +* [ModelCenter::IIntegerVariable](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable) +* [ModelCenter::IJobManager](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager) +* [ModelCenter::ILogger](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger) +* [ModelCenter::ILoginCallback](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback) +* [ModelCenter::IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) +* [ModelCenter::INetworkLocations](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations) +* [ModelCenter::IObjectVariable](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable) +* [ModelCenter::IPHXFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat) +* [ModelCenter::IRefArrayProp](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp) +* [ModelCenter::IReferenceArray](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray) +* [ModelCenter::IReferenceVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable) +* [ModelCenter::IRefProp](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp) +* [ModelCenter::IScriptComponent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent) +* [ModelCenter::IShowHelpEvents](interfaceModelCenter_1_1IShowHelpEvents.md#interfaceModelCenter_1_1IShowHelpEvents) +* [ModelCenter::IStringArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray) +* [ModelCenter::IStringVariable](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable) +* [ModelCenter::ITradeStudyEvents](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents) +* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) +* [ModelCenter::IVariableDescription](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription) +* [ModelCenter::IVariableLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink) +* [ModelCenter::IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) +* [ModelCenter::IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) +* [ModelCenter::IVizContainer](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer) + +## P + +* [PHXDATAEXPLORERLib::\_DPHXDataExplorer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer) +* [PHXDATAEXPLORERLib::\_DPHXDataExplorerEvents](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents) +* [PHXDATAHISTORYLib::\_DPHXDataHistory](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory) +* [PHXDATAHISTORYLib::\_DPHXDataHistoryEvents](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents) +* [PHXDATAHISTORYLib::\_DPHXDataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel) +* [PHXDATAEXPLORERLib::IDataExplorerFacadeOwner](interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner.md#interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner) +* [PHXDATAHISTORYLib::IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) +* [PHXDATAEXPLORERLib::ILegacyVisiblity](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity) +* [PHXDATAEXPLORERLib::IPageVisibility](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility) +* [PHXDATAEXPLORERLib::IPHXDataExplorerPointer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer) +* [PHXDATAEXPLORERLib::IPHXDEKeepalive](interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive.md#interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive) +* [PHXDATAHISTORYLib::IPHXMenuItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems) +* [PlugInMetaData::IPlugInMetaData](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData) +* [PHXDATAHISTORYLib::ISaveContext](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext) +* [PHXDATAHISTORYLib::PHXDataExplorerExportPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn) +* [PHXDATAHISTORYLib::PHXDataExplorerPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) + +## T + +* [TradeStudyPlugIn::ICombinedPlugIn](interfaceTradeStudyPlugIn_1_1ICombinedPlugIn.md#interfaceTradeStudyPlugIn_1_1ICombinedPlugIn) +* [TradeStudyPlugIn::ITradeStudy3JobInfo](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo) +* [TradeStudyPlugIn::ITradeStudy3JobManager](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager): Class which does everything that a combination of a DataHistory and a JobManager can do. Can be implemented using the inputs to a normal construct(...) call, but can do something else entirely. Thread-safe. +* [TradeStudyPlugIn::ITradeStudy3JobResult](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult): Interface representing the results of running a job. May be backed internally by a PHXDataCollector, or not. +* [TradeStudyPlugIn::ITradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback) +* [TradeStudyPlugIn::ITradeStudyPlugIn](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn) +* [TradeStudyPlugIn::ITradeStudyPlugIn2](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2) +* [TradeStudyPlugIn::ITradeStudyPlugIn3](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3) +* [TradeStudyPlugIn::IVariableMetaDataProvider](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider) * [TradeStudyPlugIn::IWindowed](interfaceTradeStudyPlugIn_1_1IWindowed.md#interfaceTradeStudyPlugIn_1_1IWindowed) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespaceComponentPlugIn.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespaceComponentPlugIn.md index 23517b9a0e..443fdb10bf 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespaceComponentPlugIn.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespaceComponentPlugIn.md @@ -1,62 +1,61 @@ - -# Namespace ComponentPlugIn - -![][IDL] - -**Definition**: `ModelCenter/src/InterfaceDLL\_ComponentPlugIn/ComponentPlugIn.odl` (line 7) - - - - - -## Classes - -* [ComponentPlugIn::IComponentPlugIn](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn) - -## Functions - - -### Function importlib - -![][public] - -``` -ComponentPlugIn::importlib("stdole32.tlb") -``` - - - - - - - -**Parameters**: - -* "stdole32.tlb" - -**Return type**: - - -### Function importlib - -![][public] - -``` -ComponentPlugIn::importlib("stdole2.tlb") -``` - - - - - - - -**Parameters**: - -* "stdole2.tlb" - -**Return type**: - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Namespace ComponentPlugIn + +![][IDL] + +**Definition**: `ModelCenter/src/InterfaceDLL\_ComponentPlugIn/ComponentPlugIn.odl` (line 7) + + + + + +## Classes + +* [ComponentPlugIn::IComponentPlugIn](interfaceComponentPlugIn_1_1IComponentPlugIn.md#interfaceComponentPlugIn_1_1IComponentPlugIn) + +## Functions + + +### Function importlib + +![][public] + +``` +ComponentPlugIn::importlib("stdole32.tlb") +``` + + + + + + + +**Parameters**: + +* "stdole32.tlb" + +**Return type**: + + +### Function importlib + +![][public] + +``` +ComponentPlugIn::importlib("stdole2.tlb") +``` + + + + + + + +**Parameters**: + +* "stdole2.tlb" + +**Return type**: + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespaceModelCenter.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespaceModelCenter.md index c9df4e8c2e..31366dc6df 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespaceModelCenter.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespaceModelCenter.md @@ -1,415 +1,414 @@ - -# Namespace ModelCenter - -![][IDL] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 18) - - - -ModelCenter API - -## Classes - -* [ModelCenter::Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) -* [ModelCenter::IAddToModel](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel) -* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) -* [ModelCenter::IAssemblies](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies) -* [ModelCenter::IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) -* [ModelCenter::IBooleanArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray) -* [ModelCenter::IBooleanVariable](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable) -* [ModelCenter::ICachePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin) -* [ModelCenter::IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) -* [ModelCenter::IComponents](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents) -* [ModelCenter::ICustomDesignPoint](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint) -* [ModelCenter::IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) -* [ModelCenter::IDataMonitor](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor) -* [ModelCenter::IDoubleArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray) -* [ModelCenter::IDoubleVariable](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable) -* [ModelCenter::IFeature](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature) -* [ModelCenter::IFileArray](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray) -* [ModelCenter::IFileSystemInfo](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo) -* [ModelCenter::IFileVariable](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable) -* [ModelCenter::IGeometryVariable](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable) -* [ModelCenter::IGlobalParameters](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters) -* [ModelCenter::IGroup](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup) -* [ModelCenter::IGroups](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups) -* [ModelCenter::IIfComponent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent) -* [ModelCenter::IIntegerArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray) -* [ModelCenter::IIntegerVariable](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable) -* [ModelCenter::IJobManager](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager) -* [ModelCenter::ILogger](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger) -* [ModelCenter::ILoginCallback](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback) -* [ModelCenter::IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) -* [ModelCenter::INetworkLocations](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations) -* [ModelCenter::IObjectVariable](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable) -* [ModelCenter::IPHXFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat) -* [ModelCenter::IRefArrayProp](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp) -* [ModelCenter::IReferenceArray](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray) -* [ModelCenter::IReferenceVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable) -* [ModelCenter::IRefProp](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp) -* [ModelCenter::IScriptComponent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent) -* [ModelCenter::IShowHelpEvents](interfaceModelCenter_1_1IShowHelpEvents.md#interfaceModelCenter_1_1IShowHelpEvents) -* [ModelCenter::IStringArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray) -* [ModelCenter::IStringVariable](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable) -* [ModelCenter::ITradeStudyEvents](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents) -* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) -* [ModelCenter::IVariableDescription](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription) -* [ModelCenter::IVariableLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink) -* [ModelCenter::IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) -* [ModelCenter::IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) -* [ModelCenter::IVizContainer](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer) - -## Enumeration types - - -### Enumeration type MetadataType - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 31) - -``` -enum MetadataType { - METADATA_TYPE_STRING = 0, - METADATA_TYPE_DOUBLE = 1, - METADATA_TYPE_LONG = 2, - METADATA_TYPE_BOOLEAN = 3, - METADATA_TYPE_XML = 4, - METADATA_TYPE_FORCE_TO_32_BITS = 65536 -} -``` - - - -Type of metadata. - - - - -#### Enumerator METADATA\_TYPE\_STRING - - - - - - -#### Enumerator METADATA\_TYPE\_DOUBLE - - - - - - -#### Enumerator METADATA\_TYPE\_LONG - - - - - - -#### Enumerator METADATA\_TYPE\_BOOLEAN - - - - - - -#### Enumerator METADATA\_TYPE\_XML - - - - - - -#### Enumerator METADATA\_TYPE\_FORCE\_TO\_32\_BITS - - - - - - -### Enumeration type MetadataAccess - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 44) - -``` -enum MetadataAccess { - METADATA_ACCESS_PRIVATE = 0, - METADATA_ACCESS_READONLY = 1, - METADATA_ACCESS_PUBLIC = 2, - METADATA_ACCESS_FORCE_TO_32_BITS = 65536 -} -``` - - - -Access allowed for metadata. - - - - -#### Enumerator METADATA\_ACCESS\_PRIVATE - - - - - - -#### Enumerator METADATA\_ACCESS\_READONLY - - - - - - -#### Enumerator METADATA\_ACCESS\_PUBLIC - - - - - - -#### Enumerator METADATA\_ACCESS\_FORCE\_TO\_32\_BITS - - - - - - -### Enumeration type TradeStudyFormat - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 55) - -``` -enum TradeStudyFormat { - TS_FORMAT_PXTZ = 0, - TS_FORMAT_PXT_COMPRESSED = 1, - TS_FORMAT_PXT_UNCOMPRESSED = 2, - TS_FORMAT_TSTUDY = 3 -} -``` - - - -An enumeration of the different trade study file formats - - - - -#### Enumerator TS\_FORMAT\_PXTZ - - - -Used to signify that the format PXTZ was selected and that a file should be saved in that format -**Deprecated**: - -This file format is deprecated and files can no longer be saved in this format. - - -#### Enumerator TS\_FORMAT\_PXT\_COMPRESSED - - - -Used to signify that the format PXT (Compressed) was selected and that a file should be saved in that format -**Deprecated**: - -This file format is deprecated and files can no longer be saved in this format. - - -#### Enumerator TS\_FORMAT\_PXT\_UNCOMPRESSED - - - -Used to signify that the format PXT (Uncompressed) was selected and that a file should be saved in that format -**Deprecated**: - -This file format is deprecated and files can no longer be saved in this format. - - -#### Enumerator TS\_FORMAT\_TSTUDY - - - -Used to signify that the format TSTUDY was selected and that a file should be saved in that format - - -### Enumeration type VersionStatus - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 657) - -``` -enum VersionStatus { - DO_VERSIONING = 0, - DO_NOT_VERSION = 1, - DO_VERSIONING_IF_POSSIBLE = 2 -} -``` - - - -Versioning option for saving to [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) cloud data storage. - - - - -#### Enumerator DO\_VERSIONING - - - - - - -#### Enumerator DO\_NOT\_VERSION - - - - - - -#### Enumerator DO\_VERSIONING\_IF\_POSSIBLE - - - - - - -### Enumeration type AssemblyStyle - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3809) - -``` -enum AssemblyStyle { - ASSEMBLY_STYLE_COLLAPSED = 0, - ASSEMBLY_STYLE_EXPANDED = 1, - ASSEMBLY_STYLE_CLASSIC = 100, - ASSEMBLY_STYLE_N_SQUARED = 101, - ASSEMBLY_STYLE_AUTO_N_SQUARED = 102, - ASSEMBLY_STYLE_FORCE_32_BITS = 65536 -} -``` - - - -Ways to display an assembly. - - - - -#### Enumerator ASSEMBLY\_STYLE\_COLLAPSED - - - -Collapse the assembly. Not allowed for the model. - - -#### Enumerator ASSEMBLY\_STYLE\_EXPANDED - - - -Expand the assembly. No effect for the model. - - -#### Enumerator ASSEMBLY\_STYLE\_CLASSIC - - - -Set to classic view. Only valid for Data Dependency assemblies. - - -#### Enumerator ASSEMBLY\_STYLE\_N\_SQUARED - - - -Set to N^2 view. Only valid for Data Dependency assemblies. - - -#### Enumerator ASSEMBLY\_STYLE\_AUTO\_N\_SQUARED - - - -Set to auto-N^2 view. Only valid for Data Dependency assemblies. - - -#### Enumerator ASSEMBLY\_STYLE\_FORCE\_32\_BITS - - - - - - -### Enumeration type OnConnectionErrorMode - -![][public] - -**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5038) - -``` -enum OnConnectionErrorMode { - CONN_ERR_ERROR = 3, - CONN_ERR_IGNORE = 1, - CONN_ERR_USEDIALOG = -1 -} -``` - - - -Mode of action to take when there is an error with connection. Used with [loadModel ](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab57546e9e718895bbdfa25bc1b7d1e9d). - - - - -#### Enumerator CONN\_ERR\_ERROR - - - -Abort loading and throw the error back to the caller. - - -#### Enumerator CONN\_ERR\_IGNORE - - - -Ignore the error and continue loading (as if user has pressed "Ignore" in the dialog). - - -#### Enumerator CONN\_ERR\_USEDIALOG - - - -(option not available when running ModelCenter in server mode) Shows the error as if the user were loading the file manually with full control. - -## Functions - - -### Function importlib - -![][private] - -``` -ModelCenter::importlib("stdole32.tlb") -``` - - - - - - - -**Parameters**: - -* "stdole32.tlb" - -**Return type**: - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Namespace ModelCenter + +![][IDL] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 18) + + + +ModelCenter API + +## Classes + +* [ModelCenter::Application](classModelCenter_1_1Application.md#classModelCenter_1_1Application) +* [ModelCenter::IAddToModel](interfaceModelCenter_1_1IAddToModel.md#interfaceModelCenter_1_1IAddToModel) +* [ModelCenter::IArray](interfaceModelCenter_1_1IArray.md#interfaceModelCenter_1_1IArray) +* [ModelCenter::IAssemblies](interfaceModelCenter_1_1IAssemblies.md#interfaceModelCenter_1_1IAssemblies) +* [ModelCenter::IAssembly](interfaceModelCenter_1_1IAssembly.md#interfaceModelCenter_1_1IAssembly) +* [ModelCenter::IBooleanArray](interfaceModelCenter_1_1IBooleanArray.md#interfaceModelCenter_1_1IBooleanArray) +* [ModelCenter::IBooleanVariable](interfaceModelCenter_1_1IBooleanVariable.md#interfaceModelCenter_1_1IBooleanVariable) +* [ModelCenter::ICachePin](interfaceModelCenter_1_1ICachePin.md#interfaceModelCenter_1_1ICachePin) +* [ModelCenter::IComponent](interfaceModelCenter_1_1IComponent.md#interfaceModelCenter_1_1IComponent) +* [ModelCenter::IComponents](interfaceModelCenter_1_1IComponents.md#interfaceModelCenter_1_1IComponents) +* [ModelCenter::ICustomDesignPoint](interfaceModelCenter_1_1ICustomDesignPoint.md#interfaceModelCenter_1_1ICustomDesignPoint) +* [ModelCenter::IDataCollector](interfaceModelCenter_1_1IDataCollector.md#interfaceModelCenter_1_1IDataCollector) +* [ModelCenter::IDataMonitor](interfaceModelCenter_1_1IDataMonitor.md#interfaceModelCenter_1_1IDataMonitor) +* [ModelCenter::IDoubleArray](interfaceModelCenter_1_1IDoubleArray.md#interfaceModelCenter_1_1IDoubleArray) +* [ModelCenter::IDoubleVariable](interfaceModelCenter_1_1IDoubleVariable.md#interfaceModelCenter_1_1IDoubleVariable) +* [ModelCenter::IFeature](interfaceModelCenter_1_1IFeature.md#interfaceModelCenter_1_1IFeature) +* [ModelCenter::IFileArray](interfaceModelCenter_1_1IFileArray.md#interfaceModelCenter_1_1IFileArray) +* [ModelCenter::IFileSystemInfo](interfaceModelCenter_1_1IFileSystemInfo.md#interfaceModelCenter_1_1IFileSystemInfo) +* [ModelCenter::IFileVariable](interfaceModelCenter_1_1IFileVariable.md#interfaceModelCenter_1_1IFileVariable) +* [ModelCenter::IGeometryVariable](interfaceModelCenter_1_1IGeometryVariable.md#interfaceModelCenter_1_1IGeometryVariable) +* [ModelCenter::IGlobalParameters](interfaceModelCenter_1_1IGlobalParameters.md#interfaceModelCenter_1_1IGlobalParameters) +* [ModelCenter::IGroup](interfaceModelCenter_1_1IGroup.md#interfaceModelCenter_1_1IGroup) +* [ModelCenter::IGroups](interfaceModelCenter_1_1IGroups.md#interfaceModelCenter_1_1IGroups) +* [ModelCenter::IIfComponent](interfaceModelCenter_1_1IIfComponent.md#interfaceModelCenter_1_1IIfComponent) +* [ModelCenter::IIntegerArray](interfaceModelCenter_1_1IIntegerArray.md#interfaceModelCenter_1_1IIntegerArray) +* [ModelCenter::IIntegerVariable](interfaceModelCenter_1_1IIntegerVariable.md#interfaceModelCenter_1_1IIntegerVariable) +* [ModelCenter::IJobManager](interfaceModelCenter_1_1IJobManager.md#interfaceModelCenter_1_1IJobManager) +* [ModelCenter::ILogger](interfaceModelCenter_1_1ILogger.md#interfaceModelCenter_1_1ILogger) +* [ModelCenter::ILoginCallback](interfaceModelCenter_1_1ILoginCallback.md#interfaceModelCenter_1_1ILoginCallback) +* [ModelCenter::IModelCenter](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter) +* [ModelCenter::INetworkLocations](interfaceModelCenter_1_1INetworkLocations.md#interfaceModelCenter_1_1INetworkLocations) +* [ModelCenter::IObjectVariable](interfaceModelCenter_1_1IObjectVariable.md#interfaceModelCenter_1_1IObjectVariable) +* [ModelCenter::IPHXFormat](interfaceModelCenter_1_1IPHXFormat.md#interfaceModelCenter_1_1IPHXFormat) +* [ModelCenter::IRefArrayProp](interfaceModelCenter_1_1IRefArrayProp.md#interfaceModelCenter_1_1IRefArrayProp) +* [ModelCenter::IReferenceArray](interfaceModelCenter_1_1IReferenceArray.md#interfaceModelCenter_1_1IReferenceArray) +* [ModelCenter::IReferenceVariable](interfaceModelCenter_1_1IReferenceVariable.md#interfaceModelCenter_1_1IReferenceVariable) +* [ModelCenter::IRefProp](interfaceModelCenter_1_1IRefProp.md#interfaceModelCenter_1_1IRefProp) +* [ModelCenter::IScriptComponent](interfaceModelCenter_1_1IScriptComponent.md#interfaceModelCenter_1_1IScriptComponent) +* [ModelCenter::IShowHelpEvents](interfaceModelCenter_1_1IShowHelpEvents.md#interfaceModelCenter_1_1IShowHelpEvents) +* [ModelCenter::IStringArray](interfaceModelCenter_1_1IStringArray.md#interfaceModelCenter_1_1IStringArray) +* [ModelCenter::IStringVariable](interfaceModelCenter_1_1IStringVariable.md#interfaceModelCenter_1_1IStringVariable) +* [ModelCenter::ITradeStudyEvents](interfaceModelCenter_1_1ITradeStudyEvents.md#interfaceModelCenter_1_1ITradeStudyEvents) +* [ModelCenter::IVariable](interfaceModelCenter_1_1IVariable.md#interfaceModelCenter_1_1IVariable) +* [ModelCenter::IVariableDescription](interfaceModelCenter_1_1IVariableDescription.md#interfaceModelCenter_1_1IVariableDescription) +* [ModelCenter::IVariableLink](interfaceModelCenter_1_1IVariableLink.md#interfaceModelCenter_1_1IVariableLink) +* [ModelCenter::IVariableLinks](interfaceModelCenter_1_1IVariableLinks.md#interfaceModelCenter_1_1IVariableLinks) +* [ModelCenter::IVariables](interfaceModelCenter_1_1IVariables.md#interfaceModelCenter_1_1IVariables) +* [ModelCenter::IVizContainer](interfaceModelCenter_1_1IVizContainer.md#interfaceModelCenter_1_1IVizContainer) + +## Enumeration types + + +### Enumeration type MetadataType + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 31) + +``` +enum MetadataType { + METADATA_TYPE_STRING = 0, + METADATA_TYPE_DOUBLE = 1, + METADATA_TYPE_LONG = 2, + METADATA_TYPE_BOOLEAN = 3, + METADATA_TYPE_XML = 4, + METADATA_TYPE_FORCE_TO_32_BITS = 65536 +} +``` + + + +Type of metadata. + + + + +#### Enumerator METADATA\_TYPE\_STRING + + + + + + +#### Enumerator METADATA\_TYPE\_DOUBLE + + + + + + +#### Enumerator METADATA\_TYPE\_LONG + + + + + + +#### Enumerator METADATA\_TYPE\_BOOLEAN + + + + + + +#### Enumerator METADATA\_TYPE\_XML + + + + + + +#### Enumerator METADATA\_TYPE\_FORCE\_TO\_32\_BITS + + + + + + +### Enumeration type MetadataAccess + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 44) + +``` +enum MetadataAccess { + METADATA_ACCESS_PRIVATE = 0, + METADATA_ACCESS_READONLY = 1, + METADATA_ACCESS_PUBLIC = 2, + METADATA_ACCESS_FORCE_TO_32_BITS = 65536 +} +``` + + + +Access allowed for metadata. + + + + +#### Enumerator METADATA\_ACCESS\_PRIVATE + + + + + + +#### Enumerator METADATA\_ACCESS\_READONLY + + + + + + +#### Enumerator METADATA\_ACCESS\_PUBLIC + + + + + + +#### Enumerator METADATA\_ACCESS\_FORCE\_TO\_32\_BITS + + + + + + +### Enumeration type TradeStudyFormat + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 55) + +``` +enum TradeStudyFormat { + TS_FORMAT_PXTZ = 0, + TS_FORMAT_PXT_COMPRESSED = 1, + TS_FORMAT_PXT_UNCOMPRESSED = 2, + TS_FORMAT_TSTUDY = 3 +} +``` + + + +An enumeration of the different trade study file formats + + + + +#### Enumerator TS\_FORMAT\_PXTZ + + + +Used to signify that the format PXTZ was selected and that a file should be saved in that format +**Deprecated**: + +This file format is deprecated and files can no longer be saved in this format. + + +#### Enumerator TS\_FORMAT\_PXT\_COMPRESSED + + + +Used to signify that the format PXT (Compressed) was selected and that a file should be saved in that format +**Deprecated**: + +This file format is deprecated and files can no longer be saved in this format. + + +#### Enumerator TS\_FORMAT\_PXT\_UNCOMPRESSED + + + +Used to signify that the format PXT (Uncompressed) was selected and that a file should be saved in that format +**Deprecated**: + +This file format is deprecated and files can no longer be saved in this format. + + +#### Enumerator TS\_FORMAT\_TSTUDY + + + +Used to signify that the format TSTUDY was selected and that a file should be saved in that format + + +### Enumeration type VersionStatus + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 657) + +``` +enum VersionStatus { + DO_VERSIONING = 0, + DO_NOT_VERSION = 1, + DO_VERSIONING_IF_POSSIBLE = 2 +} +``` + + + +Versioning option for saving to [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) cloud data storage. + + + + +#### Enumerator DO\_VERSIONING + + + + + + +#### Enumerator DO\_NOT\_VERSION + + + + + + +#### Enumerator DO\_VERSIONING\_IF\_POSSIBLE + + + + + + +### Enumeration type AssemblyStyle + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 3809) + +``` +enum AssemblyStyle { + ASSEMBLY_STYLE_COLLAPSED = 0, + ASSEMBLY_STYLE_EXPANDED = 1, + ASSEMBLY_STYLE_CLASSIC = 100, + ASSEMBLY_STYLE_N_SQUARED = 101, + ASSEMBLY_STYLE_AUTO_N_SQUARED = 102, + ASSEMBLY_STYLE_FORCE_32_BITS = 65536 +} +``` + + + +Ways to display an assembly. + + + + +#### Enumerator ASSEMBLY\_STYLE\_COLLAPSED + + + +Collapse the assembly. Not allowed for the model. + + +#### Enumerator ASSEMBLY\_STYLE\_EXPANDED + + + +Expand the assembly. No effect for the model. + + +#### Enumerator ASSEMBLY\_STYLE\_CLASSIC + + + +Set to classic view. Only valid for Data Dependency assemblies. + + +#### Enumerator ASSEMBLY\_STYLE\_N\_SQUARED + + + +Set to N^2 view. Only valid for Data Dependency assemblies. + + +#### Enumerator ASSEMBLY\_STYLE\_AUTO\_N\_SQUARED + + + +Set to auto-N^2 view. Only valid for Data Dependency assemblies. + + +#### Enumerator ASSEMBLY\_STYLE\_FORCE\_32\_BITS + + + + + + +### Enumeration type OnConnectionErrorMode + +![][public] + +**Definition**: `ModelCenter/src/ModelCenter.odl` (line 5038) + +``` +enum OnConnectionErrorMode { + CONN_ERR_ERROR = 3, + CONN_ERR_IGNORE = 1, + CONN_ERR_USEDIALOG = -1 +} +``` + + + +Mode of action to take when there is an error with connection. Used with [loadModel ](interfaceModelCenter_1_1IModelCenter.md#interfaceModelCenter_1_1IModelCenter_1ab57546e9e718895bbdfa25bc1b7d1e9d). + + + + +#### Enumerator CONN\_ERR\_ERROR + + + +Abort loading and throw the error back to the caller. + + +#### Enumerator CONN\_ERR\_IGNORE + + + +Ignore the error and continue loading (as if user has pressed "Ignore" in the dialog). + + +#### Enumerator CONN\_ERR\_USEDIALOG + + + +(option not available when running ModelCenter in server mode) Shows the error as if the user were loading the file manually with full control. + +## Functions + + +### Function importlib + +![][private] + +``` +ModelCenter::importlib("stdole32.tlb") +``` + + + + + + + +**Parameters**: + +* "stdole32.tlb" + +**Return type**: + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespacePHXDATAEXPLORERLib.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespacePHXDATAEXPLORERLib.md index ef4c4b3e4f..409d4b6adb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespacePHXDATAEXPLORERLib.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespacePHXDATAEXPLORERLib.md @@ -1,70 +1,69 @@ - -# Namespace PHXDATAEXPLORERLib - -![][IDL] - -**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 14) - - - -Data Explorer API - -## Classes - -* [PHXDATAEXPLORERLib::\_DPHXDataExplorer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer) -* [PHXDATAEXPLORERLib::\_DPHXDataExplorerEvents](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents) -* [PHXDATAEXPLORERLib::IDataExplorerFacadeOwner](interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner.md#interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner) -* [PHXDATAEXPLORERLib::ILegacyVisiblity](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity) -* [PHXDATAEXPLORERLib::IPageVisibility](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility) -* [PHXDATAEXPLORERLib::IPHXDataExplorerPointer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer) -* [PHXDATAEXPLORERLib::IPHXDEKeepalive](interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive.md#interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive) -* [PHXDATAEXPLORERLib::PHXDataExplorer](classPHXDATAEXPLORERLib_1_1PHXDataExplorer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorer) -* [PHXDATAEXPLORERLib::PHXDataExplorerPointer](classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer) - -## Functions - - -### Function importlib - -![][private] - -``` -PHXDATAEXPLORERLib::importlib(STDOLE_TLB) -``` - - - - - - - -**Parameters**: - -* STDOLE_TLB - -**Return type**: - - -### Function importlib - -![][private] - -``` -PHXDATAEXPLORERLib::importlib(STDTYPE_TLB) -``` - - - - - - - -**Parameters**: - -* STDTYPE_TLB - -**Return type**: - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Namespace PHXDATAEXPLORERLib + +![][IDL] + +**Definition**: `LIBS/DataExplorer/PHXDataExplorer/PHXDataExplorer.odl` (line 14) + + + +Data Explorer API + +## Classes + +* [PHXDATAEXPLORERLib::\_DPHXDataExplorer](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorer) +* [PHXDATAEXPLORERLib::\_DPHXDataExplorerEvents](interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents.md#interfacePHXDATAEXPLORERLib_1_1__DPHXDataExplorerEvents) +* [PHXDATAEXPLORERLib::IDataExplorerFacadeOwner](interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner.md#interfacePHXDATAEXPLORERLib_1_1IDataExplorerFacadeOwner) +* [PHXDATAEXPLORERLib::ILegacyVisiblity](interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity.md#interfacePHXDATAEXPLORERLib_1_1ILegacyVisiblity) +* [PHXDATAEXPLORERLib::IPageVisibility](interfacePHXDATAEXPLORERLib_1_1IPageVisibility.md#interfacePHXDATAEXPLORERLib_1_1IPageVisibility) +* [PHXDATAEXPLORERLib::IPHXDataExplorerPointer](interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer.md#interfacePHXDATAEXPLORERLib_1_1IPHXDataExplorerPointer) +* [PHXDATAEXPLORERLib::IPHXDEKeepalive](interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive.md#interfacePHXDATAEXPLORERLib_1_1IPHXDEKeepalive) +* [PHXDATAEXPLORERLib::PHXDataExplorer](classPHXDATAEXPLORERLib_1_1PHXDataExplorer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorer) +* [PHXDATAEXPLORERLib::PHXDataExplorerPointer](classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer.md#classPHXDATAEXPLORERLib_1_1PHXDataExplorerPointer) + +## Functions + + +### Function importlib + +![][private] + +``` +PHXDATAEXPLORERLib::importlib(STDOLE_TLB) +``` + + + + + + + +**Parameters**: + +* STDOLE_TLB + +**Return type**: + + +### Function importlib + +![][private] + +``` +PHXDATAEXPLORERLib::importlib(STDTYPE_TLB) +``` + + + + + + + +**Parameters**: + +* STDTYPE_TLB + +**Return type**: + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespacePHXDATAHISTORYLib.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespacePHXDATAHISTORYLib.md index b7a120d51c..2dfdc75200 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespacePHXDATAHISTORYLib.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespacePHXDATAHISTORYLib.md @@ -1,157 +1,156 @@ - -# Namespace PHXDATAHISTORYLib - -![][IDL] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 14) - - - -Data History API - -## Classes - -* [PHXDATAHISTORYLib::\_DPHXDataHistory](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory) -* [PHXDATAHISTORYLib::\_DPHXDataHistoryEvents](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents) -* [PHXDATAHISTORYLib::\_DPHXDataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel) -* [PHXDATAHISTORYLib::DataHistoryVariableMetadata](classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata.md#classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata) -* [PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct) -* [PHXDATAHISTORYLib::DataHistoryVariableStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct) -* [PHXDATAHISTORYLib::IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) -* [PHXDATAHISTORYLib::IPHXMenuItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems) -* [PHXDATAHISTORYLib::ISaveContext](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext) -* [PHXDATAHISTORYLib::PHXDataExplorerExportPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn) -* [PHXDATAHISTORYLib::PHXDataExplorerPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) -* [PHXDATAHISTORYLib::PHXDataHistory](classPHXDATAHISTORYLib_1_1PHXDataHistory.md#classPHXDATAHISTORYLib_1_1PHXDataHistory) - -## Enumeration types - - -### Enumeration type PHXMENU\_PREDEFS - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1003) - -``` -enum PHXMENU_PREDEFS { - PHXMENU_CUT =-1, - PHXMENU_COPY =-2, - PHXMENU_PASTE =-3, - PHXMENU_DELETE =-4, - PHXMENU_PAGESETTINGS =-5, - PHXMENU_PRINT =-6, - PHXMENU_EXPORT =-7, - PHXMENU_TOOLTIP =-8 -} -``` - - - -A list of pre-defined menu items that can be used through the isMenuItemEnabled and invokeMenuItem function calls. - - - - -#### Enumerator PHXMENU\_CUT - -Edit/Cut. - - - - -#### Enumerator PHXMENU\_COPY - -Edit/Copy. - - - - -#### Enumerator PHXMENU\_PASTE - -Edit/Paste. - - - - -#### Enumerator PHXMENU\_DELETE - -Edit/Delete. - - - - -#### Enumerator PHXMENU\_PAGESETTINGS - -Page/Basic Settings... - - - - -#### Enumerator PHXMENU\_PRINT - -Page/Print Page... - - - - -#### Enumerator PHXMENU\_EXPORT - -Page/Export Page... - - - - -#### Enumerator PHXMENU\_TOOLTIP - - - - - -## Functions - - -### Function importlib - -![][private] - -``` -PHXDATAHISTORYLib::importlib(STDOLE_TLB) -``` - - - - - - - -**Parameters**: - -* STDOLE_TLB - -**Return type**: - - -### Function importlib - -![][private] - -``` -PHXDATAHISTORYLib::importlib(STDTYPE_TLB) -``` - - - - - - - -**Parameters**: - -* STDTYPE_TLB - -**Return type**: - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Namespace PHXDATAHISTORYLib + +![][IDL] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 14) + + + +Data History API + +## Classes + +* [PHXDATAHISTORYLib::\_DPHXDataHistory](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistory) +* [PHXDATAHISTORYLib::\_DPHXDataHistoryEvents](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryEvents) +* [PHXDATAHISTORYLib::\_DPHXDataHistoryToModel](interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel.md#interfacePHXDATAHISTORYLib_1_1__DPHXDataHistoryToModel) +* [PHXDATAHISTORYLib::DataHistoryVariableMetadata](classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata.md#classPHXDATAHISTORYLib_1_1DataHistoryVariableMetadata) +* [PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct) +* [PHXDATAHISTORYLib::DataHistoryVariableStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct) +* [PHXDATAHISTORYLib::IDHVariable](interfacePHXDATAHISTORYLib_1_1IDHVariable.md#interfacePHXDATAHISTORYLib_1_1IDHVariable) +* [PHXDATAHISTORYLib::IPHXMenuItems](interfacePHXDATAHISTORYLib_1_1IPHXMenuItems.md#interfacePHXDATAHISTORYLib_1_1IPHXMenuItems) +* [PHXDATAHISTORYLib::ISaveContext](interfacePHXDATAHISTORYLib_1_1ISaveContext.md#interfacePHXDATAHISTORYLib_1_1ISaveContext) +* [PHXDATAHISTORYLib::PHXDataExplorerExportPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerExportPlugIn) +* [PHXDATAHISTORYLib::PHXDataExplorerPlugIn](interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn.md#interfacePHXDATAHISTORYLib_1_1PHXDataExplorerPlugIn) +* [PHXDATAHISTORYLib::PHXDataHistory](classPHXDATAHISTORYLib_1_1PHXDataHistory.md#classPHXDATAHISTORYLib_1_1PHXDataHistory) + +## Enumeration types + + +### Enumeration type PHXMENU\_PREDEFS + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 1003) + +``` +enum PHXMENU_PREDEFS { + PHXMENU_CUT =-1, + PHXMENU_COPY =-2, + PHXMENU_PASTE =-3, + PHXMENU_DELETE =-4, + PHXMENU_PAGESETTINGS =-5, + PHXMENU_PRINT =-6, + PHXMENU_EXPORT =-7, + PHXMENU_TOOLTIP =-8 +} +``` + + + +A list of pre-defined menu items that can be used through the isMenuItemEnabled and invokeMenuItem function calls. + + + + +#### Enumerator PHXMENU\_CUT + +Edit/Cut. + + + + +#### Enumerator PHXMENU\_COPY + +Edit/Copy. + + + + +#### Enumerator PHXMENU\_PASTE + +Edit/Paste. + + + + +#### Enumerator PHXMENU\_DELETE + +Edit/Delete. + + + + +#### Enumerator PHXMENU\_PAGESETTINGS + +Page/Basic Settings... + + + + +#### Enumerator PHXMENU\_PRINT + +Page/Print Page... + + + + +#### Enumerator PHXMENU\_EXPORT + +Page/Export Page... + + + + +#### Enumerator PHXMENU\_TOOLTIP + + + + + +## Functions + + +### Function importlib + +![][private] + +``` +PHXDATAHISTORYLib::importlib(STDOLE_TLB) +``` + + + + + + + +**Parameters**: + +* STDOLE_TLB + +**Return type**: + + +### Function importlib + +![][private] + +``` +PHXDATAHISTORYLib::importlib(STDTYPE_TLB) +``` + + + + + + + +**Parameters**: + +* STDTYPE_TLB + +**Return type**: + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespacePlugInMetaData.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespacePlugInMetaData.md index 4680f5bb5d..e59000b442 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespacePlugInMetaData.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespacePlugInMetaData.md @@ -1,62 +1,61 @@ - -# Namespace PlugInMetaData - -![][IDL] - -**Definition**: `ModelCenter/src/InterfaceDLL\_PlugInMetaData/PlugInMetaData.odl` (line 7) - - - - - -## Classes - -* [PlugInMetaData::IPlugInMetaData](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData) - -## Functions - - -### Function importlib - -![][public] - -``` -PlugInMetaData::importlib("stdole32.tlb") -``` - - - - - - - -**Parameters**: - -* "stdole32.tlb" - -**Return type**: - - -### Function importlib - -![][public] - -``` -PlugInMetaData::importlib("stdole2.tlb") -``` - - - - - - - -**Parameters**: - -* "stdole2.tlb" - -**Return type**: - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Namespace PlugInMetaData + +![][IDL] + +**Definition**: `ModelCenter/src/InterfaceDLL\_PlugInMetaData/PlugInMetaData.odl` (line 7) + + + + + +## Classes + +* [PlugInMetaData::IPlugInMetaData](interfacePlugInMetaData_1_1IPlugInMetaData.md#interfacePlugInMetaData_1_1IPlugInMetaData) + +## Functions + + +### Function importlib + +![][public] + +``` +PlugInMetaData::importlib("stdole32.tlb") +``` + + + + + + + +**Parameters**: + +* "stdole32.tlb" + +**Return type**: + + +### Function importlib + +![][public] + +``` +PlugInMetaData::importlib("stdole2.tlb") +``` + + + + + + + +**Parameters**: + +* "stdole2.tlb" + +**Return type**: + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespaceTradeStudyPlugIn.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespaceTradeStudyPlugIn.md index 0355460abb..4ecb9d2c5f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespaceTradeStudyPlugIn.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespaceTradeStudyPlugIn.md @@ -1,73 +1,72 @@ - -# Namespace TradeStudyPlugIn - -![][IDL] - -**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 7) - - - - - -## Classes - -* [TradeStudyPlugIn::ICombinedPlugIn](interfaceTradeStudyPlugIn_1_1ICombinedPlugIn.md#interfaceTradeStudyPlugIn_1_1ICombinedPlugIn) -* [TradeStudyPlugIn::ITradeStudy3JobInfo](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo) -* [TradeStudyPlugIn::ITradeStudy3JobManager](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager) -* [TradeStudyPlugIn::ITradeStudy3JobResult](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult) -* [TradeStudyPlugIn::ITradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback) -* [TradeStudyPlugIn::ITradeStudyPlugIn](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn) -* [TradeStudyPlugIn::ITradeStudyPlugIn2](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2) -* [TradeStudyPlugIn::ITradeStudyPlugIn3](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3) -* [TradeStudyPlugIn::IVariableMetaDataProvider](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider) -* [TradeStudyPlugIn::IWindowed](interfaceTradeStudyPlugIn_1_1IWindowed.md#interfaceTradeStudyPlugIn_1_1IWindowed) -* [TradeStudyPlugIn::TradeStudyPlugIn](classTradeStudyPlugIn_1_1TradeStudyPlugIn.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn) -* [TradeStudyPlugIn::TradeStudyPlugIn2](classTradeStudyPlugIn_1_1TradeStudyPlugIn2.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn2) - -## Functions - - -### Function importlib - -![][public] - -``` -TradeStudyPlugIn::importlib("stdole32.tlb") -``` - - - - - - - -**Parameters**: - -* "stdole32.tlb" - -**Return type**: - - -### Function importlib - -![][public] - -``` -TradeStudyPlugIn::importlib("stdole2.tlb") -``` - - - - - - - -**Parameters**: - -* "stdole2.tlb" - -**Return type**: - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Namespace TradeStudyPlugIn + +![][IDL] + +**Definition**: `ModelCenter/src/InterfaceDLL\_TradeStudyPlugIn/TradeStudyPlugIn.odl` (line 7) + + + + + +## Classes + +* [TradeStudyPlugIn::ICombinedPlugIn](interfaceTradeStudyPlugIn_1_1ICombinedPlugIn.md#interfaceTradeStudyPlugIn_1_1ICombinedPlugIn) +* [TradeStudyPlugIn::ITradeStudy3JobInfo](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobInfo) +* [TradeStudyPlugIn::ITradeStudy3JobManager](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobManager) +* [TradeStudyPlugIn::ITradeStudy3JobResult](interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult.md#interfaceTradeStudyPlugIn_1_1ITradeStudy3JobResult) +* [TradeStudyPlugIn::ITradeStudyCallback](interfaceTradeStudyPlugIn_1_1ITradeStudyCallback.md#interfaceTradeStudyPlugIn_1_1ITradeStudyCallback) +* [TradeStudyPlugIn::ITradeStudyPlugIn](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn) +* [TradeStudyPlugIn::ITradeStudyPlugIn2](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn2) +* [TradeStudyPlugIn::ITradeStudyPlugIn3](interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3.md#interfaceTradeStudyPlugIn_1_1ITradeStudyPlugIn3) +* [TradeStudyPlugIn::IVariableMetaDataProvider](interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider.md#interfaceTradeStudyPlugIn_1_1IVariableMetaDataProvider) +* [TradeStudyPlugIn::IWindowed](interfaceTradeStudyPlugIn_1_1IWindowed.md#interfaceTradeStudyPlugIn_1_1IWindowed) +* [TradeStudyPlugIn::TradeStudyPlugIn](classTradeStudyPlugIn_1_1TradeStudyPlugIn.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn) +* [TradeStudyPlugIn::TradeStudyPlugIn2](classTradeStudyPlugIn_1_1TradeStudyPlugIn2.md#classTradeStudyPlugIn_1_1TradeStudyPlugIn2) + +## Functions + + +### Function importlib + +![][public] + +``` +TradeStudyPlugIn::importlib("stdole32.tlb") +``` + + + + + + + +**Parameters**: + +* "stdole32.tlb" + +**Return type**: + + +### Function importlib + +![][public] + +``` +TradeStudyPlugIn::importlib("stdole2.tlb") +``` + + + + + + + +**Parameters**: + +* "stdole2.tlb" + +**Return type**: + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespace_contents.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespace_contents.md index 78b8b0c84c..20fed1e61b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespace_contents.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespace_contents.md @@ -1,8 +1,8 @@ -# Namespaces - -* [ComponentPlugIn](namespaceComponentPlugIn.md#namespaceComponentPlugIn) -* [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) -* [PHXDATAEXPLORERLib](namespacePHXDATAEXPLORERLib.md#namespacePHXDATAEXPLORERLib) -* [PHXDATAHISTORYLib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib) -* [PlugInMetaData](namespacePlugInMetaData.md#namespacePlugInMetaData) +# Namespaces + +* [ComponentPlugIn](namespaceComponentPlugIn.md#namespaceComponentPlugIn) +* [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) +* [PHXDATAEXPLORERLib](namespacePHXDATAEXPLORERLib.md#namespacePHXDATAEXPLORERLib) +* [PHXDATAHISTORYLib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib) +* [PlugInMetaData](namespacePlugInMetaData.md#namespacePlugInMetaData) * [TradeStudyPlugIn](namespaceTradeStudyPlugIn.md#namespaceTradeStudyPlugIn) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespace_index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespace_index.md index e36a43b270..05e4a2465c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespace_index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/namespace_index.md @@ -1,19 +1,19 @@ -# Index of Namespaces - -## C - -* [ComponentPlugIn](namespaceComponentPlugIn.md#namespaceComponentPlugIn) - -## M - -* [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) - -## P - -* [PHXDATAEXPLORERLib](namespacePHXDATAEXPLORERLib.md#namespacePHXDATAEXPLORERLib) -* [PHXDATAHISTORYLib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib) -* [PlugInMetaData](namespacePlugInMetaData.md#namespacePlugInMetaData) - -## T - +# Index of Namespaces + +## C + +* [ComponentPlugIn](namespaceComponentPlugIn.md#namespaceComponentPlugIn) + +## M + +* [ModelCenter](namespaceModelCenter.md#namespaceModelCenter) + +## P + +* [PHXDATAEXPLORERLib](namespacePHXDATAEXPLORERLib.md#namespacePHXDATAEXPLORERLib) +* [PHXDATAHISTORYLib](namespacePHXDATAHISTORYLib.md#namespacePHXDATAHISTORYLib) +* [PlugInMetaData](namespacePlugInMetaData.md#namespacePlugInMetaData) + +## T + * [TradeStudyPlugIn](namespaceTradeStudyPlugIn.md#namespaceTradeStudyPlugIn) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/page_contents.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/page_contents.md index 0c186cb8f2..83c282e725 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/page_contents.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/page_contents.md @@ -1,3 +1,3 @@ -# Pages - +# Pages + * [Deprecated List](deprecated.md#deprecated) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/page_index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/page_index.md index b03facc426..871df27f96 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/page_index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/page_index.md @@ -1,5 +1,5 @@ -# Index of Pages - -## D - +# Index of Pages + +## D + * [Deprecated List](deprecated.md#deprecated) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md index 911a1d7bfc..2cf2fb5426 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md @@ -1,340 +1,339 @@ - -# Structure PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 30) - - - -The [DataHistoryVariableMetadataStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct) is used to store the metadata for a variable. - -## Members - -* [customMetadata](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a5e4dfb223db7287d798efb5b8078a3e2) -* [enumAliases](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1ab0241db307b35f1e5d19adbd2d1f17df) -* [enumValues](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a3388bf5cf3b1f7de69b343b81669e6ff) -* [equation](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a32fdc64aa5113896a4a962a5c3cbaf93) -* [fileName](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1aa624273f5c3fb5af9baa0272caa971e0) -* [format](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a5d2b591cdaa6ce26e344f11ab6e1b76f) -* [geomScript](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a8f89e59faab48afc96e4a0dde2f457c3) -* [isBinary](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a121de67cd4278a5b008d416a2579bcf0) -* [isDesignVar](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a09f46ea4820a3341554e2bad9a052f7e) -* [isInput](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a1f4709d547b2d872fd404f7fc5b6566a) -* [isNumeric](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1ae0822979f6b70670a347c98c67d367b2) -* [lowerBound](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1aa8335d587fd45435098d82f59751071d) -* [name](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a539d4b4f21c4c53505a6c39534fb2c3f) -* [type](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1ab613172a10fa02c2756813e75944536a) -* [units](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a48e1dedfd188d030f71a196434ebaf3b) -* [upperBound](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1aeda7394339c56c5493cfad15d26b0b3e) - -## Public attributes - - -### Variable name - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 35) - -``` -BSTR PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::name -``` - - - -The name of the variable - - - -**Type**: BSTR - - -### Variable isNumeric - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 39) - -``` -boolean PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::isNumeric -``` - - - -true if the variable is numeric, false otherwise - - - -**Type**: boolean - - -### Variable isInput - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 43) - -``` -boolean PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::isInput -``` - - - -true if the variable is an input, false otherwise - - - -**Type**: boolean - - -### Variable isBinary - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 47) - -``` -boolean PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::isBinary -``` - - - -true if file variable is a binary file, false otherwise - - - -**Type**: boolean - - -### Variable isDesignVar - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 51) - -``` -boolean PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::isDesignVar -``` - - - -true if the variable is a design variable, false otherwise - - - -**Type**: boolean - - -### Variable equation - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 55) - -``` -BSTR PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::equation -``` - - - -The equation of the variable - - - -**Type**: BSTR - - -### Variable format - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 59) - -``` -BSTR PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::format -``` - - - -The format of the variable - - - -**Type**: BSTR - - -### Variable type - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 63) - -``` -BSTR PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::type -``` - - - -The type of the variable - - - -**Type**: BSTR - - -### Variable units - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 67) - -``` -BSTR PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::units -``` - - - -The units of the variable - - - -**Type**: BSTR - - -### Variable fileName - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 71) - -``` -BSTR PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::fileName -``` - - - -The filename of a file variable - - - -**Type**: BSTR - - -### Variable geomScript - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 75) - -``` -BSTR PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::geomScript -``` - - - -The geomScript of the variable - - - -**Type**: BSTR - - -### Variable enumValues - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 79) - -``` -BSTR PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::enumValues -``` - - - -comma separated list of enumerated values of variable - - - -**Type**: BSTR - - -### Variable enumAliases - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 83) - -``` -BSTR PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::enumAliases -``` - - - -comma separated list of enumerated aliases of variable - - - -**Type**: BSTR - - -### Variable lowerBound - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 87) - -``` -VARIANT PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::lowerBound -``` - - - -The lower bound of the variable - - - -**Type**: VARIANT - - -### Variable upperBound - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 91) - -``` -VARIANT PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::upperBound -``` - - - -The upper bound of the variable - - - -**Type**: VARIANT - - -### Variable customMetadata - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 95) - -``` -VARIANT PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::customMetadata -``` - - - -2xN SAFEARRAY of name/value pairs of the custom metadata - - - -**Type**: VARIANT - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Structure PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 30) + + + +The [DataHistoryVariableMetadataStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct) is used to store the metadata for a variable. + +## Members + +* [customMetadata](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a5e4dfb223db7287d798efb5b8078a3e2) +* [enumAliases](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1ab0241db307b35f1e5d19adbd2d1f17df) +* [enumValues](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a3388bf5cf3b1f7de69b343b81669e6ff) +* [equation](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a32fdc64aa5113896a4a962a5c3cbaf93) +* [fileName](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1aa624273f5c3fb5af9baa0272caa971e0) +* [format](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a5d2b591cdaa6ce26e344f11ab6e1b76f) +* [geomScript](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a8f89e59faab48afc96e4a0dde2f457c3) +* [isBinary](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a121de67cd4278a5b008d416a2579bcf0) +* [isDesignVar](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a09f46ea4820a3341554e2bad9a052f7e) +* [isInput](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a1f4709d547b2d872fd404f7fc5b6566a) +* [isNumeric](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1ae0822979f6b70670a347c98c67d367b2) +* [lowerBound](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1aa8335d587fd45435098d82f59751071d) +* [name](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a539d4b4f21c4c53505a6c39534fb2c3f) +* [type](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1ab613172a10fa02c2756813e75944536a) +* [units](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1a48e1dedfd188d030f71a196434ebaf3b) +* [upperBound](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct_1aeda7394339c56c5493cfad15d26b0b3e) + +## Public attributes + + +### Variable name + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 35) + +``` +BSTR PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::name +``` + + + +The name of the variable + + + +**Type**: BSTR + + +### Variable isNumeric + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 39) + +``` +boolean PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::isNumeric +``` + + + +true if the variable is numeric, false otherwise + + + +**Type**: boolean + + +### Variable isInput + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 43) + +``` +boolean PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::isInput +``` + + + +true if the variable is an input, false otherwise + + + +**Type**: boolean + + +### Variable isBinary + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 47) + +``` +boolean PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::isBinary +``` + + + +true if file variable is a binary file, false otherwise + + + +**Type**: boolean + + +### Variable isDesignVar + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 51) + +``` +boolean PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::isDesignVar +``` + + + +true if the variable is a design variable, false otherwise + + + +**Type**: boolean + + +### Variable equation + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 55) + +``` +BSTR PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::equation +``` + + + +The equation of the variable + + + +**Type**: BSTR + + +### Variable format + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 59) + +``` +BSTR PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::format +``` + + + +The format of the variable + + + +**Type**: BSTR + + +### Variable type + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 63) + +``` +BSTR PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::type +``` + + + +The type of the variable + + + +**Type**: BSTR + + +### Variable units + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 67) + +``` +BSTR PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::units +``` + + + +The units of the variable + + + +**Type**: BSTR + + +### Variable fileName + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 71) + +``` +BSTR PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::fileName +``` + + + +The filename of a file variable + + + +**Type**: BSTR + + +### Variable geomScript + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 75) + +``` +BSTR PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::geomScript +``` + + + +The geomScript of the variable + + + +**Type**: BSTR + + +### Variable enumValues + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 79) + +``` +BSTR PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::enumValues +``` + + + +comma separated list of enumerated values of variable + + + +**Type**: BSTR + + +### Variable enumAliases + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 83) + +``` +BSTR PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::enumAliases +``` + + + +comma separated list of enumerated aliases of variable + + + +**Type**: BSTR + + +### Variable lowerBound + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 87) + +``` +VARIANT PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::lowerBound +``` + + + +The lower bound of the variable + + + +**Type**: VARIANT + + +### Variable upperBound + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 91) + +``` +VARIANT PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::upperBound +``` + + + +The upper bound of the variable + + + +**Type**: VARIANT + + +### Variable customMetadata + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 95) + +``` +VARIANT PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct::customMetadata +``` + + + +2xN SAFEARRAY of name/value pairs of the custom metadata + + + +**Type**: VARIANT + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md index 6f0f97cc33..00695198df 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md @@ -1,120 +1,119 @@ - -# Structure PHXDATAHISTORYLib::DataHistoryVariableStruct - -![][IDL] -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 105) - - - -The [DataHistoryVariableStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct) is used to store the data and metadata for a variable. used by addVariableStruct - -## Members - -* [index](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a331317f8f767933429cce81e8ada5385) -* [isModified](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a0e1c5e9cd74d1f2516fc1d35eea45b17) -* [isValid](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a55153c5a8cc53d611839b0b55bb3e8a2) -* [metadata](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1adad4bb3cc571df3df8a8df37d634fe72) -* [varValue](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a44619a37f14a5ff181483dcf993d1424) - -## Public attributes - - -### Variable index - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 110) - -``` -VARIANT PHXDATAHISTORYLib::DataHistoryVariableStruct::index -``` - - - -Either a 0 based index to the Variable, or the name of a Variable. - - - -**Type**: VARIANT - - -### Variable varValue - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 114) - -``` -VARIANT PHXDATAHISTORYLib::DataHistoryVariableStruct::varValue -``` - - - -The value of the Variable. - - - -**Type**: VARIANT - - -### Variable isValid - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 118) - -``` -boolean PHXDATAHISTORYLib::DataHistoryVariableStruct::isValid -``` - - - -Whether this value is valid. - - - -**Type**: boolean - - -### Variable isModified - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 122) - -``` -boolean PHXDATAHISTORYLib::DataHistoryVariableStruct::isModified -``` - - - -Whether this value's modified flag is set. - - - -**Type**: boolean - - -### Variable metadata - -![][public] - -**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 126) - -``` -DataHistoryVariableMetadataStruct PHXDATAHISTORYLib::DataHistoryVariableStruct::metadata -``` - - - -The metadata for the Variable - - - -**Type**: [DataHistoryVariableMetadataStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct) - -[public]: https://img.shields.io/badge/-public-brightgreen (public) -[private]: https://img.shields.io/badge/-private-red (private) +# Structure PHXDATAHISTORYLib::DataHistoryVariableStruct + +![][IDL] +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 105) + + + +The [DataHistoryVariableStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct) is used to store the data and metadata for a variable. used by addVariableStruct + +## Members + +* [index](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a331317f8f767933429cce81e8ada5385) +* [isModified](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a0e1c5e9cd74d1f2516fc1d35eea45b17) +* [isValid](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a55153c5a8cc53d611839b0b55bb3e8a2) +* [metadata](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1adad4bb3cc571df3df8a8df37d634fe72) +* [varValue](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct_1a44619a37f14a5ff181483dcf993d1424) + +## Public attributes + + +### Variable index + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 110) + +``` +VARIANT PHXDATAHISTORYLib::DataHistoryVariableStruct::index +``` + + + +Either a 0 based index to the Variable, or the name of a Variable. + + + +**Type**: VARIANT + + +### Variable varValue + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 114) + +``` +VARIANT PHXDATAHISTORYLib::DataHistoryVariableStruct::varValue +``` + + + +The value of the Variable. + + + +**Type**: VARIANT + + +### Variable isValid + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 118) + +``` +boolean PHXDATAHISTORYLib::DataHistoryVariableStruct::isValid +``` + + + +Whether this value is valid. + + + +**Type**: boolean + + +### Variable isModified + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 122) + +``` +boolean PHXDATAHISTORYLib::DataHistoryVariableStruct::isModified +``` + + + +Whether this value's modified flag is set. + + + +**Type**: boolean + + +### Variable metadata + +![][public] + +**Definition**: `LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl` (line 126) + +``` +DataHistoryVariableMetadataStruct PHXDATAHISTORYLib::DataHistoryVariableStruct::metadata +``` + + + +The metadata for the Variable + + + +**Type**: [DataHistoryVariableMetadataStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct) + +[public]: https://img.shields.io/badge/-public-brightgreen (public) +[private]: https://img.shields.io/badge/-private-red (private) [IDL]: https://img.shields.io/badge/language-IDL-blue (IDL) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/struct_contents.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/struct_contents.md index c24b0f6100..4a66d45b67 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/struct_contents.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/struct_contents.md @@ -1,4 +1,4 @@ -# Structures - -* [PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct) +# Structures + +* [PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct) * [PHXDATAHISTORYLib::DataHistoryVariableStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/struct_index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/struct_index.md index 7fab53b6e3..3905469f6c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/struct_index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-api-md/struct_index.md @@ -1,6 +1,6 @@ -# Index of Structures - -## P - -* [PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct) +# Index of Structures + +## P + +* [PHXDATAHISTORYLib::DataHistoryVariableMetadataStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableMetadataStruct) * [PHXDATAHISTORYLib::DataHistoryVariableStruct](structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct.md#structPHXDATAHISTORYLib_1_1DataHistoryVariableStruct) \ No newline at end of file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/index.md index 7ce02f5bf1..fac17029ec 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/index.md @@ -1,12 +1,10 @@ -//[mc_api](index.md) - -# mc_api - -## Packages - -| Name | -|---| -| [com.phoenix_int.ModelCenter](mc_api/com.phoenix_int.ModelCenter/index.md) | -| [com.phoenix_int.ModelCenter.Geometry](mc_api/com.phoenix_int.ModelCenter.Geometry/index.md) | -| [com.phoenix_int.ModelCenter.logging](mc_api/com.phoenix_int.ModelCenter.logging/index.md) | -| [com.phoenix_int.ModelCenter.util](mc_api/com.phoenix_int.ModelCenter.util/index.md) | +# mc_api + +## Packages + +| Name | +|---| +| [com.phoenix_int.ModelCenter](mc_api/com.phoenix_int.ModelCenter/index.md) | +| [com.phoenix_int.ModelCenter.Geometry](mc_api/com.phoenix_int.ModelCenter.Geometry/index.md) | +| [com.phoenix_int.ModelCenter.logging](mc_api/com.phoenix_int.ModelCenter.logging/index.md) | +| [com.phoenix_int.ModelCenter.util](mc_api/com.phoenix_int.ModelCenter.util/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/-a-w-t-exception-handler.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/-a-w-t-exception-handler.md index 4f1305e093..c5399c233e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/-a-w-t-exception-handler.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/-a-w-t-exception-handler.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.Geometry](../index.md)/[AWTExceptionHandler](index.md)/[AWTExceptionHandler](-a-w-t-exception-handler.md) - -# AWTExceptionHandler - - -constructor() +# AWTExceptionHandler + + +constructor() diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/handle.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/handle.md index ba18aa7a69..06c0d6bb56 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/handle.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/handle.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.Geometry](../index.md)/[AWTExceptionHandler](index.md)/[handle](handle.md) - -# handle - - -public [handle](handle.md)(ex: [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html)) +# handle + + +public [handle](handle.md)(ex: [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/index.md index 2ffecb2aa3..6795844899 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/index.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.Geometry](../index.md)/[AWTExceptionHandler](index.md) - -# AWTExceptionHandler - - -public class [AWTExceptionHandler](index.md) - -#### Author - -bschoenfeld - -## Constructors - -| | | -|---|---| -| [AWTExceptionHandler](-a-w-t-exception-handler.md) | constructor() | - -## Functions - -| Name | Summary | -|---|---| -| [handle](handle.md) | public [handle](handle.md)(ex: [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html)) | -| [register](register.md) | public [register](register.md)() | +# AWTExceptionHandler + + +public class [AWTExceptionHandler](index.md) + +#### Author + +bschoenfeld + +## Constructors + +| | | +|---|---| +| [AWTExceptionHandler](-a-w-t-exception-handler.md) | constructor() | + +## Functions + +| Name | Summary | +|---|---| +| [handle](handle.md) | public [handle](handle.md)(ex: [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html)) | +| [register](register.md) | public [register](register.md)() | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/register.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/register.md index 494e6add1c..e467a673c8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/register.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/register.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.Geometry](../index.md)/[AWTExceptionHandler](index.md)/[register](register.md) - -# register - - -public [register](register.md)() +# register + + +public [register](register.md)() diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/-p-h-x-j-o-g-l.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/-p-h-x-j-o-g-l.md index ad31edbaa5..fd9fa00a4f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/-p-h-x-j-o-g-l.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/-p-h-x-j-o-g-l.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.Geometry](../index.md)/[PHXJOGL](index.md)/[PHXJOGL](-p-h-x-j-o-g-l.md) - -# PHXJOGL - - -constructor() - -Creates a new instance of MC_JOGL +# PHXJOGL + + +constructor() + +Creates a new instance of MC_JOGL diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/create-list.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/create-list.md index a27678ac4f..1b22494a46 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/create-list.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/create-list.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.Geometry](../index.md)/[PHXJOGL](index.md)/[createList](create-list.md) - -# createList - - -public [createList](create-list.md)(path: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), dir: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), scriptName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)> +# createList + + +public [createList](create-list.md)(path: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), dir: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), scriptName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)> diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/get-exts.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/get-exts.md index ca17c8f89e..0234909a94 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/get-exts.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/get-exts.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.Geometry](../index.md)/[PHXJOGL](index.md)/[getExts](get-exts.md) - -# getExts - - -public [getExts](get-exts.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> +# getExts + + +public [getExts](get-exts.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/index.md index ca71f78a37..f9fc5a4485 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/index.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.Geometry](../index.md)/[PHXJOGL](index.md) - -# PHXJOGL - - -public class [PHXJOGL](index.md) - -## Constructors - -| | | -|---|---| -| [PHXJOGL](-p-h-x-j-o-g-l.md) | constructor()
Creates a new instance of MC_JOGL | - -## Functions - -| Name | Summary | -|---|---| -| [createList](create-list.md) | public [createList](create-list.md)(path: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), dir: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), scriptName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)> | -| [getExts](get-exts.md) | public [getExts](get-exts.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> | -| [loadScripts](load-scripts.md) | public [loadScripts](load-scripts.md)(dir: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> | +# PHXJOGL + + +public class [PHXJOGL](index.md) + +## Constructors + +| | | +|---|---| +| [PHXJOGL](-p-h-x-j-o-g-l.md) | constructor()
Creates a new instance of MC_JOGL | + +## Functions + +| Name | Summary | +|---|---| +| [createList](create-list.md) | public [createList](create-list.md)(path: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), dir: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), scriptName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)> | +| [getExts](get-exts.md) | public [getExts](get-exts.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> | +| [loadScripts](load-scripts.md) | public [loadScripts](load-scripts.md)(dir: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/load-scripts.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/load-scripts.md index 480c8b64ae..123e007a22 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/load-scripts.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/load-scripts.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.Geometry](../index.md)/[PHXJOGL](index.md)/[loadScripts](load-scripts.md) - -# loadScripts - - -public [loadScripts](load-scripts.md)(dir: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> +# loadScripts + + +public [loadScripts](load-scripts.md)(dir: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/index.md index 9cc94d9162..5db0995cf5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.Geometry/index.md @@ -1,10 +1,8 @@ -//[mc_api](../../index.md)/[com.phoenix_int.ModelCenter.Geometry](index.md) - -# Package-level declarations - -## Types - -| Name | Summary | -|---|---| -| [AWTExceptionHandler](-a-w-t-exception-handler/index.md) | public class [AWTExceptionHandler](-a-w-t-exception-handler/index.md) | -| [PHXJOGL](-p-h-x-j-o-g-l/index.md) | public class [PHXJOGL](-p-h-x-j-o-g-l/index.md) | +# Package-level declarations + +## Types + +| Name | Summary | +|---|---| +| [AWTExceptionHandler](-a-w-t-exception-handler/index.md) | public class [AWTExceptionHandler](-a-w-t-exception-handler/index.md) | +| [PHXJOGL](-p-h-x-j-o-g-l/index.md) | public class [PHXJOGL](-p-h-x-j-o-g-l/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/-logger.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/-logger.md index 314e93c843..77e0f936ab 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/-logger.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/-logger.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.logging](../index.md)/[Logger](index.md)/[Logger](-logger.md) - -# Logger - - -constructor(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -FOR INTERNAL USE ONLY +# Logger + + +constructor(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +FOR INTERNAL USE ONLY diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/debug.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/debug.md index dbbb89b5a9..f2e2d845f3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/debug.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/debug.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.logging](../index.md)/[Logger](index.md)/[debug](debug.md) - -# debug - - -public [debug](debug.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Logs a message at the DEBUG level - -#### Parameters - - - -| | | -|---|---| -| msg | the log message | - -#### Throws - -| | -|---| -| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | +# debug + + +public [debug](debug.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Logs a message at the DEBUG level + +#### Parameters + + + +| | | +|---|---| +| msg | the log message | + +#### Throws + +| | +|---| +| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/error.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/error.md index 6a0a5cebb6..7c25ac62f9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/error.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/error.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.logging](../index.md)/[Logger](index.md)/[error](error.md) - -# error - - -public [error](error.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Logs a message at the ERROR level - -#### Parameters - - - -| | | -|---|---| -| msg | the log message | - -#### Throws - -| | -|---| -| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | +# error + + +public [error](error.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Logs a message at the ERROR level + +#### Parameters + + + +| | | +|---|---| +| msg | the log message | + +#### Throws + +| | +|---| +| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/index.md index 475009fefe..726e9c5069 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/index.md @@ -1,35 +1,33 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.logging](../index.md)/[Logger](index.md) - -# Logger - - -public class [Logger](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -This is the wrapper class that handles the native COM calls to a Logger object. - -#### Author - -jdaley, 3-10 - -## Constructors - -| | | -|---|---| -| [Logger](-logger.md) | constructor(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
FOR INTERNAL USE ONLY | - -## Functions - -| Name | Summary | -|---|---| -| [debug](debug.md) | public [debug](debug.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Logs a message at the DEBUG level | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [error](error.md) | public [error](error.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Logs a message at the ERROR level | -| [info](info.md) | public [info](info.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Logs a message at the INFO level | -| [isDebugEnabled](is-debug-enabled.md) | public [isDebugEnabled](is-debug-enabled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks if the DEBUG level is enabled | -| [isErrorEnabled](is-error-enabled.md) | public [isErrorEnabled](is-error-enabled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks if the ERROR level is enabled | -| [isInfoEnabled](is-info-enabled.md) | public [isInfoEnabled](is-info-enabled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks if the INFO level is enabled | -| [isWarnEnabled](is-warn-enabled.md) | public [isWarnEnabled](is-warn-enabled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks if the WARN level is enabled | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [warn](warn.md) | public [warn](warn.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Logs a message at the WARN level | +# Logger + + +public class [Logger](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +This is the wrapper class that handles the native COM calls to a Logger object. + +#### Author + +jdaley, 3-10 + +## Constructors + +| | | +|---|---| +| [Logger](-logger.md) | constructor(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
FOR INTERNAL USE ONLY | + +## Functions + +| Name | Summary | +|---|---| +| [debug](debug.md) | public [debug](debug.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Logs a message at the DEBUG level | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [error](error.md) | public [error](error.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Logs a message at the ERROR level | +| [info](info.md) | public [info](info.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Logs a message at the INFO level | +| [isDebugEnabled](is-debug-enabled.md) | public [isDebugEnabled](is-debug-enabled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks if the DEBUG level is enabled | +| [isErrorEnabled](is-error-enabled.md) | public [isErrorEnabled](is-error-enabled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks if the ERROR level is enabled | +| [isInfoEnabled](is-info-enabled.md) | public [isInfoEnabled](is-info-enabled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks if the INFO level is enabled | +| [isWarnEnabled](is-warn-enabled.md) | public [isWarnEnabled](is-warn-enabled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks if the WARN level is enabled | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [warn](warn.md) | public [warn](warn.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Logs a message at the WARN level | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/info.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/info.md index 1b144a826d..54d2968891 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/info.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/info.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.logging](../index.md)/[Logger](index.md)/[info](info.md) - -# info - - -public [info](info.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Logs a message at the INFO level - -#### Parameters - - - -| | | -|---|---| -| msg | the log message | - -#### Throws - -| | -|---| -| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | +# info + + +public [info](info.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Logs a message at the INFO level + +#### Parameters + + + +| | | +|---|---| +| msg | the log message | + +#### Throws + +| | +|---| +| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-debug-enabled.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-debug-enabled.md index e040fe81cd..af8f04c8c7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-debug-enabled.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-debug-enabled.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.logging](../index.md)/[Logger](index.md)/[isDebugEnabled](is-debug-enabled.md) - -# isDebugEnabled - - -public [isDebugEnabled](is-debug-enabled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -checks if the DEBUG level is enabled - -#### Return - -bool if the level is enabled - -#### Throws - -| | -|---| -| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | +# isDebugEnabled + + +public [isDebugEnabled](is-debug-enabled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +checks if the DEBUG level is enabled + +#### Return + +bool if the level is enabled + +#### Throws + +| | +|---| +| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-error-enabled.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-error-enabled.md index 757895691f..cfdfb0368c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-error-enabled.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-error-enabled.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.logging](../index.md)/[Logger](index.md)/[isErrorEnabled](is-error-enabled.md) - -# isErrorEnabled - - -public [isErrorEnabled](is-error-enabled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -checks if the ERROR level is enabled - -#### Return - -bool if the level is enabled - -#### Throws - -| | -|---| -| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | +# isErrorEnabled + + +public [isErrorEnabled](is-error-enabled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +checks if the ERROR level is enabled + +#### Return + +bool if the level is enabled + +#### Throws + +| | +|---| +| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-info-enabled.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-info-enabled.md index 9daa5ffa55..b991ca2c78 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-info-enabled.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-info-enabled.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.logging](../index.md)/[Logger](index.md)/[isInfoEnabled](is-info-enabled.md) - -# isInfoEnabled - - -public [isInfoEnabled](is-info-enabled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -checks if the INFO level is enabled - -#### Return - -bool if the level is enabled - -#### Throws - -| | -|---| -| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | +# isInfoEnabled + + +public [isInfoEnabled](is-info-enabled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +checks if the INFO level is enabled + +#### Return + +bool if the level is enabled + +#### Throws + +| | +|---| +| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-warn-enabled.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-warn-enabled.md index fd693a8dae..5accfb8385 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-warn-enabled.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-warn-enabled.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.logging](../index.md)/[Logger](index.md)/[isWarnEnabled](is-warn-enabled.md) - -# isWarnEnabled - - -public [isWarnEnabled](is-warn-enabled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -checks if the WARN level is enabled - -#### Return - -bool if the level is enabled - -#### Throws - -| | -|---| -| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | +# isWarnEnabled + + +public [isWarnEnabled](is-warn-enabled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +checks if the WARN level is enabled + +#### Return + +bool if the level is enabled + +#### Throws + +| | +|---| +| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/warn.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/warn.md index baacfa6b2c..76ee22c7bc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/warn.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/-logger/warn.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.logging](../index.md)/[Logger](index.md)/[warn](warn.md) - -# warn - - -public [warn](warn.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Logs a message at the WARN level - -#### Parameters - - - -| | | -|---|---| -| msg | the log message | - -#### Throws - -| | -|---| -| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | +# warn + + +public [warn](warn.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Logs a message at the WARN level + +#### Parameters + + + +| | | +|---|---| +| msg | the log message | + +#### Throws + +| | +|---| +| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/index.md index b8cb92ec09..3ea7549347 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.logging/index.md @@ -1,9 +1,7 @@ -//[mc_api](../../index.md)/[com.phoenix_int.ModelCenter.logging](index.md) - -# Package-level declarations - -## Types - -| Name | Summary | -|---|---| -| [Logger](-logger/index.md) | public class [Logger](-logger/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a Logger object. | +# Package-level declarations + +## Types + +| Name | Summary | +|---|---| +| [Logger](-logger/index.md) | public class [Logger](-logger/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a Logger object. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-beanshell-util/-beanshell-util.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-beanshell-util/-beanshell-util.md index 8e5c15eebe..76714378fd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-beanshell-util/-beanshell-util.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-beanshell-util/-beanshell-util.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[BeanshellUtil](index.md)/[BeanshellUtil](-beanshell-util.md) - -# BeanshellUtil - - -constructor() +# BeanshellUtil + + +constructor() diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-beanshell-util/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-beanshell-util/index.md index 68ac512e7a..0a4cb400ea 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-beanshell-util/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-beanshell-util/index.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[BeanshellUtil](index.md) - -# BeanshellUtil - - -public class [BeanshellUtil](index.md) - -Utility class to execute any arbitrary Beanshell script from native code and return an object that can be accessed via JNI. - -#### Author - -mbelcher - -## Constructors - -| | | -|---|---| -| [BeanshellUtil](-beanshell-util.md) | constructor() | - -## Functions - -| Name | Summary | -|---|---| -| [runScript](run-script.md) | public [runScript](run-script.md)(bshScript: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), arg: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Run the specified string as a beanshell script TODO in future: support passing in more than one argument. | +# BeanshellUtil + + +public class [BeanshellUtil](index.md) + +Utility class to execute any arbitrary Beanshell script from native code and return an object that can be accessed via JNI. + +#### Author + +mbelcher + +## Constructors + +| | | +|---|---| +| [BeanshellUtil](-beanshell-util.md) | constructor() | + +## Functions + +| Name | Summary | +|---|---| +| [runScript](run-script.md) | public [runScript](run-script.md)(bshScript: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), arg: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Run the specified string as a beanshell script TODO in future: support passing in more than one argument. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-beanshell-util/run-script.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-beanshell-util/run-script.md index 5ef6d8e2a7..ee3d7008b1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-beanshell-util/run-script.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-beanshell-util/run-script.md @@ -1,27 +1,25 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[BeanshellUtil](index.md)/[runScript](run-script.md) - -# runScript - - -public [runScript](run-script.md)(bshScript: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), arg: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -Run the specified string as a beanshell script TODO in future: support passing in more than one argument. - -#### Return - -An object containing the result of the script. - -#### Parameters - - - -| | | -|---|---| -| bshScript | the string to run through the BSH interpreter. | -| arg | An argument to be passed in to the script. Should be referred to in the script by the name "arg". | - -#### Throws - -| | | -|---|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | if something goes wrong while executing the script | +# runScript + + +public [runScript](run-script.md)(bshScript: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), arg: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Run the specified string as a beanshell script TODO in future: support passing in more than one argument. + +#### Return + +An object containing the result of the script. + +#### Parameters + + + +| | | +|---|---| +| bshScript | the string to run through the BSH interpreter. | +| arg | An argument to be passed in to the script. Should be referred to in the script by the name "arg". | + +#### Throws + +| | | +|---|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | if something goes wrong while executing the script | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/-logger-updater.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/-logger-updater.md index 73ac0114a1..e2b117a79d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/-logger-updater.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/-logger-updater.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[LoggerUpdater](index.md)/[LoggerUpdater](-logger-updater.md) - -# LoggerUpdater - - -constructor(logger: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -Constructs this logger wrapper and instantiates underlying Logback logger - -#### Parameters - - - -| | | -|---|---| -| logger | - Pointer to UTIL/Logger object | +# LoggerUpdater + + +constructor(logger: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +Constructs this logger wrapper and instantiates underlying Logback logger + +#### Parameters + + + +| | | +|---|---| +| logger | - Pointer to UTIL/Logger object | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/index.md index 280ea6213a..763d42cd8a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/index.md @@ -1,29 +1,27 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[LoggerUpdater](index.md) - -# LoggerUpdater - - -public class [LoggerUpdater](index.md) - -This class is called by the Java logging infrastructure to notify the the C++ logger it update its local logging level. This way, we don't have to make a JNI call to check the logging level for each logging call. see UTIL/PHXLogger.h - -#### Author - -jdaley, 2010 - -## Constructors - -| | | -|---|---| -| [LoggerUpdater](-logger-updater.md) | constructor(logger: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Constructs this logger wrapper and instantiates underlying Logback logger | - -## Functions - -| Name | Summary | -|---|---| -| [isResetResistant](is-reset-resistant.md) | public [isResetResistant](is-reset-resistant.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
continue to listen even after reset | -| [onLevelChange](on-level-change.md) | public [onLevelChange](on-level-change.md)(logger: Logger, level: Level) | -| [onReset](on-reset.md) | public [onReset](on-reset.md)(context: LoggerContext)
reset logger | -| [onStart](on-start.md) | public [onStart](on-start.md)(context: LoggerContext)
reset logger | -| [onStop](on-stop.md) | public [onStop](on-stop.md)(context: LoggerContext)
do nothing | -| [stop](stop.md) | public [stop](stop.md)()
stop listening. | +# LoggerUpdater + + +public class [LoggerUpdater](index.md) + +This class is called by the Java logging infrastructure to notify the the C++ logger it update its local logging level. This way, we don't have to make a JNI call to check the logging level for each logging call. see UTIL/PHXLogger.h + +#### Author + +jdaley, 2010 + +## Constructors + +| | | +|---|---| +| [LoggerUpdater](-logger-updater.md) | constructor(logger: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Constructs this logger wrapper and instantiates underlying Logback logger | + +## Functions + +| Name | Summary | +|---|---| +| [isResetResistant](is-reset-resistant.md) | public [isResetResistant](is-reset-resistant.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
continue to listen even after reset | +| [onLevelChange](on-level-change.md) | public [onLevelChange](on-level-change.md)(logger: Logger, level: Level) | +| [onReset](on-reset.md) | public [onReset](on-reset.md)(context: LoggerContext)
reset logger | +| [onStart](on-start.md) | public [onStart](on-start.md)(context: LoggerContext)
reset logger | +| [onStop](on-stop.md) | public [onStop](on-stop.md)(context: LoggerContext)
do nothing | +| [stop](stop.md) | public [stop](stop.md)()
stop listening. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/is-reset-resistant.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/is-reset-resistant.md index 4be7faaf35..bf6d2ef1fb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/is-reset-resistant.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/is-reset-resistant.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[LoggerUpdater](index.md)/[isResetResistant](is-reset-resistant.md) - -# isResetResistant - - -public [isResetResistant](is-reset-resistant.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -continue to listen even after reset - -#### Return - -true +# isResetResistant + + +public [isResetResistant](is-reset-resistant.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +continue to listen even after reset + +#### Return + +true diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-level-change.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-level-change.md index c169e99ea7..dddf09961d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-level-change.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-level-change.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[LoggerUpdater](index.md)/[onLevelChange](on-level-change.md) - -# onLevelChange - - -public [onLevelChange](on-level-change.md)(logger: Logger, level: Level) +# onLevelChange + + +public [onLevelChange](on-level-change.md)(logger: Logger, level: Level) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-reset.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-reset.md index d944a529fe..ee8888d73f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-reset.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-reset.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[LoggerUpdater](index.md)/[onReset](on-reset.md) - -# onReset - - -public [onReset](on-reset.md)(context: LoggerContext) - -reset logger - -#### Parameters - - - -| | -|---| -| context | +# onReset + + +public [onReset](on-reset.md)(context: LoggerContext) + +reset logger + +#### Parameters + + + +| | +|---| +| context | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-start.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-start.md index a55fedc5eb..75dbac4655 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-start.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-start.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[LoggerUpdater](index.md)/[onStart](on-start.md) - -# onStart - - -public [onStart](on-start.md)(context: LoggerContext) - -reset logger - -#### Parameters - - - -| | -|---| -| context | +# onStart + + +public [onStart](on-start.md)(context: LoggerContext) + +reset logger + +#### Parameters + + + +| | +|---| +| context | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-stop.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-stop.md index d99d773c6f..baffaf7d68 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-stop.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-stop.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[LoggerUpdater](index.md)/[onStop](on-stop.md) - -# onStop - - -public [onStop](on-stop.md)(context: LoggerContext) - -do nothing - -#### Parameters - - - -| | -|---| -| context | +# onStop + + +public [onStop](on-stop.md)(context: LoggerContext) + +do nothing + +#### Parameters + + + +| | +|---| +| context | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/stop.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/stop.md index 6216c9777c..e9c5357295 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/stop.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/stop.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[LoggerUpdater](index.md)/[stop](stop.md) - -# stop - - -public [stop](stop.md)() - -stop listening. MUST BE CALLED BEFORE FREEING MEMORY WHEN USING THIS CLASS OVER JNI +# stop + + +public [stop](stop.md)() + +stop listening. MUST BE CALLED BEFORE FREEING MEMORY WHEN USING THIS CLASS OVER JNI diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/-p-h-x-c-o-m-object-holder.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/-p-h-x-c-o-m-object-holder.md index ee67aec11e..2e6f9c6e4c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/-p-h-x-c-o-m-object-holder.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/-p-h-x-c-o-m-object-holder.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXCOMObjectHolder](index.md)/[PHXCOMObjectHolder](-p-h-x-c-o-m-object-holder.md) - -# PHXCOMObjectHolder - - -constructor() +# PHXCOMObjectHolder + + +constructor() diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/get-object.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/get-object.md index c03a04451c..c8eb18eedb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/get-object.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/get-object.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXCOMObjectHolder](index.md)/[getObject](get-object.md) - -# getObject - - -public [getObject](get-object.md)(): [T](index.md) +# getObject + + +public [getObject](get-object.md)(): [T](index.md) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/index.md index 555add1278..86ca64cbf5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/index.md @@ -1,21 +1,19 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXCOMObjectHolder](index.md) - -# PHXCOMObjectHolder - - -public class [PHXCOMObjectHolder](index.md)<[T](index.md) : [PHXCOMObject](../-p-h-x-c-o-m-object/index.md)?> - -## Constructors - -| | | -|---|---| -| [PHXCOMObjectHolder](-p-h-x-c-o-m-object-holder.md) | constructor() | - -## Functions - -| Name | Summary | -|---|---| -| [getObject](get-object.md) | public [getObject](get-object.md)(): [T](index.md) | -| [release](release.md) | public [release](release.md)() | -| [setObjectMain](set-object-main.md) | public [setObjectMain](set-object-main.md)(o: [T](index.md)) | -| [setObjectOther](set-object-other.md) | public [setObjectOther](set-object-other.md)(o: [T](index.md)) | +# PHXCOMObjectHolder + + +public class [PHXCOMObjectHolder](index.md)<[T](index.md) : [PHXCOMObject](../-p-h-x-c-o-m-object/index.md)?> + +## Constructors + +| | | +|---|---| +| [PHXCOMObjectHolder](-p-h-x-c-o-m-object-holder.md) | constructor() | + +## Functions + +| Name | Summary | +|---|---| +| [getObject](get-object.md) | public [getObject](get-object.md)(): [T](index.md) | +| [release](release.md) | public [release](release.md)() | +| [setObjectMain](set-object-main.md) | public [setObjectMain](set-object-main.md)(o: [T](index.md)) | +| [setObjectOther](set-object-other.md) | public [setObjectOther](set-object-other.md)(o: [T](index.md)) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/release.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/release.md index 2e54e77663..ca2da503d5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/release.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/release.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXCOMObjectHolder](index.md)/[release](release.md) - -# release - - -public [release](release.md)() +# release + + +public [release](release.md)() diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/set-object-main.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/set-object-main.md index 5b2968a4e0..af41ec3672 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/set-object-main.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/set-object-main.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXCOMObjectHolder](index.md)/[setObjectMain](set-object-main.md) - -# setObjectMain - - -public [setObjectMain](set-object-main.md)(o: [T](index.md)) +# setObjectMain + + +public [setObjectMain](set-object-main.md)(o: [T](index.md)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/set-object-other.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/set-object-other.md index 593e3e42a6..590c8e835c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/set-object-other.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/set-object-other.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXCOMObjectHolder](index.md)/[setObjectOther](set-object-other.md) - -# setObjectOther - - -public [setObjectOther](set-object-other.md)(o: [T](index.md)) +# setObjectOther + + +public [setObjectOther](set-object-other.md)(o: [T](index.md)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md index a6adce1c45..4ee0fce887 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXCOMObject](index.md)/[disableGC](disable-g-c.md) - -# disableGC - - -public [disableGC](disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -If true, prevents releaseObjects from doing anything. Used for debugging. +# disableGC + + +public [disableGC](disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +If true, prevents releaseObjects from doing anything. Used for debugging. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md index 0ae56e68da..6603e9fafa 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md @@ -1,83 +1,81 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXCOMObject](index.md) - -# PHXCOMObject - -public class [PHXCOMObject](index.md) - -This is a base class for Java objects that mirror ModelCenter COM objects - -#### Author - -Woyak, 10/2001 - -#### Inheritors - -| | -|---| -| [AddToModel](../../com.phoenix_int.ModelCenter/-add-to-model/index.md) | -| [Assembly](../../com.phoenix_int.ModelCenter/-assembly/index.md) | -| [CachePin](../../com.phoenix_int.ModelCenter/-cache-pin/index.md) | -| [Component](../../com.phoenix_int.ModelCenter/-component/index.md) | -| [CustomDesignPoint](../../com.phoenix_int.ModelCenter/-custom-design-point/index.md) | -| [DataCollector](../../com.phoenix_int.ModelCenter/-data-collector/index.md) | -| [DataExplorer](../../com.phoenix_int.ModelCenter/-data-explorer/index.md) | -| [PHXDEKeepalive](../../com.phoenix_int.ModelCenter/-data-explorer/-p-h-x-d-e-keepalive/index.md) | -| [DataHistory](../../com.phoenix_int.ModelCenter/-data-history/index.md) | -| [DataMonitor](../../com.phoenix_int.ModelCenter/-data-monitor/index.md) | -| [DHVariable](../../com.phoenix_int.ModelCenter/-d-h-variable/index.md) | -| [Feature](../../com.phoenix_int.ModelCenter/-feature/index.md) | -| [FileSystemInfo](../../com.phoenix_int.ModelCenter/-file-system-info/index.md) | -| [Format](../../com.phoenix_int.ModelCenter/-format/index.md) | -| [GlobalParameters](../../com.phoenix_int.ModelCenter/-global-parameters/index.md) | -| [Group](../../com.phoenix_int.ModelCenter/-group/index.md) | -| [JobManager](../../com.phoenix_int.ModelCenter/-job-manager/index.md) | -| [ModelCenter](../../com.phoenix_int.ModelCenter/-model-center/index.md) | -| [RefArrayProp](../../com.phoenix_int.ModelCenter/-ref-array-prop/index.md) | -| [RefProp](../../com.phoenix_int.ModelCenter/-ref-prop/index.md) | -| [SaveContext](../../com.phoenix_int.ModelCenter/-save-context/index.md) | -| [TradeStudy](../../com.phoenix_int.ModelCenter/-trade-study/index.md) | -| [Variable](../../com.phoenix_int.ModelCenter/-variable/index.md) | -| [VariableDescription](../../com.phoenix_int.ModelCenter/-variable-description/index.md) | -| [VariableLink](../../com.phoenix_int.ModelCenter/-variable-link/index.md) | -| [VariableLinks](../../com.phoenix_int.ModelCenter/-variable-links/index.md) | -| [VariableMetaDataProvider](../../com.phoenix_int.ModelCenter/-variable-meta-data-provider/index.md) | -| [Variables](../../com.phoenix_int.ModelCenter/-variables/index.md) | -| [AddToModel](../../com.phoenix_int.ModelCenter/-add-to-model/index.md) | -| [Assembly](../../com.phoenix_int.ModelCenter/-assembly/index.md) | -| [CachePin](../../com.phoenix_int.ModelCenter/-cache-pin/index.md) | -| [Component](../../com.phoenix_int.ModelCenter/-component/index.md) | -| [CustomDesignPoint](../../com.phoenix_int.ModelCenter/-custom-design-point/index.md) | -| [DataCollector](../../com.phoenix_int.ModelCenter/-data-collector/index.md) | -| [DataExplorer](../../com.phoenix_int.ModelCenter/-data-explorer/index.md) | -| [PHXDEKeepalive](../../com.phoenix_int.ModelCenter/-data-explorer/-p-h-x-d-e-keepalive/index.md) | -| [DataHistory](../../com.phoenix_int.ModelCenter/-data-history/index.md) | -| [DataMonitor](../../com.phoenix_int.ModelCenter/-data-monitor/index.md) | -| [DHVariable](../../com.phoenix_int.ModelCenter/-d-h-variable/index.md) | -| [Feature](../../com.phoenix_int.ModelCenter/-feature/index.md) | -| [FileSystemInfo](../../com.phoenix_int.ModelCenter/-file-system-info/index.md) | -| [Format](../../com.phoenix_int.ModelCenter/-format/index.md) | -| [GlobalParameters](../../com.phoenix_int.ModelCenter/-global-parameters/index.md) | -| [Group](../../com.phoenix_int.ModelCenter/-group/index.md) | -| [JobManager](../../com.phoenix_int.ModelCenter/-job-manager/index.md) | -| [ModelCenter](../../com.phoenix_int.ModelCenter/-model-center/index.md) | -| [RefArrayProp](../../com.phoenix_int.ModelCenter/-ref-array-prop/index.md) | -| [RefProp](../../com.phoenix_int.ModelCenter/-ref-prop/index.md) | -| [SaveContext](../../com.phoenix_int.ModelCenter/-save-context/index.md) | -| [TradeStudy](../../com.phoenix_int.ModelCenter/-trade-study/index.md) | -| [Variable](../../com.phoenix_int.ModelCenter/-variable/index.md) | -| [VariableDescription](../../com.phoenix_int.ModelCenter/-variable-description/index.md) | -| [VariableLink](../../com.phoenix_int.ModelCenter/-variable-link/index.md) | -| [VariableLinks](../../com.phoenix_int.ModelCenter/-variable-links/index.md) | -| [VariableMetaDataProvider](../../com.phoenix_int.ModelCenter/-variable-meta-data-provider/index.md) | -| [Variables](../../com.phoenix_int.ModelCenter/-variables/index.md) | -| [Logger](../../com.phoenix_int.ModelCenter.logging/-logger/index.md) | -| [Logger](../../com.phoenix_int.ModelCenter.logging/-logger/index.md) | - -## Functions - -| Name | Summary | -|---|---| -| [disableGC](disable-g-c.md) | public [disableGC](disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [release](release.md) | public [release](release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](release-objects.md) | public [releaseObjects](release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setReferenceDebugMode](set-reference-debug-mode.md) | public [setReferenceDebugMode](set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +# PHXCOMObject + +public class [PHXCOMObject](index.md) + +This is a base class for Java objects that mirror ModelCenter COM objects + +#### Author + +Woyak, 10/2001 + +#### Inheritors + +| | +|---| +| [AddToModel](../../com.phoenix_int.ModelCenter/-add-to-model/index.md) | +| [Assembly](../../com.phoenix_int.ModelCenter/-assembly/index.md) | +| [CachePin](../../com.phoenix_int.ModelCenter/-cache-pin/index.md) | +| [Component](../../com.phoenix_int.ModelCenter/-component/index.md) | +| [CustomDesignPoint](../../com.phoenix_int.ModelCenter/-custom-design-point/index.md) | +| [DataCollector](../../com.phoenix_int.ModelCenter/-data-collector/index.md) | +| [DataExplorer](../../com.phoenix_int.ModelCenter/-data-explorer/index.md) | +| [PHXDEKeepalive](../../com.phoenix_int.ModelCenter/-data-explorer/-p-h-x-d-e-keepalive/index.md) | +| [DataHistory](../../com.phoenix_int.ModelCenter/-data-history/index.md) | +| [DataMonitor](../../com.phoenix_int.ModelCenter/-data-monitor/index.md) | +| [DHVariable](../../com.phoenix_int.ModelCenter/-d-h-variable/index.md) | +| [Feature](../../com.phoenix_int.ModelCenter/-feature/index.md) | +| [FileSystemInfo](../../com.phoenix_int.ModelCenter/-file-system-info/index.md) | +| [Format](../../com.phoenix_int.ModelCenter/-format/index.md) | +| [GlobalParameters](../../com.phoenix_int.ModelCenter/-global-parameters/index.md) | +| [Group](../../com.phoenix_int.ModelCenter/-group/index.md) | +| [JobManager](../../com.phoenix_int.ModelCenter/-job-manager/index.md) | +| [ModelCenter](../../com.phoenix_int.ModelCenter/-model-center/index.md) | +| [RefArrayProp](../../com.phoenix_int.ModelCenter/-ref-array-prop/index.md) | +| [RefProp](../../com.phoenix_int.ModelCenter/-ref-prop/index.md) | +| [SaveContext](../../com.phoenix_int.ModelCenter/-save-context/index.md) | +| [TradeStudy](../../com.phoenix_int.ModelCenter/-trade-study/index.md) | +| [Variable](../../com.phoenix_int.ModelCenter/-variable/index.md) | +| [VariableDescription](../../com.phoenix_int.ModelCenter/-variable-description/index.md) | +| [VariableLink](../../com.phoenix_int.ModelCenter/-variable-link/index.md) | +| [VariableLinks](../../com.phoenix_int.ModelCenter/-variable-links/index.md) | +| [VariableMetaDataProvider](../../com.phoenix_int.ModelCenter/-variable-meta-data-provider/index.md) | +| [Variables](../../com.phoenix_int.ModelCenter/-variables/index.md) | +| [AddToModel](../../com.phoenix_int.ModelCenter/-add-to-model/index.md) | +| [Assembly](../../com.phoenix_int.ModelCenter/-assembly/index.md) | +| [CachePin](../../com.phoenix_int.ModelCenter/-cache-pin/index.md) | +| [Component](../../com.phoenix_int.ModelCenter/-component/index.md) | +| [CustomDesignPoint](../../com.phoenix_int.ModelCenter/-custom-design-point/index.md) | +| [DataCollector](../../com.phoenix_int.ModelCenter/-data-collector/index.md) | +| [DataExplorer](../../com.phoenix_int.ModelCenter/-data-explorer/index.md) | +| [PHXDEKeepalive](../../com.phoenix_int.ModelCenter/-data-explorer/-p-h-x-d-e-keepalive/index.md) | +| [DataHistory](../../com.phoenix_int.ModelCenter/-data-history/index.md) | +| [DataMonitor](../../com.phoenix_int.ModelCenter/-data-monitor/index.md) | +| [DHVariable](../../com.phoenix_int.ModelCenter/-d-h-variable/index.md) | +| [Feature](../../com.phoenix_int.ModelCenter/-feature/index.md) | +| [FileSystemInfo](../../com.phoenix_int.ModelCenter/-file-system-info/index.md) | +| [Format](../../com.phoenix_int.ModelCenter/-format/index.md) | +| [GlobalParameters](../../com.phoenix_int.ModelCenter/-global-parameters/index.md) | +| [Group](../../com.phoenix_int.ModelCenter/-group/index.md) | +| [JobManager](../../com.phoenix_int.ModelCenter/-job-manager/index.md) | +| [ModelCenter](../../com.phoenix_int.ModelCenter/-model-center/index.md) | +| [RefArrayProp](../../com.phoenix_int.ModelCenter/-ref-array-prop/index.md) | +| [RefProp](../../com.phoenix_int.ModelCenter/-ref-prop/index.md) | +| [SaveContext](../../com.phoenix_int.ModelCenter/-save-context/index.md) | +| [TradeStudy](../../com.phoenix_int.ModelCenter/-trade-study/index.md) | +| [Variable](../../com.phoenix_int.ModelCenter/-variable/index.md) | +| [VariableDescription](../../com.phoenix_int.ModelCenter/-variable-description/index.md) | +| [VariableLink](../../com.phoenix_int.ModelCenter/-variable-link/index.md) | +| [VariableLinks](../../com.phoenix_int.ModelCenter/-variable-links/index.md) | +| [VariableMetaDataProvider](../../com.phoenix_int.ModelCenter/-variable-meta-data-provider/index.md) | +| [Variables](../../com.phoenix_int.ModelCenter/-variables/index.md) | +| [Logger](../../com.phoenix_int.ModelCenter.logging/-logger/index.md) | +| [Logger](../../com.phoenix_int.ModelCenter.logging/-logger/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [disableGC](disable-g-c.md) | public [disableGC](disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [release](release.md) | public [release](release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](release-objects.md) | public [releaseObjects](release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setReferenceDebugMode](set-reference-debug-mode.md) | public [setReferenceDebugMode](set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md index c37caf4fe2..eb35a21c2e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md @@ -1,10 +1,8 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXCOMObject](index.md)/[releaseObjects](release-objects.md) - -# releaseObjects - - -public [releaseObjects](release-objects.md)() - -This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. It is a useful last resort to prevent memory leaks due to programming mistakes, but is not reliable enough to depend on. - - ModelCenter 6.1 includes a new Reference Debugger in the Java Console which can be used to track down COM resources that have not been properly released. +# releaseObjects + + +public [releaseObjects](release-objects.md)() + +This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. It is a useful last resort to prevent memory leaks due to programming mistakes, but is not reliable enough to depend on. + + ModelCenter 6.1 includes a new Reference Debugger in the Java Console which can be used to track down COM resources that have not been properly released. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md index e553921b63..ff362cb2a5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXCOMObject](index.md)/[release](release.md) - -# release - - -public [release](release.md)() - -Releases the COM reference to ModelCenter for this object. Although some attempt is made to clean up objects automatically through releaseObjects(), failure to call this function can sometimes lead to intermittent and difficult to debug problems or memory leaks. This object can no longer be used after calling release, but it is safe to call release() multiple times. - - ModelCenter 6.1 includes a Reference Debugger on the Java Console window which can be used to find objects which have not been properly released. - -#### Throws - -| | -|---| -| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | +# release + + +public [release](release.md)() + +Releases the COM reference to ModelCenter for this object. Although some attempt is made to clean up objects automatically through releaseObjects(), failure to call this function can sometimes lead to intermittent and difficult to debug problems or memory leaks. This object can no longer be used after calling release, but it is safe to call release() multiple times. + + ModelCenter 6.1 includes a Reference Debugger on the Java Console window which can be used to find objects which have not been properly released. + +#### Throws + +| | +|---| +| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md index 64e604bb1a..afd123aff3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXCOMObject](index.md)/[setReferenceDebugMode](set-reference-debug-mode.md) - -# setReferenceDebugMode - - -public [setReferenceDebugMode](set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. +# setReferenceDebugMode + + +public [setReferenceDebugMode](set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-equation-parser/-p-h-x-equation-parser.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-equation-parser/-p-h-x-equation-parser.md index 11af12a8c2..2464a3d0ce 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-equation-parser/-p-h-x-equation-parser.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-equation-parser/-p-h-x-equation-parser.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXEquationParser](index.md)/[PHXEquationParser](-p-h-x-equation-parser.md) - -# PHXEquationParser - - -constructor() - -Constructor +# PHXEquationParser + + +constructor() + +Constructor diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-equation-parser/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-equation-parser/index.md index 97857b50ad..52daa0107f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-equation-parser/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-equation-parser/index.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXEquationParser](index.md) - -# PHXEquationParser - - -public class [PHXEquationParser](index.md) - -## Constructors - -| | | -|---|---| -| [PHXEquationParser](-p-h-x-equation-parser.md) | constructor()
Constructor | - -## Functions - -| Name | Summary | -|---|---| -| [parseEquation](parse-equation.md) | public [parseEquation](parse-equation.md)(eqn: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), varNames: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, inputValues: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | +# PHXEquationParser + + +public class [PHXEquationParser](index.md) + +## Constructors + +| | | +|---|---| +| [PHXEquationParser](-p-h-x-equation-parser.md) | constructor()
Constructor | + +## Functions + +| Name | Summary | +|---|---| +| [parseEquation](parse-equation.md) | public [parseEquation](parse-equation.md)(eqn: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), varNames: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, inputValues: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-equation-parser/parse-equation.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-equation-parser/parse-equation.md index 018ba04610..b017579030 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-equation-parser/parse-equation.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-equation-parser/parse-equation.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXEquationParser](index.md)/[parseEquation](parse-equation.md) - -# parseEquation - - -public [parseEquation](parse-equation.md)(eqn: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), varNames: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, inputValues: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) +# parseEquation + + +public [parseEquation](parse-equation.md)(eqn: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), varNames: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, inputValues: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/action-performed.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/action-performed.md index 0b943b726e..128b026663 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/action-performed.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/action-performed.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXIOConsole](index.md)/[actionPerformed](action-performed.md) - -# actionPerformed - - -public [actionPerformed](action-performed.md)(e: [ActionEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionEvent.html)) +# actionPerformed + + +public [actionPerformed](action-performed.md)(e: [ActionEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionEvent.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/dispose.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/dispose.md index 6091af6ddd..a1b00f78e5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/dispose.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/dispose.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXIOConsole](index.md)/[dispose](dispose.md) - -# dispose - - -public [dispose](dispose.md)() +# dispose + + +public [dispose](dispose.md)() diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/index.md index 570eb30aa7..af8952a2e0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/index.md @@ -1,21 +1,19 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXIOConsole](index.md) - -# PHXIOConsole - - -public class [PHXIOConsole](index.md) : [ActionListener](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionListener.html) - -A utility class for redirecting IO to a window - -#### Author - -Woyak - -## Functions - -| Name | Summary | -|---|---| -| [actionPerformed](action-performed.md) | public [actionPerformed](action-performed.md)(e: [ActionEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionEvent.html)) | -| [dispose](dispose.md) | public [dispose](dispose.md)() | -| [isShowing](is-showing.md) | public [isShowing](is-showing.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | -| [show](show.md) | public [show](show.md)(show: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | +# PHXIOConsole + + +public class [PHXIOConsole](index.md) : [ActionListener](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionListener.html) + +A utility class for redirecting IO to a window + +#### Author + +Woyak + +## Functions + +| Name | Summary | +|---|---| +| [actionPerformed](action-performed.md) | public [actionPerformed](action-performed.md)(e: [ActionEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionEvent.html)) | +| [dispose](dispose.md) | public [dispose](dispose.md)() | +| [isShowing](is-showing.md) | public [isShowing](is-showing.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [show](show.md) | public [show](show.md)(show: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/is-showing.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/is-showing.md index 89f4395ab0..f46f07134f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/is-showing.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/is-showing.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXIOConsole](index.md)/[isShowing](is-showing.md) - -# isShowing - - -public [isShowing](is-showing.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) +# isShowing + + +public [isShowing](is-showing.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/show.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/show.md index 6c3f33f674..0a81053dd4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/show.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/show.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXIOConsole](index.md)/[show](show.md) - -# show - - -public [show](show.md)(show: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) +# show + + +public [show](show.md)(show: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-jar-location/-p-h-x-jar-location.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-jar-location/-p-h-x-jar-location.md index 5ada2189ff..8df50f898a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-jar-location/-p-h-x-jar-location.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-jar-location/-p-h-x-jar-location.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXJarLocation](index.md)/[PHXJarLocation](-p-h-x-jar-location.md) - -# PHXJarLocation - - -constructor() - -Creates a new instance of PHXJarLocation +# PHXJarLocation + + +constructor() + +Creates a new instance of PHXJarLocation diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-jar-location/get-class-location.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-jar-location/get-class-location.md index d4e5e9059f..42ff52d427 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-jar-location/get-class-location.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-jar-location/get-class-location.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXJarLocation](index.md)/[getClassLocation](get-class-location.md) - -# getClassLocation - - -public [getClassLocation](get-class-location.md)(cls: [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -return the folder where the class file is located - -#### Return - -folder name that contains the class - -#### Parameters - - - -| | | -|---|---| -| cls | the class that is searched for | +# getClassLocation + + +public [getClassLocation](get-class-location.md)(cls: [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +return the folder where the class file is located + +#### Return + +folder name that contains the class + +#### Parameters + + + +| | | +|---|---| +| cls | the class that is searched for | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-jar-location/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-jar-location/index.md index 82811a32f0..d21c3a5acb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-jar-location/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-jar-location/index.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXJarLocation](index.md) - -# PHXJarLocation - - -public class [PHXJarLocation](index.md) - -#### Author - -hkim - -## Constructors - -| | | -|---|---| -| [PHXJarLocation](-p-h-x-jar-location.md) | constructor()
Creates a new instance of PHXJarLocation | - -## Functions - -| Name | Summary | -|---|---| -| [getClassLocation](get-class-location.md) | public [getClassLocation](get-class-location.md)(cls: [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
return the folder where the class file is located | +# PHXJarLocation + + +public class [PHXJarLocation](index.md) + +#### Author + +hkim + +## Constructors + +| | | +|---|---| +| [PHXJarLocation](-p-h-x-jar-location.md) | constructor()
Creates a new instance of PHXJarLocation | + +## Functions + +| Name | Summary | +|---|---| +| [getClassLocation](get-class-location.md) | public [getClassLocation](get-class-location.md)(cls: [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
return the folder where the class file is located | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-m-c-jar-loader/-p-h-x-m-c-jar-loader.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-m-c-jar-loader/-p-h-x-m-c-jar-loader.md index a7f85d5fa6..11490c35bc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-m-c-jar-loader/-p-h-x-m-c-jar-loader.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-m-c-jar-loader/-p-h-x-m-c-jar-loader.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXMCJarLoader](index.md)/[PHXMCJarLoader](-p-h-x-m-c-jar-loader.md) - -# PHXMCJarLoader - - -constructor(jarFileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Loads a .jar file. This result is the same as if the .jar file was in the CLASSPATH - -#### Parameters - - - -| | | -|---|---| -| jarFileName | the jar file to load | - -#### Throws - -| | | -|---|---| -| [IOException](https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html) | thrown if the specified jar file does not exist or an error occurs reading it | +# PHXMCJarLoader + + +constructor(jarFileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Loads a .jar file. This result is the same as if the .jar file was in the CLASSPATH + +#### Parameters + + + +| | | +|---|---| +| jarFileName | the jar file to load | + +#### Throws + +| | | +|---|---| +| [IOException](https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html) | thrown if the specified jar file does not exist or an error occurs reading it | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-m-c-jar-loader/class-exists.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-m-c-jar-loader/class-exists.md index f857a3ddec..9f8320018d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-m-c-jar-loader/class-exists.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-m-c-jar-loader/class-exists.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXMCJarLoader](index.md)/[classExists](class-exists.md) - -# classExists - - -public [classExists](class-exists.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) +# classExists + + +public [classExists](class-exists.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-m-c-jar-loader/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-m-c-jar-loader/index.md index 68f8147443..ae2de526de 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-m-c-jar-loader/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-m-c-jar-loader/index.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXMCJarLoader](index.md) - -# PHXMCJarLoader - - -public class [PHXMCJarLoader](index.md) : [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html) - -This class reads a jar file and automatically loads all of its .class files. - -#### Author - -Woyak, 9/01 - -## Constructors - -| | | -|---|---| -| [PHXMCJarLoader](-p-h-x-m-c-jar-loader.md) | constructor(jarFileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Loads a .jar file. | - -## Properties - -| Name | Summary | -|---|---| -| [name](../-p-h-x-u-r-l-class-loader/index.md#-496928135%2FProperties%2F-2117262581) | val [name](../-p-h-x-u-r-l-class-loader/index.md#-496928135%2FProperties%2F-2117262581): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | -| [parent](../-p-h-x-u-r-l-class-loader/index.md#1459003258%2FProperties%2F-2117262581) | val [parent](../-p-h-x-u-r-l-class-loader/index.md#1459003258%2FProperties%2F-2117262581): [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html) | -| [unnamedModule](../-p-h-x-u-r-l-class-loader/index.md#1201644394%2FProperties%2F-2117262581) | val [unnamedModule](../-p-h-x-u-r-l-class-loader/index.md#1201644394%2FProperties%2F-2117262581): [Module](https://docs.oracle.com/javase/8/docs/api/java/lang/Module.html) | - -## Functions - -| Name | Summary | -|---|---| -| [classExists](class-exists.md) | public [classExists](class-exists.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | -| [clearAssertionStatus](../-p-h-x-u-r-l-class-loader/index.md#1259311869%2FFunctions%2F-2117262581) | public [clearAssertionStatus](../-p-h-x-u-r-l-class-loader/index.md#1259311869%2FFunctions%2F-2117262581)() | -| [getDefinedPackage](../-p-h-x-u-r-l-class-loader/index.md#-1237778274%2FFunctions%2F-2117262581) | fun [getDefinedPackage](../-p-h-x-u-r-l-class-loader/index.md#-1237778274%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Package](https://docs.oracle.com/javase/8/docs/api/java/lang/Package.html) | -| [getDefinedPackages](../-p-h-x-u-r-l-class-loader/index.md#1895612036%2FFunctions%2F-2117262581) | fun [getDefinedPackages](../-p-h-x-u-r-l-class-loader/index.md#1895612036%2FFunctions%2F-2117262581)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Package](https://docs.oracle.com/javase/8/docs/api/java/lang/Package.html)> | -| [getPlatformClassLoader](../-p-h-x-u-r-l-class-loader/index.md#-1125909726%2FFunctions%2F-2117262581) | public [getPlatformClassLoader](../-p-h-x-u-r-l-class-loader/index.md#-1125909726%2FFunctions%2F-2117262581)(): [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html) | -| [getResource](index.md#1715467245%2FFunctions%2F-2117262581) | public [getResource](index.md#1715467245%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html) | -| [getResourceAsStream](index.md#1361516731%2FFunctions%2F-2117262581) | public [getResourceAsStream](index.md#1361516731%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html) | -| [getResources](../-p-h-x-u-r-l-class-loader/index.md#26826512%2FFunctions%2F-2117262581) | public [getResources](../-p-h-x-u-r-l-class-loader/index.md#26826512%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Enumeration](https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)> | -| [getSystemClassLoader](../-p-h-x-u-r-l-class-loader/index.md#1201052190%2FFunctions%2F-2117262581) | public [getSystemClassLoader](../-p-h-x-u-r-l-class-loader/index.md#1201052190%2FFunctions%2F-2117262581)(): [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html) | -| [getSystemResource](../-p-h-x-u-r-l-class-loader/index.md#-1625599170%2FFunctions%2F-2117262581) | public [getSystemResource](../-p-h-x-u-r-l-class-loader/index.md#-1625599170%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html) | -| [getSystemResourceAsStream](../-p-h-x-u-r-l-class-loader/index.md#-841312500%2FFunctions%2F-2117262581) | public [getSystemResourceAsStream](../-p-h-x-u-r-l-class-loader/index.md#-841312500%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html) | -| [getSystemResources](../-p-h-x-u-r-l-class-loader/index.md#-467017249%2FFunctions%2F-2117262581) | public [getSystemResources](../-p-h-x-u-r-l-class-loader/index.md#-467017249%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Enumeration](https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)> | -| [isRegisteredAsParallelCapable](../-p-h-x-u-r-l-class-loader/index.md#720218351%2FFunctions%2F-2117262581) | fun [isRegisteredAsParallelCapable](../-p-h-x-u-r-l-class-loader/index.md#720218351%2FFunctions%2F-2117262581)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | -| [loadClass](index.md#1712797503%2FFunctions%2F-2117262581) | public [loadClass](index.md#1712797503%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html)<out [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> | -| [resources](../-p-h-x-u-r-l-class-loader/index.md#110303916%2FFunctions%2F-2117262581) | public [resources](../-p-h-x-u-r-l-class-loader/index.md#110303916%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Stream](https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)> | -| [setClassAssertionStatus](../-p-h-x-u-r-l-class-loader/index.md#197864046%2FFunctions%2F-2117262581) | public [setClassAssertionStatus](../-p-h-x-u-r-l-class-loader/index.md#197864046%2FFunctions%2F-2117262581)(className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), enabled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | -| [setDefaultAssertionStatus](../-p-h-x-u-r-l-class-loader/index.md#776050745%2FFunctions%2F-2117262581) | public [setDefaultAssertionStatus](../-p-h-x-u-r-l-class-loader/index.md#776050745%2FFunctions%2F-2117262581)(enabled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | -| [setPackageAssertionStatus](../-p-h-x-u-r-l-class-loader/index.md#-849525892%2FFunctions%2F-2117262581) | public [setPackageAssertionStatus](../-p-h-x-u-r-l-class-loader/index.md#-849525892%2FFunctions%2F-2117262581)(packageName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), enabled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | +# PHXMCJarLoader + + +public class [PHXMCJarLoader](index.md) : [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html) + +This class reads a jar file and automatically loads all of its .class files. + +#### Author + +Woyak, 9/01 + +## Constructors + +| | | +|---|---| +| [PHXMCJarLoader](-p-h-x-m-c-jar-loader.md) | constructor(jarFileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Loads a .jar file. | + +## Properties + +| Name | Summary | +|---|---| +| [name](../-p-h-x-u-r-l-class-loader/index.md#-496928135%2FProperties%2F-2117262581) | val [name](../-p-h-x-u-r-l-class-loader/index.md#-496928135%2FProperties%2F-2117262581): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | +| [parent](../-p-h-x-u-r-l-class-loader/index.md#1459003258%2FProperties%2F-2117262581) | val [parent](../-p-h-x-u-r-l-class-loader/index.md#1459003258%2FProperties%2F-2117262581): [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html) | +| [unnamedModule](../-p-h-x-u-r-l-class-loader/index.md#1201644394%2FProperties%2F-2117262581) | val [unnamedModule](../-p-h-x-u-r-l-class-loader/index.md#1201644394%2FProperties%2F-2117262581): [Module](https://docs.oracle.com/javase/8/docs/api/java/lang/Module.html) | + +## Functions + +| Name | Summary | +|---|---| +| [classExists](class-exists.md) | public [classExists](class-exists.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [clearAssertionStatus](../-p-h-x-u-r-l-class-loader/index.md#1259311869%2FFunctions%2F-2117262581) | public [clearAssertionStatus](../-p-h-x-u-r-l-class-loader/index.md#1259311869%2FFunctions%2F-2117262581)() | +| [getDefinedPackage](../-p-h-x-u-r-l-class-loader/index.md#-1237778274%2FFunctions%2F-2117262581) | fun [getDefinedPackage](../-p-h-x-u-r-l-class-loader/index.md#-1237778274%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Package](https://docs.oracle.com/javase/8/docs/api/java/lang/Package.html) | +| [getDefinedPackages](../-p-h-x-u-r-l-class-loader/index.md#1895612036%2FFunctions%2F-2117262581) | fun [getDefinedPackages](../-p-h-x-u-r-l-class-loader/index.md#1895612036%2FFunctions%2F-2117262581)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Package](https://docs.oracle.com/javase/8/docs/api/java/lang/Package.html)> | +| [getPlatformClassLoader](../-p-h-x-u-r-l-class-loader/index.md#-1125909726%2FFunctions%2F-2117262581) | public [getPlatformClassLoader](../-p-h-x-u-r-l-class-loader/index.md#-1125909726%2FFunctions%2F-2117262581)(): [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html) | +| [getResource](index.md#1715467245%2FFunctions%2F-2117262581) | public [getResource](index.md#1715467245%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html) | +| [getResourceAsStream](index.md#1361516731%2FFunctions%2F-2117262581) | public [getResourceAsStream](index.md#1361516731%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html) | +| [getResources](../-p-h-x-u-r-l-class-loader/index.md#26826512%2FFunctions%2F-2117262581) | public [getResources](../-p-h-x-u-r-l-class-loader/index.md#26826512%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Enumeration](https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)> | +| [getSystemClassLoader](../-p-h-x-u-r-l-class-loader/index.md#1201052190%2FFunctions%2F-2117262581) | public [getSystemClassLoader](../-p-h-x-u-r-l-class-loader/index.md#1201052190%2FFunctions%2F-2117262581)(): [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html) | +| [getSystemResource](../-p-h-x-u-r-l-class-loader/index.md#-1625599170%2FFunctions%2F-2117262581) | public [getSystemResource](../-p-h-x-u-r-l-class-loader/index.md#-1625599170%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html) | +| [getSystemResourceAsStream](../-p-h-x-u-r-l-class-loader/index.md#-841312500%2FFunctions%2F-2117262581) | public [getSystemResourceAsStream](../-p-h-x-u-r-l-class-loader/index.md#-841312500%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html) | +| [getSystemResources](../-p-h-x-u-r-l-class-loader/index.md#-467017249%2FFunctions%2F-2117262581) | public [getSystemResources](../-p-h-x-u-r-l-class-loader/index.md#-467017249%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Enumeration](https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)> | +| [isRegisteredAsParallelCapable](../-p-h-x-u-r-l-class-loader/index.md#720218351%2FFunctions%2F-2117262581) | fun [isRegisteredAsParallelCapable](../-p-h-x-u-r-l-class-loader/index.md#720218351%2FFunctions%2F-2117262581)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [loadClass](index.md#1712797503%2FFunctions%2F-2117262581) | public [loadClass](index.md#1712797503%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html)<out [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> | +| [resources](../-p-h-x-u-r-l-class-loader/index.md#110303916%2FFunctions%2F-2117262581) | public [resources](../-p-h-x-u-r-l-class-loader/index.md#110303916%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Stream](https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)> | +| [setClassAssertionStatus](../-p-h-x-u-r-l-class-loader/index.md#197864046%2FFunctions%2F-2117262581) | public [setClassAssertionStatus](../-p-h-x-u-r-l-class-loader/index.md#197864046%2FFunctions%2F-2117262581)(className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), enabled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | +| [setDefaultAssertionStatus](../-p-h-x-u-r-l-class-loader/index.md#776050745%2FFunctions%2F-2117262581) | public [setDefaultAssertionStatus](../-p-h-x-u-r-l-class-loader/index.md#776050745%2FFunctions%2F-2117262581)(enabled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | +| [setPackageAssertionStatus](../-p-h-x-u-r-l-class-loader/index.md#-849525892%2FFunctions%2F-2117262581) | public [setPackageAssertionStatus](../-p-h-x-u-r-l-class-loader/index.md#-849525892%2FFunctions%2F-2117262581)(packageName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), enabled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/-p-h-x-plug-in-launcher.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/-p-h-x-plug-in-launcher.md index b80c0fbe40..8c7d8efd91 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/-p-h-x-plug-in-launcher.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/-p-h-x-plug-in-launcher.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXPlugInLauncher](index.md)/[PHXPlugInLauncher](-p-h-x-plug-in-launcher.md) - -# PHXPlugInLauncher - - -constructor() +# PHXPlugInLauncher + + +constructor() diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/class-exists.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/class-exists.md index f3d078ebbb..9b7e701c56 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/class-exists.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/class-exists.md @@ -1,27 +1,25 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXPlugInLauncher](index.md)/[classExists](class-exists.md) - -# classExists - - -public [classExists](class-exists.md)(jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Utility method to determine if a class exists in a JAR file. - -#### Return - -true if the class exists, false if not - -#### Parameters - - - -| | | -|---|---| -| jarFile | the path to the JAR file | -| className | the fully-qualified name of the class to load | - -#### Throws - -| | | -|---|---| -| [IOException](https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html) | if the path is invalid | +# classExists + + +public [classExists](class-exists.md)(jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Utility method to determine if a class exists in a JAR file. + +#### Return + +true if the class exists, false if not + +#### Parameters + + + +| | | +|---|---| +| jarFile | the path to the JAR file | +| className | the fully-qualified name of the class to load | + +#### Throws + +| | | +|---|---| +| [IOException](https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html) | if the path is invalid | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/clean-up.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/clean-up.md index 1d99870f1e..7917437841 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/clean-up.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/clean-up.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXPlugInLauncher](index.md)/[cleanUp](clean-up.md) - -# cleanUp - - -public [cleanUp](clean-up.md)() - -Do cleanup of any resources we've created as part of the launcher setup. +# cleanUp + + +public [cleanUp](clean-up.md)() + +Do cleanup of any resources we've created as part of the launcher setup. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/construct-model-center.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/construct-model-center.md index 53ecaeeb2d..38dfaf6503 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/construct-model-center.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/construct-model-center.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXPlugInLauncher](index.md)/[constructModelCenter](construct-model-center.md) - -# constructModelCenter - - -public [constructModelCenter](construct-model-center.md)(mcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [ModelCenter](../../com.phoenix_int.ModelCenter/-model-center/index.md) - -Constructs a ModelCenter object. - -#### Parameters - - - -| | | -|---|---| -| mcStream | the IDispatch for the ModelCenter object | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | on error | +# constructModelCenter + + +public [constructModelCenter](construct-model-center.md)(mcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [ModelCenter](../../com.phoenix_int.ModelCenter/-model-center/index.md) + +Constructs a ModelCenter object. + +#### Parameters + + + +| | | +|---|---| +| mcStream | the IDispatch for the ModelCenter object | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../../com.phoenix_int.ModelCenter/-model-center-exception/index.md) | on error | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/disable-i-o-console.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/disable-i-o-console.md index 73de4e5771..a18ea0ffc8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/disable-i-o-console.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/disable-i-o-console.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXPlugInLauncher](index.md)/[disableIOConsole](disable-i-o-console.md) - -# disableIOConsole - - -public [disableIOConsole](disable-i-o-console.md)(discardOutput: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - - Prevents a [PHXIOConsole](../-p-h-x-i-o-console/index.md) from ever being created and optionally redirects [err](https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#err--) and [out](https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#out--) to the bit bucket. This is a convenience method for headless apps (and specifically JNI apps) which are not using the console. - - After calling this method, feel free to re-redirect the console or error stream elsewhere, secure in the knowledge that ModelCenter.jar will not attempt to steal them again and pipe them to [PHXIOConsole](../-p-h-x-i-o-console/index.md). - -#### Parameters - - - -| | | -|---|---| -| discardOutput | whether to redirect [out](https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#out--) and [err](https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#err--) to the bit bucket; if false, they are untouched | - -#### Throws - -| | | -|---|---| -| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if [getDummyFrame](get-dummy-frame.md) has already been called and the IO console created | +# disableIOConsole + + +public [disableIOConsole](disable-i-o-console.md)(discardOutput: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + + Prevents a [PHXIOConsole](../-p-h-x-i-o-console/index.md) from ever being created and optionally redirects [err](https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#err--) and [out](https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#out--) to the bit bucket. This is a convenience method for headless apps (and specifically JNI apps) which are not using the console. + + After calling this method, feel free to re-redirect the console or error stream elsewhere, secure in the knowledge that ModelCenter.jar will not attempt to steal them again and pipe them to [PHXIOConsole](../-p-h-x-i-o-console/index.md). + +#### Parameters + + + +| | | +|---|---| +| discardOutput | whether to redirect [out](https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#out--) and [err](https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#err--) to the bit bucket; if false, they are untouched | + +#### Throws + +| | | +|---|---| +| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if [getDummyFrame](get-dummy-frame.md) has already been called and the IO console created | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/get-dummy-frame.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/get-dummy-frame.md index 62ca7a172c..c410fe29bc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/get-dummy-frame.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/get-dummy-frame.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXPlugInLauncher](index.md)/[getDummyFrame](get-dummy-frame.md) - -# getDummyFrame - - -public [getDummyFrame](get-dummy-frame.md)(): [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html) - - Returns a dummy frame object to be used as a parent frame for Java plug-ins. The JFrame is parented to the ModelCenter main frame. - - Note: this method is called by ModelCenter during setup. Therefore, the frame can always be considered to be valid from other calls in this class that are likely to be performed post-setup. - -#### Return - -the Java JFrame object, or null on failure +# getDummyFrame + + +public [getDummyFrame](get-dummy-frame.md)(): [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html) + + Returns a dummy frame object to be used as a parent frame for Java plug-ins. The JFrame is parented to the ModelCenter main frame. + + Note: this method is called by ModelCenter during setup. Therefore, the frame can always be considered to be valid from other calls in this class that are likely to be performed post-setup. + +#### Return + +the Java JFrame object, or null on failure diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/index.md index 4da3f3f1cf..fe6b4a91b9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/index.md @@ -1,32 +1,30 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXPlugInLauncher](index.md) - -# PHXPlugInLauncher - - -public class [PHXPlugInLauncher](index.md) - -Upgraded, thread-safe, etc. plug-in launcher for ModelCenter. - -#### Author - -Dave - -## Constructors - -| | | -|---|---| -| [PHXPlugInLauncher](-p-h-x-plug-in-launcher.md) | constructor() | - -## Functions - -| Name | Summary | -|---|---| -| [classExists](class-exists.md) | public [classExists](class-exists.md)(jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Utility method to determine if a class exists in a JAR file. | -| [cleanUp](clean-up.md) | public [cleanUp](clean-up.md)()
Do cleanup of any resources we've created as part of the launcher setup. | -| [constructModelCenter](construct-model-center.md) | public [constructModelCenter](construct-model-center.md)(mcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [ModelCenter](../../com.phoenix_int.ModelCenter/-model-center/index.md)
Constructs a ModelCenter object. | -| [disableIOConsole](disable-i-o-console.md) | public [disableIOConsole](disable-i-o-console.md)(discardOutput: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Prevents a [PHXIOConsole](../-p-h-x-i-o-console/index.md) from ever being created and optionally redirects [err](https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#err--) and [out](https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#out--) to the bit bucket. | -| [getDummyFrame](get-dummy-frame.md) | public [getDummyFrame](get-dummy-frame.md)(): [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html)
Returns a dummy frame object to be used as a parent frame for Java plug-ins. | -| [launchComponentPlugIn](launch-component-plug-in.md) | public [launchComponentPlugIn](launch-component-plug-in.md)(mcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), atmStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [IComponentPlugIn](../../com.phoenix_int.ModelCenter/-i-component-plug-in/index.md)
Construct an instance of the specified Component PlugIn class. | -| [launchDataCollectorPlugIn](launch-data-collector-plug-in.md) | public [launchDataCollectorPlugIn](launch-data-collector-plug-in.md)(mcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), atmStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [IDataCollectorPlugIn](../../com.phoenix_int.ModelCenter/-i-data-collector-plug-in/index.md)
Construct an instance of the specified Data Collector PlugIn class. | -| [launchPlugInMetaData](launch-plug-in-meta-data.md) | public [launchPlugInMetaData](launch-plug-in-meta-data.md)(jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [IPlugInMetaData](../../com.phoenix_int.ModelCenter/-i-plug-in-meta-data/index.md)
Get the specified PlugIn metadata class. | -| [launchTradeStudyPlugIn](launch-trade-study-plug-in.md) | public [launchTradeStudyPlugIn](launch-trade-study-plug-in.md)(mcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), atmStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [ITradeStudyPlugIn](../../com.phoenix_int.ModelCenter/-i-trade-study-plug-in/index.md)
Construct an instance of the specified Trade Study PlugIn class. | +# PHXPlugInLauncher + + +public class [PHXPlugInLauncher](index.md) + +Upgraded, thread-safe, etc. plug-in launcher for ModelCenter. + +#### Author + +Dave + +## Constructors + +| | | +|---|---| +| [PHXPlugInLauncher](-p-h-x-plug-in-launcher.md) | constructor() | + +## Functions + +| Name | Summary | +|---|---| +| [classExists](class-exists.md) | public [classExists](class-exists.md)(jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Utility method to determine if a class exists in a JAR file. | +| [cleanUp](clean-up.md) | public [cleanUp](clean-up.md)()
Do cleanup of any resources we've created as part of the launcher setup. | +| [constructModelCenter](construct-model-center.md) | public [constructModelCenter](construct-model-center.md)(mcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [ModelCenter](../../com.phoenix_int.ModelCenter/-model-center/index.md)
Constructs a ModelCenter object. | +| [disableIOConsole](disable-i-o-console.md) | public [disableIOConsole](disable-i-o-console.md)(discardOutput: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Prevents a [PHXIOConsole](../-p-h-x-i-o-console/index.md) from ever being created and optionally redirects [err](https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#err--) and [out](https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#out--) to the bit bucket. | +| [getDummyFrame](get-dummy-frame.md) | public [getDummyFrame](get-dummy-frame.md)(): [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html)
Returns a dummy frame object to be used as a parent frame for Java plug-ins. | +| [launchComponentPlugIn](launch-component-plug-in.md) | public [launchComponentPlugIn](launch-component-plug-in.md)(mcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), atmStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [IComponentPlugIn](../../com.phoenix_int.ModelCenter/-i-component-plug-in/index.md)
Construct an instance of the specified Component PlugIn class. | +| [launchDataCollectorPlugIn](launch-data-collector-plug-in.md) | public [launchDataCollectorPlugIn](launch-data-collector-plug-in.md)(mcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), atmStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [IDataCollectorPlugIn](../../com.phoenix_int.ModelCenter/-i-data-collector-plug-in/index.md)
Construct an instance of the specified Data Collector PlugIn class. | +| [launchPlugInMetaData](launch-plug-in-meta-data.md) | public [launchPlugInMetaData](launch-plug-in-meta-data.md)(jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [IPlugInMetaData](../../com.phoenix_int.ModelCenter/-i-plug-in-meta-data/index.md)
Get the specified PlugIn metadata class. | +| [launchTradeStudyPlugIn](launch-trade-study-plug-in.md) | public [launchTradeStudyPlugIn](launch-trade-study-plug-in.md)(mcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), atmStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [ITradeStudyPlugIn](../../com.phoenix_int.ModelCenter/-i-trade-study-plug-in/index.md)
Construct an instance of the specified Trade Study PlugIn class. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-component-plug-in.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-component-plug-in.md index 23a55d89e7..2ed915f52c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-component-plug-in.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-component-plug-in.md @@ -1,29 +1,27 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXPlugInLauncher](index.md)/[launchComponentPlugIn](launch-component-plug-in.md) - -# launchComponentPlugIn - - -public [launchComponentPlugIn](launch-component-plug-in.md)(mcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), atmStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [IComponentPlugIn](../../com.phoenix_int.ModelCenter/-i-component-plug-in/index.md) - -Construct an instance of the specified Component PlugIn class. - -#### Return - -the plugin object, which will have had [construct](../../com.phoenix_int.ModelCenter/-i-component-plug-in/construct.md) called - -#### Parameters - - - -| | | -|---|---| -| mcStream | the IDispatch for the ModelCenter object | -| jarFile | the path to the JAR file containing the class | -| className | the fully-qualified classname of the class to load | -| atmStream | the IDispatch for the AddToModel object | - -#### Throws - -| | | -|---|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | on error; the type is determined by the type of failure | +# launchComponentPlugIn + + +public [launchComponentPlugIn](launch-component-plug-in.md)(mcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), atmStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [IComponentPlugIn](../../com.phoenix_int.ModelCenter/-i-component-plug-in/index.md) + +Construct an instance of the specified Component PlugIn class. + +#### Return + +the plugin object, which will have had [construct](../../com.phoenix_int.ModelCenter/-i-component-plug-in/construct.md) called + +#### Parameters + + + +| | | +|---|---| +| mcStream | the IDispatch for the ModelCenter object | +| jarFile | the path to the JAR file containing the class | +| className | the fully-qualified classname of the class to load | +| atmStream | the IDispatch for the AddToModel object | + +#### Throws + +| | | +|---|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | on error; the type is determined by the type of failure | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-data-collector-plug-in.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-data-collector-plug-in.md index 8a323b7272..ba772b0c49 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-data-collector-plug-in.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-data-collector-plug-in.md @@ -1,30 +1,28 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXPlugInLauncher](index.md)/[launchDataCollectorPlugIn](launch-data-collector-plug-in.md) - -# launchDataCollectorPlugIn - - -public [launchDataCollectorPlugIn](launch-data-collector-plug-in.md)(mcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), atmStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [IDataCollectorPlugIn](../../com.phoenix_int.ModelCenter/-i-data-collector-plug-in/index.md) - -Construct an instance of the specified Data Collector PlugIn class. - -#### Return - -the plugin object, which will have had [construct](../../com.phoenix_int.ModelCenter/-i-data-collector-plug-in/construct.md) called - -#### Parameters - - - -| | | -|---|---| -| mcStream | the IDispatch for the ModelCenter object | -| jarFile | the path to the JAR file containing the class | -| className | the fully-qualified classname of the class to load | -| atmStream | the IDispatch for the AddToModel object | -| dcStream | the IDispatch for the Data Collector object | - -#### Throws - -| | | -|---|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | on error; the type is determined by the type of failure | +# launchDataCollectorPlugIn + + +public [launchDataCollectorPlugIn](launch-data-collector-plug-in.md)(mcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), atmStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [IDataCollectorPlugIn](../../com.phoenix_int.ModelCenter/-i-data-collector-plug-in/index.md) + +Construct an instance of the specified Data Collector PlugIn class. + +#### Return + +the plugin object, which will have had [construct](../../com.phoenix_int.ModelCenter/-i-data-collector-plug-in/construct.md) called + +#### Parameters + + + +| | | +|---|---| +| mcStream | the IDispatch for the ModelCenter object | +| jarFile | the path to the JAR file containing the class | +| className | the fully-qualified classname of the class to load | +| atmStream | the IDispatch for the AddToModel object | +| dcStream | the IDispatch for the Data Collector object | + +#### Throws + +| | | +|---|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | on error; the type is determined by the type of failure | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-plug-in-meta-data.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-plug-in-meta-data.md index 30b6b902f1..975a83b529 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-plug-in-meta-data.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-plug-in-meta-data.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXPlugInLauncher](index.md)/[launchPlugInMetaData](launch-plug-in-meta-data.md) - -# launchPlugInMetaData - - -public [launchPlugInMetaData](launch-plug-in-meta-data.md)(jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [IPlugInMetaData](../../com.phoenix_int.ModelCenter/-i-plug-in-meta-data/index.md) - -Get the specified PlugIn metadata class. - -#### Parameters - - - -| | | -|---|---| -| jarFile | the JAR file where the plugin is stored | -| className | the fully qualified classname for the metadata class | - -#### Throws - -| | | -|---|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | on error; the type is determined by the type of failure | +# launchPlugInMetaData + + +public [launchPlugInMetaData](launch-plug-in-meta-data.md)(jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [IPlugInMetaData](../../com.phoenix_int.ModelCenter/-i-plug-in-meta-data/index.md) + +Get the specified PlugIn metadata class. + +#### Parameters + + + +| | | +|---|---| +| jarFile | the JAR file where the plugin is stored | +| className | the fully qualified classname for the metadata class | + +#### Throws + +| | | +|---|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | on error; the type is determined by the type of failure | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-trade-study-plug-in.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-trade-study-plug-in.md index 601c5d4fb0..17dd08c050 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-trade-study-plug-in.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-trade-study-plug-in.md @@ -1,29 +1,27 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXPlugInLauncher](index.md)/[launchTradeStudyPlugIn](launch-trade-study-plug-in.md) - -# launchTradeStudyPlugIn - - -public [launchTradeStudyPlugIn](launch-trade-study-plug-in.md)(mcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), atmStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [ITradeStudyPlugIn](../../com.phoenix_int.ModelCenter/-i-trade-study-plug-in/index.md) - -Construct an instance of the specified Trade Study PlugIn class. - -#### Return - -the plugin object, which will have had [construct](../../com.phoenix_int.ModelCenter/-i-trade-study-plug-in/construct.md) called - -#### Parameters - - - -| | | -|---|---| -| mcStream | the IDispatch for the ModelCenter object | -| jarFile | the path to the JAR file containing the class | -| className | the fully-qualified classname of the class to load | -| atmStream | the IDispatch for the AddToModel object | - -#### Throws - -| | | -|---|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | on error; the type is determined by the type of failure | +# launchTradeStudyPlugIn + + +public [launchTradeStudyPlugIn](launch-trade-study-plug-in.md)(mcStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), jarFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), atmStream: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [ITradeStudyPlugIn](../../com.phoenix_int.ModelCenter/-i-trade-study-plug-in/index.md) + +Construct an instance of the specified Trade Study PlugIn class. + +#### Return + +the plugin object, which will have had [construct](../../com.phoenix_int.ModelCenter/-i-trade-study-plug-in/construct.md) called + +#### Parameters + + + +| | | +|---|---| +| mcStream | the IDispatch for the ModelCenter object | +| jarFile | the path to the JAR file containing the class | +| className | the fully-qualified classname of the class to load | +| atmStream | the IDispatch for the AddToModel object | + +#### Throws + +| | | +|---|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | on error; the type is determined by the type of failure | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/action-performed.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/action-performed.md index 57f08cf43c..128b026663 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/action-performed.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/action-performed.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXReferenceMonitor](index.md)/[actionPerformed](action-performed.md) - -# actionPerformed - - -public [actionPerformed](action-performed.md)(e: [ActionEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionEvent.html)) +# actionPerformed + + +public [actionPerformed](action-performed.md)(e: [ActionEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionEvent.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/index.md index c44f27a349..95a0a7b24c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/index.md @@ -1,28 +1,26 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXReferenceMonitor](index.md) - -# PHXReferenceMonitor - - -public class [PHXReferenceMonitor](index.md) : [ActionListener](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionListener.html), [ListSelectionListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/event/ListSelectionListener.html), [WindowListener](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowListener.html), [ItemListener](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ItemListener.html) - -A utility class for showing active COM references from PHXCOMObject - -#### Author - -Sharp - -## Functions - -| Name | Summary | -|---|---| -| [actionPerformed](action-performed.md) | public [actionPerformed](action-performed.md)(e: [ActionEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionEvent.html)) | -| [itemStateChanged](item-state-changed.md) | public [itemStateChanged](item-state-changed.md)(e: [ItemEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ItemEvent.html)) | -| [showMonitor](show-monitor.md) | public [showMonitor](show-monitor.md)() | -| [valueChanged](value-changed.md) | public [valueChanged](value-changed.md)(e: [ListSelectionEvent](https://docs.oracle.com/javase/8/docs/api/javax/swing/event/ListSelectionEvent.html)) | -| [windowActivated](window-activated.md) | public [windowActivated](window-activated.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) | -| [windowClosed](window-closed.md) | public [windowClosed](window-closed.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) | -| [windowClosing](window-closing.md) | public [windowClosing](window-closing.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) | -| [windowDeactivated](window-deactivated.md) | public [windowDeactivated](window-deactivated.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) | -| [windowDeiconified](window-deiconified.md) | public [windowDeiconified](window-deiconified.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) | -| [windowIconified](window-iconified.md) | public [windowIconified](window-iconified.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) | -| [windowOpened](window-opened.md) | public [windowOpened](window-opened.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) | +# PHXReferenceMonitor + + +public class [PHXReferenceMonitor](index.md) : [ActionListener](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionListener.html), [ListSelectionListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/event/ListSelectionListener.html), [WindowListener](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowListener.html), [ItemListener](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ItemListener.html) + +A utility class for showing active COM references from PHXCOMObject + +#### Author + +Sharp + +## Functions + +| Name | Summary | +|---|---| +| [actionPerformed](action-performed.md) | public [actionPerformed](action-performed.md)(e: [ActionEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionEvent.html)) | +| [itemStateChanged](item-state-changed.md) | public [itemStateChanged](item-state-changed.md)(e: [ItemEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ItemEvent.html)) | +| [showMonitor](show-monitor.md) | public [showMonitor](show-monitor.md)() | +| [valueChanged](value-changed.md) | public [valueChanged](value-changed.md)(e: [ListSelectionEvent](https://docs.oracle.com/javase/8/docs/api/javax/swing/event/ListSelectionEvent.html)) | +| [windowActivated](window-activated.md) | public [windowActivated](window-activated.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) | +| [windowClosed](window-closed.md) | public [windowClosed](window-closed.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) | +| [windowClosing](window-closing.md) | public [windowClosing](window-closing.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) | +| [windowDeactivated](window-deactivated.md) | public [windowDeactivated](window-deactivated.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) | +| [windowDeiconified](window-deiconified.md) | public [windowDeiconified](window-deiconified.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) | +| [windowIconified](window-iconified.md) | public [windowIconified](window-iconified.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) | +| [windowOpened](window-opened.md) | public [windowOpened](window-opened.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/item-state-changed.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/item-state-changed.md index dbbddf92b8..9c39bf47b6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/item-state-changed.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/item-state-changed.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXReferenceMonitor](index.md)/[itemStateChanged](item-state-changed.md) - -# itemStateChanged - - -public [itemStateChanged](item-state-changed.md)(e: [ItemEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ItemEvent.html)) +# itemStateChanged + + +public [itemStateChanged](item-state-changed.md)(e: [ItemEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ItemEvent.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/show-monitor.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/show-monitor.md index ef3e018fe8..4c112781a0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/show-monitor.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/show-monitor.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXReferenceMonitor](index.md)/[showMonitor](show-monitor.md) - -# showMonitor - - -public [showMonitor](show-monitor.md)() +# showMonitor + + +public [showMonitor](show-monitor.md)() diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/value-changed.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/value-changed.md index fad84e46be..b0829f520f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/value-changed.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/value-changed.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXReferenceMonitor](index.md)/[valueChanged](value-changed.md) - -# valueChanged - - -public [valueChanged](value-changed.md)(e: [ListSelectionEvent](https://docs.oracle.com/javase/8/docs/api/javax/swing/event/ListSelectionEvent.html)) +# valueChanged + + +public [valueChanged](value-changed.md)(e: [ListSelectionEvent](https://docs.oracle.com/javase/8/docs/api/javax/swing/event/ListSelectionEvent.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-activated.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-activated.md index 76f68df305..331aa25353 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-activated.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-activated.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXReferenceMonitor](index.md)/[windowActivated](window-activated.md) - -# windowActivated - - -public [windowActivated](window-activated.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) +# windowActivated + + +public [windowActivated](window-activated.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-closed.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-closed.md index 0beb607486..bdab250f2d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-closed.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-closed.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXReferenceMonitor](index.md)/[windowClosed](window-closed.md) - -# windowClosed - - -public [windowClosed](window-closed.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) +# windowClosed + + +public [windowClosed](window-closed.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-closing.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-closing.md index c051060539..e10b37331e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-closing.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-closing.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXReferenceMonitor](index.md)/[windowClosing](window-closing.md) - -# windowClosing - - -public [windowClosing](window-closing.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) +# windowClosing + + +public [windowClosing](window-closing.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-deactivated.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-deactivated.md index 57bedfb6b1..b562ae203f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-deactivated.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-deactivated.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXReferenceMonitor](index.md)/[windowDeactivated](window-deactivated.md) - -# windowDeactivated - - -public [windowDeactivated](window-deactivated.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) +# windowDeactivated + + +public [windowDeactivated](window-deactivated.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-deiconified.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-deiconified.md index b559f67ce2..ef6b9e0c9e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-deiconified.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-deiconified.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXReferenceMonitor](index.md)/[windowDeiconified](window-deiconified.md) - -# windowDeiconified - - -public [windowDeiconified](window-deiconified.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) +# windowDeiconified + + +public [windowDeiconified](window-deiconified.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-iconified.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-iconified.md index 5b2670456c..7cb565a3e6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-iconified.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-iconified.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXReferenceMonitor](index.md)/[windowIconified](window-iconified.md) - -# windowIconified - - -public [windowIconified](window-iconified.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) +# windowIconified + + +public [windowIconified](window-iconified.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-opened.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-opened.md index 0b93205f56..eeb56bb632 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-opened.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-opened.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXReferenceMonitor](index.md)/[windowOpened](window-opened.md) - -# windowOpened - - -public [windowOpened](window-opened.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) +# windowOpened + + +public [windowOpened](window-opened.md)(e: [WindowEvent](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowEvent.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/-p-h-x-u-r-l-class-loader.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/-p-h-x-u-r-l-class-loader.md index 3ebadcaf1f..00bafe2bcb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/-p-h-x-u-r-l-class-loader.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/-p-h-x-u-r-l-class-loader.md @@ -1,10 +1,8 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXURLClassLoader](index.md)/[PHXURLClassLoader](-p-h-x-u-r-l-class-loader.md) - -# PHXURLClassLoader - - -constructor(urls: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)>) - -constructor(urls: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)>, parent: [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html)) - -constructor(urls: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)>, parent: [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html), factory: [URLStreamHandlerFactory](https://docs.oracle.com/javase/8/docs/api/java/net/URLStreamHandlerFactory.html)) +# PHXURLClassLoader + + +constructor(urls: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)>) + +constructor(urls: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)>, parent: [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html)) + +constructor(urls: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)>, parent: [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html), factory: [URLStreamHandlerFactory](https://docs.oracle.com/javase/8/docs/api/java/net/URLStreamHandlerFactory.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/add-u-r-l2.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/add-u-r-l2.md index 5998d1cff2..b7476ce362 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/add-u-r-l2.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/add-u-r-l2.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXURLClassLoader](index.md)/[addURL2](add-u-r-l2.md) - -# addURL2 - - -public [addURL2](add-u-r-l2.md)(url: [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)) - -a public version of URLClassLoader's addURL method - -#### Parameters - - - -| | | -|---|---| -| url | URL to be added to the search path | +# addURL2 + + +public [addURL2](add-u-r-l2.md)(url: [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)) + +a public version of URLClassLoader's addURL method + +#### Parameters + + + +| | | +|---|---| +| url | URL to be added to the search path | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/get-resource-as-stream.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/get-resource-as-stream.md index bbeeb75e58..ecfec28da9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/get-resource-as-stream.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/get-resource-as-stream.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXURLClassLoader](index.md)/[getResourceAsStream](get-resource-as-stream.md) - -# getResourceAsStream - - -public [getResourceAsStream](get-resource-as-stream.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html) - -#### Return - -An input stream for reading the resource, or `null`if the resource could not be found - -#### Parameters - - - -| | | -|---|---| -| name | The resource name | +# getResourceAsStream + + +public [getResourceAsStream](get-resource-as-stream.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html) + +#### Return + +An input stream for reading the resource, or `null`if the resource could not be found + +#### Parameters + + + +| | | +|---|---| +| name | The resource name | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/get-resource.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/get-resource.md index 93c6eabeaa..8386534393 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/get-resource.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/get-resource.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXURLClassLoader](index.md)/[getResource](get-resource.md) - -# getResource - - -public [getResource](get-resource.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html) - -#### Return - -A `URL` object for reading the resource, or `null` if the resource could not be found or the invoker doesn't have adequate privileges to get the resource. - -#### Parameters - - - -| | | -|---|---| -| name | The resource name | +# getResource + + +public [getResource](get-resource.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html) + +#### Return + +A `URL` object for reading the resource, or `null` if the resource could not be found or the invoker doesn't have adequate privileges to get the resource. + +#### Parameters + + + +| | | +|---|---| +| name | The resource name | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/index.md index 2e37e12795..4710f24450 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/index.md @@ -1,50 +1,48 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXURLClassLoader](index.md) - -# PHXURLClassLoader - - -public class [PHXURLClassLoader](index.md) : [URLClassLoader](https://docs.oracle.com/javase/8/docs/api/java/net/URLClassLoader.html) - -This class added a public method addURL2 that adds a URL to the search path, as well as overrides loadClass to do post-delegation class loading. - -## Constructors - -| | | -|---|---| -| [PHXURLClassLoader](-p-h-x-u-r-l-class-loader.md) | constructor(urls: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)>)constructor(urls: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)>, parent: [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html))constructor(urls: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)>, parent: [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html), factory: [URLStreamHandlerFactory](https://docs.oracle.com/javase/8/docs/api/java/net/URLStreamHandlerFactory.html)) | - -## Properties - -| Name | Summary | -|---|---| -| [name](index.md#-496928135%2FProperties%2F-2117262581) | val [name](index.md#-496928135%2FProperties%2F-2117262581): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | -| [parent](index.md#1459003258%2FProperties%2F-2117262581) | val [parent](index.md#1459003258%2FProperties%2F-2117262581): [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html) | -| [unnamedModule](index.md#1201644394%2FProperties%2F-2117262581) | val [unnamedModule](index.md#1201644394%2FProperties%2F-2117262581): [Module](https://docs.oracle.com/javase/8/docs/api/java/lang/Module.html) | - -## Functions - -| Name | Summary | -|---|---| -| [addURL2](add-u-r-l2.md) | public [addURL2](add-u-r-l2.md)(url: [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html))
a public version of URLClassLoader's addURL method | -| [clearAssertionStatus](index.md#1259311869%2FFunctions%2F-2117262581) | public [clearAssertionStatus](index.md#1259311869%2FFunctions%2F-2117262581)() | -| [close](index.md#-1447421798%2FFunctions%2F-2117262581) | public [close](index.md#-1447421798%2FFunctions%2F-2117262581)() | -| [findResource](index.md#-1760582852%2FFunctions%2F-2117262581) | public [findResource](index.md#-1760582852%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html) | -| [findResources](index.md#-356544095%2FFunctions%2F-2117262581) | public [findResources](index.md#-356544095%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Enumeration](https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)> | -| [getDefinedPackage](index.md#-1237778274%2FFunctions%2F-2117262581) | fun [getDefinedPackage](index.md#-1237778274%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Package](https://docs.oracle.com/javase/8/docs/api/java/lang/Package.html) | -| [getDefinedPackages](index.md#1895612036%2FFunctions%2F-2117262581) | fun [getDefinedPackages](index.md#1895612036%2FFunctions%2F-2117262581)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Package](https://docs.oracle.com/javase/8/docs/api/java/lang/Package.html)> | -| [getPlatformClassLoader](index.md#-1125909726%2FFunctions%2F-2117262581) | public [getPlatformClassLoader](index.md#-1125909726%2FFunctions%2F-2117262581)(): [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html) | -| [getResource](get-resource.md) | public [getResource](get-resource.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html) | -| [getResourceAsStream](get-resource-as-stream.md) | public [getResourceAsStream](get-resource-as-stream.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html) | -| [getResources](index.md#26826512%2FFunctions%2F-2117262581) | public [getResources](index.md#26826512%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Enumeration](https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)> | -| [getSystemClassLoader](index.md#1201052190%2FFunctions%2F-2117262581) | public [getSystemClassLoader](index.md#1201052190%2FFunctions%2F-2117262581)(): [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html) | -| [getSystemResource](index.md#-1625599170%2FFunctions%2F-2117262581) | public [getSystemResource](index.md#-1625599170%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html) | -| [getSystemResourceAsStream](index.md#-841312500%2FFunctions%2F-2117262581) | public [getSystemResourceAsStream](index.md#-841312500%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html) | -| [getSystemResources](index.md#-467017249%2FFunctions%2F-2117262581) | public [getSystemResources](index.md#-467017249%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Enumeration](https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)> | -| [getURLs](index.md#-293326280%2FFunctions%2F-2117262581) | public [getURLs](index.md#-293326280%2FFunctions%2F-2117262581)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)> | -| [isRegisteredAsParallelCapable](index.md#720218351%2FFunctions%2F-2117262581) | fun [isRegisteredAsParallelCapable](index.md#720218351%2FFunctions%2F-2117262581)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | -| [loadClass](load-class.md) | public [loadClass](load-class.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html)
Loads a local class first, if that fails continue with the ClassLoader.loadClass() parent delegation. | -| [newInstance](index.md#-18119435%2FFunctions%2F-2117262581) | public [newInstance](index.md#-18119435%2FFunctions%2F-2117262581)(urls: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)>, parent: [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html)): [URLClassLoader](https://docs.oracle.com/javase/8/docs/api/java/net/URLClassLoader.html) | -| [resources](index.md#110303916%2FFunctions%2F-2117262581) | public [resources](index.md#110303916%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Stream](https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)> | -| [setClassAssertionStatus](index.md#197864046%2FFunctions%2F-2117262581) | public [setClassAssertionStatus](index.md#197864046%2FFunctions%2F-2117262581)(className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), enabled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | -| [setDefaultAssertionStatus](index.md#776050745%2FFunctions%2F-2117262581) | public [setDefaultAssertionStatus](index.md#776050745%2FFunctions%2F-2117262581)(enabled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | -| [setPackageAssertionStatus](index.md#-849525892%2FFunctions%2F-2117262581) | public [setPackageAssertionStatus](index.md#-849525892%2FFunctions%2F-2117262581)(packageName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), enabled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | +# PHXURLClassLoader + + +public class [PHXURLClassLoader](index.md) : [URLClassLoader](https://docs.oracle.com/javase/8/docs/api/java/net/URLClassLoader.html) + +This class added a public method addURL2 that adds a URL to the search path, as well as overrides loadClass to do post-delegation class loading. + +## Constructors + +| | | +|---|---| +| [PHXURLClassLoader](-p-h-x-u-r-l-class-loader.md) | constructor(urls: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)>)constructor(urls: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)>, parent: [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html))constructor(urls: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)>, parent: [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html), factory: [URLStreamHandlerFactory](https://docs.oracle.com/javase/8/docs/api/java/net/URLStreamHandlerFactory.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [name](index.md#-496928135%2FProperties%2F-2117262581) | val [name](index.md#-496928135%2FProperties%2F-2117262581): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | +| [parent](index.md#1459003258%2FProperties%2F-2117262581) | val [parent](index.md#1459003258%2FProperties%2F-2117262581): [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html) | +| [unnamedModule](index.md#1201644394%2FProperties%2F-2117262581) | val [unnamedModule](index.md#1201644394%2FProperties%2F-2117262581): [Module](https://docs.oracle.com/javase/8/docs/api/java/lang/Module.html) | + +## Functions + +| Name | Summary | +|---|---| +| [addURL2](add-u-r-l2.md) | public [addURL2](add-u-r-l2.md)(url: [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html))
a public version of URLClassLoader's addURL method | +| [clearAssertionStatus](index.md#1259311869%2FFunctions%2F-2117262581) | public [clearAssertionStatus](index.md#1259311869%2FFunctions%2F-2117262581)() | +| [close](index.md#-1447421798%2FFunctions%2F-2117262581) | public [close](index.md#-1447421798%2FFunctions%2F-2117262581)() | +| [findResource](index.md#-1760582852%2FFunctions%2F-2117262581) | public [findResource](index.md#-1760582852%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html) | +| [findResources](index.md#-356544095%2FFunctions%2F-2117262581) | public [findResources](index.md#-356544095%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Enumeration](https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)> | +| [getDefinedPackage](index.md#-1237778274%2FFunctions%2F-2117262581) | fun [getDefinedPackage](index.md#-1237778274%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Package](https://docs.oracle.com/javase/8/docs/api/java/lang/Package.html) | +| [getDefinedPackages](index.md#1895612036%2FFunctions%2F-2117262581) | fun [getDefinedPackages](index.md#1895612036%2FFunctions%2F-2117262581)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Package](https://docs.oracle.com/javase/8/docs/api/java/lang/Package.html)> | +| [getPlatformClassLoader](index.md#-1125909726%2FFunctions%2F-2117262581) | public [getPlatformClassLoader](index.md#-1125909726%2FFunctions%2F-2117262581)(): [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html) | +| [getResource](get-resource.md) | public [getResource](get-resource.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html) | +| [getResourceAsStream](get-resource-as-stream.md) | public [getResourceAsStream](get-resource-as-stream.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html) | +| [getResources](index.md#26826512%2FFunctions%2F-2117262581) | public [getResources](index.md#26826512%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Enumeration](https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)> | +| [getSystemClassLoader](index.md#1201052190%2FFunctions%2F-2117262581) | public [getSystemClassLoader](index.md#1201052190%2FFunctions%2F-2117262581)(): [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html) | +| [getSystemResource](index.md#-1625599170%2FFunctions%2F-2117262581) | public [getSystemResource](index.md#-1625599170%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html) | +| [getSystemResourceAsStream](index.md#-841312500%2FFunctions%2F-2117262581) | public [getSystemResourceAsStream](index.md#-841312500%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html) | +| [getSystemResources](index.md#-467017249%2FFunctions%2F-2117262581) | public [getSystemResources](index.md#-467017249%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Enumeration](https://docs.oracle.com/javase/8/docs/api/java/util/Enumeration.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)> | +| [getURLs](index.md#-293326280%2FFunctions%2F-2117262581) | public [getURLs](index.md#-293326280%2FFunctions%2F-2117262581)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)> | +| [isRegisteredAsParallelCapable](index.md#720218351%2FFunctions%2F-2117262581) | fun [isRegisteredAsParallelCapable](index.md#720218351%2FFunctions%2F-2117262581)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [loadClass](load-class.md) | public [loadClass](load-class.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html)
Loads a local class first, if that fails continue with the ClassLoader.loadClass() parent delegation. | +| [newInstance](index.md#-18119435%2FFunctions%2F-2117262581) | public [newInstance](index.md#-18119435%2FFunctions%2F-2117262581)(urls: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)>, parent: [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html)): [URLClassLoader](https://docs.oracle.com/javase/8/docs/api/java/net/URLClassLoader.html) | +| [resources](index.md#110303916%2FFunctions%2F-2117262581) | public [resources](index.md#110303916%2FFunctions%2F-2117262581)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Stream](https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html)<[URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html)> | +| [setClassAssertionStatus](index.md#197864046%2FFunctions%2F-2117262581) | public [setClassAssertionStatus](index.md#197864046%2FFunctions%2F-2117262581)(className: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), enabled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | +| [setDefaultAssertionStatus](index.md#776050745%2FFunctions%2F-2117262581) | public [setDefaultAssertionStatus](index.md#776050745%2FFunctions%2F-2117262581)(enabled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | +| [setPackageAssertionStatus](index.md#-849525892%2FFunctions%2F-2117262581) | public [setPackageAssertionStatus](index.md#-849525892%2FFunctions%2F-2117262581)(packageName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), enabled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/load-class.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/load-class.md index a1b0025c8a..6b6c0ecde3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/load-class.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/load-class.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[PHXURLClassLoader](index.md)/[loadClass](load-class.md) - -# loadClass - - -public [loadClass](load-class.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html) - -Loads a local class first, if that fails continue with the ClassLoader.loadClass() parent delegation. - -#### Return - -The resulting `Class` object - -#### Parameters - - - -| | | -|---|---| -| name | The [binary name](#name) of the class | - -#### Throws - -| | | -|---|---| -| [ClassNotFoundException](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassNotFoundException.html) | If the class was not found | +# loadClass + + +public [loadClass](load-class.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html) + +Loads a local class first, if that fails continue with the ClassLoader.loadClass() parent delegation. + +#### Return + +The resulting `Class` object + +#### Parameters + + + +| | | +|---|---| +| name | The [binary name](#name) of the class | + +#### Throws + +| | | +|---|---| +| [ClassNotFoundException](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassNotFoundException.html) | If the class was not found | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/-value-holder.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/-value-holder.md index 3c1406d95c..5e9427a46b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/-value-holder.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/-value-holder.md @@ -1,13 +1,11 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[ValueHolder](index.md)/[ValueHolder](-value-holder.md) - -# ValueHolder - - -constructor() - -Default constructor; sets [value](value.md) to null. - - -constructor(value: [T](index.md)) - -Constructor with an initial value. +# ValueHolder + + +constructor() + +Default constructor; sets [value](value.md) to null. + + +constructor(value: [T](index.md)) + +Constructor with an initial value. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/index.md index 3a33818bab..7bdbabb7d9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/index.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[ValueHolder](index.md) - -# ValueHolder - - -public class [ValueHolder](index.md)<[T](index.md)> - -Object that allows pass-by-reference. Pass this object and have the called method set the [value](value.md) member. - -#### Author - -Dave - -## Constructors - -| | | -|---|---| -| [ValueHolder](-value-holder.md) | constructor()
Default constructor; sets [value](value.md) to null.
constructor(value: [T](index.md))
Constructor with an initial value. | - -## Properties - -| Name | Summary | -|---|---| -| [value](value.md) | open var [value](value.md): [T](index.md)
The value being held. | +# ValueHolder + + +public class [ValueHolder](index.md)<[T](index.md)> + +Object that allows pass-by-reference. Pass this object and have the called method set the [value](value.md) member. + +#### Author + +Dave + +## Constructors + +| | | +|---|---| +| [ValueHolder](-value-holder.md) | constructor()
Default constructor; sets [value](value.md) to null.
constructor(value: [T](index.md))
Constructor with an initial value. | + +## Properties + +| Name | Summary | +|---|---| +| [value](value.md) | open var [value](value.md): [T](index.md)
The value being held. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/value.md index 38a2652672..0c5c2b643d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/value.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter.util](../index.md)/[ValueHolder](index.md)/[value](value.md) - -# value - - -open var [value](value.md): [T](index.md) - -The value being held. +# value + + +open var [value](value.md): [T](index.md) + +The value being held. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/index.md index 36fe20c271..76efd77fa5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter.util/index.md @@ -1,20 +1,18 @@ -//[mc_api](../../index.md)/[com.phoenix_int.ModelCenter.util](index.md) - -# Package-level declarations - -## Types - -| Name | Summary | -|---|---| -| [BeanshellUtil](-beanshell-util/index.md) | public class [BeanshellUtil](-beanshell-util/index.md)
Utility class to execute any arbitrary Beanshell script from native code and return an object that can be accessed via JNI. | -| [LoggerUpdater](-logger-updater/index.md) | public class [LoggerUpdater](-logger-updater/index.md)
This class is called by the Java logging infrastructure to notify the the C++ logger it update its local logging level. | -| [PHXCOMObject](-p-h-x-c-o-m-object/index.md) | public class [PHXCOMObject](-p-h-x-c-o-m-object/index.md)
This is a base class for Java objects that mirror ModelCenter COM objects | -| [PHXCOMObjectHolder](-p-h-x-c-o-m-object-holder/index.md) | public class [PHXCOMObjectHolder](-p-h-x-c-o-m-object-holder/index.md)<[T](-p-h-x-c-o-m-object-holder/index.md) : [PHXCOMObject](-p-h-x-c-o-m-object/index.md)?> | -| [PHXEquationParser](-p-h-x-equation-parser/index.md) | public class [PHXEquationParser](-p-h-x-equation-parser/index.md) | -| [PHXIOConsole](-p-h-x-i-o-console/index.md) | public class [PHXIOConsole](-p-h-x-i-o-console/index.md) : [ActionListener](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionListener.html)
A utility class for redirecting IO to a window | -| [PHXJarLocation](-p-h-x-jar-location/index.md) | public class [PHXJarLocation](-p-h-x-jar-location/index.md) | -| [PHXMCJarLoader](-p-h-x-m-c-jar-loader/index.md) | public class [PHXMCJarLoader](-p-h-x-m-c-jar-loader/index.md) : [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html)
This class reads a jar file and automatically loads all of its .class files. | -| [PHXPlugInLauncher](-p-h-x-plug-in-launcher/index.md) | public class [PHXPlugInLauncher](-p-h-x-plug-in-launcher/index.md)
Upgraded, thread-safe, etc. | -| [PHXReferenceMonitor](-p-h-x-reference-monitor/index.md) | public class [PHXReferenceMonitor](-p-h-x-reference-monitor/index.md) : [ActionListener](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionListener.html), [ListSelectionListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/event/ListSelectionListener.html), [WindowListener](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowListener.html), [ItemListener](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ItemListener.html)
A utility class for showing active COM references from PHXCOMObject | -| [PHXURLClassLoader](-p-h-x-u-r-l-class-loader/index.md) | public class [PHXURLClassLoader](-p-h-x-u-r-l-class-loader/index.md) : [URLClassLoader](https://docs.oracle.com/javase/8/docs/api/java/net/URLClassLoader.html)
This class added a public method addURL2 that adds a URL to the search path, as well as overrides loadClass to do post-delegation class loading. | -| [ValueHolder](-value-holder/index.md) | public class [ValueHolder](-value-holder/index.md)<[T](-value-holder/index.md)>
Object that allows pass-by-reference. | +# Package-level declarations + +## Types + +| Name | Summary | +|---|---| +| [BeanshellUtil](-beanshell-util/index.md) | public class [BeanshellUtil](-beanshell-util/index.md)
Utility class to execute any arbitrary Beanshell script from native code and return an object that can be accessed via JNI. | +| [LoggerUpdater](-logger-updater/index.md) | public class [LoggerUpdater](-logger-updater/index.md)
This class is called by the Java logging infrastructure to notify the the C++ logger it update its local logging level. | +| [PHXCOMObject](-p-h-x-c-o-m-object/index.md) | public class [PHXCOMObject](-p-h-x-c-o-m-object/index.md)
This is a base class for Java objects that mirror ModelCenter COM objects | +| [PHXCOMObjectHolder](-p-h-x-c-o-m-object-holder/index.md) | public class [PHXCOMObjectHolder](-p-h-x-c-o-m-object-holder/index.md)<[T](-p-h-x-c-o-m-object-holder/index.md) : [PHXCOMObject](-p-h-x-c-o-m-object/index.md)?> | +| [PHXEquationParser](-p-h-x-equation-parser/index.md) | public class [PHXEquationParser](-p-h-x-equation-parser/index.md) | +| [PHXIOConsole](-p-h-x-i-o-console/index.md) | public class [PHXIOConsole](-p-h-x-i-o-console/index.md) : [ActionListener](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionListener.html)
A utility class for redirecting IO to a window | +| [PHXJarLocation](-p-h-x-jar-location/index.md) | public class [PHXJarLocation](-p-h-x-jar-location/index.md) | +| [PHXMCJarLoader](-p-h-x-m-c-jar-loader/index.md) | public class [PHXMCJarLoader](-p-h-x-m-c-jar-loader/index.md) : [ClassLoader](https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html)
This class reads a jar file and automatically loads all of its .class files. | +| [PHXPlugInLauncher](-p-h-x-plug-in-launcher/index.md) | public class [PHXPlugInLauncher](-p-h-x-plug-in-launcher/index.md)
Upgraded, thread-safe, etc. | +| [PHXReferenceMonitor](-p-h-x-reference-monitor/index.md) | public class [PHXReferenceMonitor](-p-h-x-reference-monitor/index.md) : [ActionListener](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionListener.html), [ListSelectionListener](https://docs.oracle.com/javase/8/docs/api/javax/swing/event/ListSelectionListener.html), [WindowListener](https://docs.oracle.com/javase/8/docs/api/java/awt/event/WindowListener.html), [ItemListener](https://docs.oracle.com/javase/8/docs/api/java/awt/event/ItemListener.html)
A utility class for showing active COM references from PHXCOMObject | +| [PHXURLClassLoader](-p-h-x-u-r-l-class-loader/index.md) | public class [PHXURLClassLoader](-p-h-x-u-r-l-class-loader/index.md) : [URLClassLoader](https://docs.oracle.com/javase/8/docs/api/java/net/URLClassLoader.html)
This class added a public method addURL2 that adds a URL to the search path, as well as overrides loadClass to do post-delegation class loading. | +| [ValueHolder](-value-holder/index.md) | public class [ValueHolder](-value-holder/index.md)<[T](-value-holder/index.md)>
Object that allows pass-by-reference. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/-add-to-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/-add-to-model.md index 7a99f3e9c9..f8f1c495d2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/-add-to-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/-add-to-model.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[AddToModel](-add-to-model.md) - -# AddToModel - - -constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) +# AddToModel + + +constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-input.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-input.md index e29d0e86d1..36841ff887 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-input.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-input.md @@ -1,44 +1,42 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[addInput](add-input.md) - -# addInput - - -public [addInput](add-input.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) - -adds a pending input to the component. - - Valid types of variables are listed below. Add [] to the end of the type name to indicate an array of that type. - -- double - double -- int - integer -- string - string -- bool - boolean -- ref - reference -- file - A binary or ascii file. -- quad - Quad Facet Geometry, a geometry type composed of multiple quadrilaterals. -- sor - Surface of Revolution, a geometry type defined by a profile curve rotated about an axis. -- nurbs - A geometry type for NURBS. -- bspline - A geometry type for B-Spline curves. -- ruled - A geometry type for ruled surfaces. -- skinned - A geometry type for skinned surfaces. -- node - A geometry type for displaying multiple points in space. - -#### Return - -pointer to the variable object - -#### Parameters - - - -| | | -|---|---| -| name | the name of the variable | -| type | the type of the variable | -| value | the value of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addInput + + +public [addInput](add-input.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) + +adds a pending input to the component. + + Valid types of variables are listed below. Add [] to the end of the type name to indicate an array of that type. + +- double - double +- int - integer +- string - string +- bool - boolean +- ref - reference +- file - A binary or ascii file. +- quad - Quad Facet Geometry, a geometry type composed of multiple quadrilaterals. +- sor - Surface of Revolution, a geometry type defined by a profile curve rotated about an axis. +- nurbs - A geometry type for NURBS. +- bspline - A geometry type for B-Spline curves. +- ruled - A geometry type for ruled surfaces. +- skinned - A geometry type for skinned surfaces. +- node - A geometry type for displaying multiple points in space. + +#### Return + +pointer to the variable object + +#### Parameters + + + +| | | +|---|---| +| name | the name of the variable | +| type | the type of the variable | +| value | the value of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-input2.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-input2.md index 518dc934c3..4f3e576276 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-input2.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-input2.md @@ -1,45 +1,43 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[addInput2](add-input2.md) - -# addInput2 - - -public [addInput2](add-input2.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), classURL: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) - -adds a pending input to the component. - - Valid types of variables are listed below. Add [] to the end of the type name to indicate an array of that type. - -- double - double -- int - integer -- string - string -- bool - boolean -- ref - reference -- file - A binary or ascii file. -- quad - Quad Facet Geometry, a geometry type composed of multiple quadrilaterals. -- sor - Surface of Revolution, a geometry type defined by a profile curve rotated about an axis. -- nurbs - A geometry type for NURBS. -- bspline - A geometry type for B-Spline curves. -- ruled - A geometry type for ruled surfaces. -- skinned - A geometry type for skinned surfaces. -- node - A geometry type for displaying multiple points in space. - -#### Return - -pointer to the variable object - -#### Parameters - - - -| | | -|---|---| -| name | the name of the variable | -| type | the type of the variable | -| classURL | class of the object variable. Empty string for non-object variable | -| value | the value of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addInput2 + + +public [addInput2](add-input2.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), classURL: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) + +adds a pending input to the component. + + Valid types of variables are listed below. Add [] to the end of the type name to indicate an array of that type. + +- double - double +- int - integer +- string - string +- bool - boolean +- ref - reference +- file - A binary or ascii file. +- quad - Quad Facet Geometry, a geometry type composed of multiple quadrilaterals. +- sor - Surface of Revolution, a geometry type defined by a profile curve rotated about an axis. +- nurbs - A geometry type for NURBS. +- bspline - A geometry type for B-Spline curves. +- ruled - A geometry type for ruled surfaces. +- skinned - A geometry type for skinned surfaces. +- node - A geometry type for displaying multiple points in space. + +#### Return + +pointer to the variable object + +#### Parameters + + + +| | | +|---|---| +| name | the name of the variable | +| type | the type of the variable | +| classURL | class of the object variable. Empty string for non-object variable | +| value | the value of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-method.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-method.md index b1949207cd..d65f59b63e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-method.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-method.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[addMethod](add-method.md) - -# addMethod - - -public [addMethod](add-method.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), displayName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Adds the method - -#### Parameters - - - -| | | -|---|---| -| name | method to be added | -| displayName | The name the user wants displayed in the component menu | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addMethod + + +public [addMethod](add-method.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), displayName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Adds the method + +#### Parameters + + + +| | | +|---|---| +| name | method to be added | +| displayName | The name the user wants displayed in the component menu | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-output.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-output.md index 65be515cfe..da587b1f89 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-output.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-output.md @@ -1,44 +1,42 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[addOutput](add-output.md) - -# addOutput - - -public [addOutput](add-output.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) - -adds a pending output to the component - - Valid types of variables are listed below. Add [] to the end of the type name to indicate an array of that type. - -- double - double -- int - integer -- string - string -- bool - boolean -- ref - reference -- file - A binary or ascii file. -- quad - Quad Facet Geometry, a geometry type composed of multiple quadrilaterals. -- sor - Surface of Revolution, a geometry type defined by a profile curve rotated about an axis. -- nurbs - A geometry type for NURBS. -- bspline - A geometry type for B-Spline curves. -- ruled - A geometry type for ruled surfaces. -- skinned - A geometry type for skinned surfaces. -- node - A geometry type for displaying multiple points in space. - -#### Return - -pointer to the variable object - -#### Parameters - - - -| | | -|---|---| -| name | the name of the variable | -| type | the type of the variable | -| value | the value of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addOutput + + +public [addOutput](add-output.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) + +adds a pending output to the component + + Valid types of variables are listed below. Add [] to the end of the type name to indicate an array of that type. + +- double - double +- int - integer +- string - string +- bool - boolean +- ref - reference +- file - A binary or ascii file. +- quad - Quad Facet Geometry, a geometry type composed of multiple quadrilaterals. +- sor - Surface of Revolution, a geometry type defined by a profile curve rotated about an axis. +- nurbs - A geometry type for NURBS. +- bspline - A geometry type for B-Spline curves. +- ruled - A geometry type for ruled surfaces. +- skinned - A geometry type for skinned surfaces. +- node - A geometry type for displaying multiple points in space. + +#### Return + +pointer to the variable object + +#### Parameters + + + +| | | +|---|---| +| name | the name of the variable | +| type | the type of the variable | +| value | the value of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-output2.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-output2.md index 9c79857291..2ee9061b43 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-output2.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-output2.md @@ -1,45 +1,43 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[addOutput2](add-output2.md) - -# addOutput2 - - -public [addOutput2](add-output2.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), classURL: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) - -adds a pending output to the component - - Valid types of variables are listed below. Add [] to the end of the type name to indicate an array of that type. - -- double - double -- int - integer -- string - string -- bool - boolean -- ref - reference -- file - A binary or ascii file. -- quad - Quad Facet Geometry, a geometry type composed of multiple quadrilaterals. -- sor - Surface of Revolution, a geometry type defined by a profile curve rotated about an axis. -- nurbs - A geometry type for NURBS. -- bspline - A geometry type for B-Spline curves. -- ruled - A geometry type for ruled surfaces. -- skinned - A geometry type for skinned surfaces. -- node - A geometry type for displaying multiple points in space. - -#### Return - -pointer to the variable object - -#### Parameters - - - -| | | -|---|---| -| name | the name of the variable | -| type | the type of the variable | -| classURL | class of the object variable. If an empty string is passed, PHXNonStrictType will be used. | -| value | the value of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addOutput2 + + +public [addOutput2](add-output2.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), classURL: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) + +adds a pending output to the component + + Valid types of variables are listed below. Add [] to the end of the type name to indicate an array of that type. + +- double - double +- int - integer +- string - string +- bool - boolean +- ref - reference +- file - A binary or ascii file. +- quad - Quad Facet Geometry, a geometry type composed of multiple quadrilaterals. +- sor - Surface of Revolution, a geometry type defined by a profile curve rotated about an axis. +- nurbs - A geometry type for NURBS. +- bspline - A geometry type for B-Spline curves. +- ruled - A geometry type for ruled surfaces. +- skinned - A geometry type for skinned surfaces. +- node - A geometry type for displaying multiple points in space. + +#### Return + +pointer to the variable object + +#### Parameters + + + +| | | +|---|---| +| name | the name of the variable | +| type | the type of the variable | +| classURL | class of the object variable. If an empty string is passed, PHXNonStrictType will be used. | +| value | the value of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-to-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-to-model.md index a8cfcbee3c..a956488be1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-to-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-to-model.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[addToModel](add-to-model.md) - -# addToModel - - -public [addToModel](add-to-model.md)() - -adds a new component to the Model - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addToModel + + +public [addToModel](add-to-model.md)() + +adds a new component to the Model + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-to-model2.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-to-model2.md index 6d0b4db3fc..effa682f49 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-to-model2.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-to-model2.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[addToModel2](add-to-model2.md) - -# addToModel2 - - -public [addToModel2](add-to-model2.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -adds a new component to the Model - -#### Return - -true if the add operation was successful; false otherwise - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addToModel2 + + +public [addToModel2](add-to-model2.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +adds a new component to the Model + +#### Return + +true if the add operation was successful; false otherwise + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-to-model3.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-to-model3.md index 852edd7b1b..5d55fa19f0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-to-model3.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-to-model3.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[addToModel3](add-to-model3.md) - -# addToModel3 - - -public [addToModel3](add-to-model3.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) +# addToModel3 + + +public [addToModel3](add-to-model3.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/clear-busy-flag.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/clear-busy-flag.md index 84730ecdd9..1d801713ac 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/clear-busy-flag.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/clear-busy-flag.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[clearBusyFlag](clear-busy-flag.md) - -# clearBusyFlag - - -public [clearBusyFlag](clear-busy-flag.md)() - -clears the busy state if an Exception is encountered in addInput() or addOutput() - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# clearBusyFlag + + +public [clearBusyFlag](clear-busy-flag.md)() + +clears the busy state if an Exception is encountered in addInput() or addOutput() + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-auto-run.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-auto-run.md index c2f642902b..4cb828bb88 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-auto-run.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-auto-run.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[getAutoRun](get-auto-run.md) - -# getAutoRun - - -public [getAutoRun](get-auto-run.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -returns the current autorun flag - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getAutoRun + + +public [getAutoRun](get-auto-run.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +returns the current autorun flag + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-component.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-component.md index d416a59f7b..3f2ca082e7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-component.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-component.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[getComponent](get-component.md) - -# getComponent - - -public [getComponent](get-component.md)(): [Component](../-component/index.md) - -gets the component object associated with this object - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getComponent + + +public [getComponent](get-component.md)(): [Component](../-component/index.md) + +gets the component object associated with this object + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-prevalidate-inputs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-prevalidate-inputs.md index e16c282603..a0771dd39a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-prevalidate-inputs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-prevalidate-inputs.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[getPrevalidateInputs](get-prevalidate-inputs.md) - -# getPrevalidateInputs - - -public [getPrevalidateInputs](get-prevalidate-inputs.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -returns the current prevalidate inputs flag - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getPrevalidateInputs + + +public [getPrevalidateInputs](get-prevalidate-inputs.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +returns the current prevalidate inputs flag + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-prog-i-d.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-prog-i-d.md index f3deee8c55..b6ea95a08d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-prog-i-d.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-prog-i-d.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[getProgID](get-prog-i-d.md) - -# getProgID - - -public [getProgID](get-prog-i-d.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the "ProgID" registry entry associated with this Plug-In - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getProgID + + +public [getProgID](get-prog-i-d.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the "ProgID" registry entry associated with this Plug-In + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-reg-i-d.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-reg-i-d.md index f6254a15a2..8914dcbc57 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-reg-i-d.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-reg-i-d.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[getRegID](get-reg-i-d.md) - -# getRegID - - -public [getRegID](get-reg-i-d.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the registry id associated with this Plug-In - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getRegID + + +public [getRegID](get-reg-i-d.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the registry id associated with this Plug-In + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/index.md index 2a5c597512..1cf6dcf6ad 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/index.md @@ -1,52 +1,50 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md) - -# AddToModel - - -public class [AddToModel](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -This is the wrapper class that handles the native COM calls to a AddToModel object. The class is used by Java plug-ins to ModelCenter. - -#### Author - -Woyak, 10-01 - -## Constructors - -| | | -|---|---| -| [AddToModel](-add-to-model.md) | constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | - -## Functions - -| Name | Summary | -|---|---| -| [addInput](add-input.md) | public [addInput](add-input.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
adds a pending input to the component. | -| [addInput2](add-input2.md) | public [addInput2](add-input2.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), classURL: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
adds a pending input to the component. | -| [addMethod](add-method.md) | public [addMethod](add-method.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), displayName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Adds the method | -| [addOutput](add-output.md) | public [addOutput](add-output.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
adds a pending output to the component Valid types of variables are listed below. | -| [addOutput2](add-output2.md) | public [addOutput2](add-output2.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), classURL: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
adds a pending output to the component Valid types of variables are listed below. | -| [addToModel](add-to-model.md) | public [addToModel](add-to-model.md)()
adds a new component to the Model | -| [addToModel2](add-to-model2.md) | public [addToModel2](add-to-model2.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
adds a new component to the Model | -| [addToModel3](add-to-model3.md) | public [addToModel3](add-to-model3.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | -| [clearBusyFlag](clear-busy-flag.md) | public [clearBusyFlag](clear-busy-flag.md)()
clears the busy state if an Exception is encountered in addInput() or addOutput() | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [getAutoRun](get-auto-run.md) | public [getAutoRun](get-auto-run.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
returns the current autorun flag | -| [getComponent](get-component.md) | public [getComponent](get-component.md)(): [Component](../-component/index.md)
gets the component object associated with this object | -| [getPrevalidateInputs](get-prevalidate-inputs.md) | public [getPrevalidateInputs](get-prevalidate-inputs.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
returns the current prevalidate inputs flag | -| [getProgID](get-prog-i-d.md) | public [getProgID](get-prog-i-d.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the "ProgID" registry entry associated with this Plug-In | -| [getRegID](get-reg-i-d.md) | public [getRegID](get-reg-i-d.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the registry id associated with this Plug-In | -| [newInstance](new-instance.md) | public [newInstance](new-instance.md)(): [AddToModel](index.md)
creates a new AddToModel object (that is connected to the same ModelCenter session) that is not currently attached to any thread. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setAuthor](set-author.md) | public [setAuthor](set-author.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Plug-In author | -| [setAutoRun](set-auto-run.md) | public [setAutoRun](set-auto-run.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the current autorun flag | -| [setComponentRequirements](set-component-requirements.md) | public [setComponentRequirements](set-component-requirements.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Plug-In requirements | -| [setDescription](set-description.md) | public [setDescription](set-description.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Plug-In description | -| [setHelpURL](set-help-u-r-l.md) | public [setHelpURL](set-help-u-r-l.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Plug-In help URL | -| [setIcon](set-icon.md) | public [setIcon](set-icon.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Plug-In icon | -| [setKeywords](set-keywords.md) | public [setKeywords](set-keywords.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Plug-In keywords | -| [setPrevalidateInputs](set-prevalidate-inputs.md) | public [setPrevalidateInputs](set-prevalidate-inputs.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the current prevalidate inputs flag | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setVersion](set-version.md) | public [setVersion](set-version.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Plug-In version | -| [updateComponent](update-component.md) | public [updateComponent](update-component.md)()
Reinitializes the inputs and outputs of a Component Plug-In. | +# AddToModel + + +public class [AddToModel](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +This is the wrapper class that handles the native COM calls to a AddToModel object. The class is used by Java plug-ins to ModelCenter. + +#### Author + +Woyak, 10-01 + +## Constructors + +| | | +|---|---| +| [AddToModel](-add-to-model.md) | constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | + +## Functions + +| Name | Summary | +|---|---| +| [addInput](add-input.md) | public [addInput](add-input.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
adds a pending input to the component. | +| [addInput2](add-input2.md) | public [addInput2](add-input2.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), classURL: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
adds a pending input to the component. | +| [addMethod](add-method.md) | public [addMethod](add-method.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), displayName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Adds the method | +| [addOutput](add-output.md) | public [addOutput](add-output.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
adds a pending output to the component Valid types of variables are listed below. | +| [addOutput2](add-output2.md) | public [addOutput2](add-output2.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), classURL: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
adds a pending output to the component Valid types of variables are listed below. | +| [addToModel](add-to-model.md) | public [addToModel](add-to-model.md)()
adds a new component to the Model | +| [addToModel2](add-to-model2.md) | public [addToModel2](add-to-model2.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
adds a new component to the Model | +| [addToModel3](add-to-model3.md) | public [addToModel3](add-to-model3.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | +| [clearBusyFlag](clear-busy-flag.md) | public [clearBusyFlag](clear-busy-flag.md)()
clears the busy state if an Exception is encountered in addInput() or addOutput() | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [getAutoRun](get-auto-run.md) | public [getAutoRun](get-auto-run.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
returns the current autorun flag | +| [getComponent](get-component.md) | public [getComponent](get-component.md)(): [Component](../-component/index.md)
gets the component object associated with this object | +| [getPrevalidateInputs](get-prevalidate-inputs.md) | public [getPrevalidateInputs](get-prevalidate-inputs.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
returns the current prevalidate inputs flag | +| [getProgID](get-prog-i-d.md) | public [getProgID](get-prog-i-d.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the "ProgID" registry entry associated with this Plug-In | +| [getRegID](get-reg-i-d.md) | public [getRegID](get-reg-i-d.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the registry id associated with this Plug-In | +| [newInstance](new-instance.md) | public [newInstance](new-instance.md)(): [AddToModel](index.md)
creates a new AddToModel object (that is connected to the same ModelCenter session) that is not currently attached to any thread. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setAuthor](set-author.md) | public [setAuthor](set-author.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Plug-In author | +| [setAutoRun](set-auto-run.md) | public [setAutoRun](set-auto-run.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the current autorun flag | +| [setComponentRequirements](set-component-requirements.md) | public [setComponentRequirements](set-component-requirements.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Plug-In requirements | +| [setDescription](set-description.md) | public [setDescription](set-description.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Plug-In description | +| [setHelpURL](set-help-u-r-l.md) | public [setHelpURL](set-help-u-r-l.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Plug-In help URL | +| [setIcon](set-icon.md) | public [setIcon](set-icon.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Plug-In icon | +| [setKeywords](set-keywords.md) | public [setKeywords](set-keywords.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Plug-In keywords | +| [setPrevalidateInputs](set-prevalidate-inputs.md) | public [setPrevalidateInputs](set-prevalidate-inputs.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the current prevalidate inputs flag | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setVersion](set-version.md) | public [setVersion](set-version.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Plug-In version | +| [updateComponent](update-component.md) | public [updateComponent](update-component.md)()
Reinitializes the inputs and outputs of a Component Plug-In. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/new-instance.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/new-instance.md index 6b0cfc8f0a..74a2ae67ce 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/new-instance.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/new-instance.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[newInstance](new-instance.md) - -# newInstance - - -public [newInstance](new-instance.md)(): [AddToModel](index.md) - -creates a new AddToModel object (that is connected to the same ModelCenter session) that is not currently attached to any thread. Use this method if you need to call AddToModel from multiple threads. The spawning thread should call this function for each thread that needs to call AddToModel. The new instance should be passed to the spawned thread and used there. - -#### Return - -a AddToModel instance that is not attached to any thread - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# newInstance + + +public [newInstance](new-instance.md)(): [AddToModel](index.md) + +creates a new AddToModel object (that is connected to the same ModelCenter session) that is not currently attached to any thread. Use this method if you need to call AddToModel from multiple threads. The spawning thread should call this function for each thread that needs to call AddToModel. The new instance should be passed to the spawned thread and used there. + +#### Return + +a AddToModel instance that is not attached to any thread + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-author.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-author.md index 14e27991c2..d254fba444 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-author.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-author.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[setAuthor](set-author.md) - -# setAuthor - - -public [setAuthor](set-author.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the Plug-In author - -#### Parameters - - - -| | | -|---|---| -| str | meta data string | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setAuthor + + +public [setAuthor](set-author.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the Plug-In author + +#### Parameters + + + +| | | +|---|---| +| str | meta data string | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-auto-run.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-auto-run.md index 954e657d62..b58837f494 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-auto-run.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-auto-run.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[setAutoRun](set-auto-run.md) - -# setAutoRun - - -public [setAutoRun](set-auto-run.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets the current autorun flag - -#### Parameters - - - -| | | -|---|---| -| flag | true or false | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setAutoRun + + +public [setAutoRun](set-auto-run.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets the current autorun flag + +#### Parameters + + + +| | | +|---|---| +| flag | true or false | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-component-requirements.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-component-requirements.md index 4b7ededddb..7dc229cd01 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-component-requirements.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-component-requirements.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[setComponentRequirements](set-component-requirements.md) - -# setComponentRequirements - - -public [setComponentRequirements](set-component-requirements.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the Plug-In requirements - -#### Parameters - - - -| | | -|---|---| -| str | A comma separated list of requirement specifiers for this Plug-In. | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setComponentRequirements + + +public [setComponentRequirements](set-component-requirements.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the Plug-In requirements + +#### Parameters + + + +| | | +|---|---| +| str | A comma separated list of requirement specifiers for this Plug-In. | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-description.md index 0d6f562f68..3898503547 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-description.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[setDescription](set-description.md) - -# setDescription - - -public [setDescription](set-description.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the Plug-In description - -#### Parameters - - - -| | | -|---|---| -| str | meta data string | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDescription + + +public [setDescription](set-description.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the Plug-In description + +#### Parameters + + + +| | | +|---|---| +| str | meta data string | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-help-u-r-l.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-help-u-r-l.md index 29e6f7838a..6f1eca9046 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-help-u-r-l.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-help-u-r-l.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[setHelpURL](set-help-u-r-l.md) - -# setHelpURL - - -public [setHelpURL](set-help-u-r-l.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the Plug-In help URL - -#### Parameters - - - -| | | -|---|---| -| str | meta data string | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setHelpURL + + +public [setHelpURL](set-help-u-r-l.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the Plug-In help URL + +#### Parameters + + + +| | | +|---|---| +| str | meta data string | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-icon.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-icon.md index 93d5affc59..08d8bf5239 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-icon.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-icon.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[setIcon](set-icon.md) - -# setIcon - - -public [setIcon](set-icon.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the Plug-In icon - -#### Parameters - - - -| | | -|---|---| -| str | icon location | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setIcon + + +public [setIcon](set-icon.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the Plug-In icon + +#### Parameters + + + +| | | +|---|---| +| str | icon location | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-keywords.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-keywords.md index b256ae2600..9a8483cbf0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-keywords.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-keywords.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[setKeywords](set-keywords.md) - -# setKeywords - - -public [setKeywords](set-keywords.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the Plug-In keywords - -#### Parameters - - - -| | | -|---|---| -| str | meta data string | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setKeywords + + +public [setKeywords](set-keywords.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the Plug-In keywords + +#### Parameters + + + +| | | +|---|---| +| str | meta data string | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-prevalidate-inputs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-prevalidate-inputs.md index 836d654032..268ca405f0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-prevalidate-inputs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-prevalidate-inputs.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[setPrevalidateInputs](set-prevalidate-inputs.md) - -# setPrevalidateInputs - - -public [setPrevalidateInputs](set-prevalidate-inputs.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets the current prevalidate inputs flag - -#### Parameters - - - -| | | -|---|---| -| flag | true or false | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setPrevalidateInputs + + +public [setPrevalidateInputs](set-prevalidate-inputs.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets the current prevalidate inputs flag + +#### Parameters + + + +| | | +|---|---| +| flag | true or false | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-version.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-version.md index d6812c9d37..41f3af99d0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-version.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-version.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[setVersion](set-version.md) - -# setVersion - - -public [setVersion](set-version.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the Plug-In version - -#### Parameters - - - -| | | -|---|---| -| str | meta data string | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setVersion + + +public [setVersion](set-version.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the Plug-In version + +#### Parameters + + + +| | | +|---|---| +| str | meta data string | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/update-component.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/update-component.md index 444fb79a09..a62dbd2855 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/update-component.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-add-to-model/update-component.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[AddToModel](index.md)/[updateComponent](update-component.md) - -# updateComponent - - -public [updateComponent](update-component.md)() - -Reinitializes the inputs and outputs of a Component Plug-In. The addInput() and addOutput() methods must be called for each input and output for the new configuration before calling updateComponent(). This method is not allowed to be called in the run() method. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# updateComponent + + +public [updateComponent](update-component.md)() + +Reinitializes the inputs and outputs of a Component Plug-In. The addInput() and addOutput() methods must be called for each input and output for the new configuration before calling updateComponent(). This method is not allowed to be called in the run() method. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/from-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/from-string.md index 93ced9ac8b..e34a956ffe 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/from-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/from-string.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Array](index.md)/[fromString](from-string.md) - -# fromString - - -public [fromString](from-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value for the variable from a string - -#### Parameters - - - -| | | -|---|---| -| value | the value | -| index | the array element to set (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# fromString + + +public [fromString](from-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value for the variable from a string + +#### Parameters + + + +| | | +|---|---| +| value | the value | +| index | the array element to set (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-auto-size.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-auto-size.md index 9731fad460..70c69978a6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-auto-size.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-auto-size.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Array](index.md)/[getAutoSize](get-auto-size.md) - -# getAutoSize - - -public [getAutoSize](get-auto-size.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the autoSize flag. If true, the array will automatically resize to arrays it is linked to. - -#### Return - -the autoSize flag - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getAutoSize + + +public [getAutoSize](get-auto-size.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the autoSize flag. If true, the array will automatically resize to arrays it is linked to. + +#### Return + +the autoSize flag + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-dimensions.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-dimensions.md index b542a505df..a42679fd3c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-dimensions.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-dimensions.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Array](index.md)/[getDimensions](get-dimensions.md) - -# getDimensions - - -public [getDimensions](get-dimensions.md)(): [Variant](../-variant/index.md) - -gets the dimensions of an array - -#### Return - -Variant array size +# getDimensions + + +public [getDimensions](get-dimensions.md)(): [Variant](../-variant/index.md) + +gets the dimensions of an array + +#### Return + +Variant array size diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-length.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-length.md index 786841c86b..4fb6cc21d5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-length.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-length.md @@ -1,41 +1,39 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Array](index.md)/[getLength](get-length.md) - -# getLength - - -public [getLength](get-length.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the size of the array. Same as getSize() - -#### Return - -the number of elements in the array - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getLength](get-length.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the size of a specific dimension in the array. Same as getSize() - -#### Return - -the number of elements in the array - -#### Parameters - - - -| | | -|---|---| -| dimension | the dimension of interest (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getLength + + +public [getLength](get-length.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the size of the array. Same as getSize() + +#### Return + +the number of elements in the array + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getLength](get-length.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the size of a specific dimension in the array. Same as getSize() + +#### Return + +the number of elements in the array + +#### Parameters + + + +| | | +|---|---| +| dimension | the dimension of interest (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-num-dimensions.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-num-dimensions.md index 064f9891b1..41ef547c5b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-num-dimensions.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-num-dimensions.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Array](index.md)/[getNumDimensions](get-num-dimensions.md) - -# getNumDimensions - - -public [getNumDimensions](get-num-dimensions.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the number of dimensions - -#### Return - -the number of dimensions - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumDimensions + + +public [getNumDimensions](get-num-dimensions.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the number of dimensions + +#### Return + +the number of dimensions + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-size.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-size.md index 2d1483c0ee..ae6e3eaef7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-size.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/get-size.md @@ -1,41 +1,39 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Array](index.md)/[getSize](get-size.md) - -# getSize - - -public [getSize](get-size.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the size of the array. Same as getLength() - -#### Return - -the number of elements in the array - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getSize](get-size.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the size of a specific dimension in the array. Same as getLength() - -#### Return - -the number of elements in the array - -#### Parameters - - - -| | | -|---|---| -| dimension | the dimension of interest (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getSize + + +public [getSize](get-size.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the size of the array. Same as getLength() + +#### Return + +the number of elements in the array + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getSize](get-size.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the size of a specific dimension in the array. Same as getLength() + +#### Return + +the number of elements in the array + +#### Parameters + + + +| | | +|---|---| +| dimension | the dimension of interest (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/index.md index 93c8dd59f4..e001bd5b70 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/index.md @@ -1,70 +1,68 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Array](index.md) - -# Array - -public class [Array](index.md) : [Variable](../-variable/index.md) - -This is a base class for array types in ModelCenter - -#### Author - -Woyak, 9/2001 - -#### Inheritors - -| | -|---| -| [BooleanArray](../-boolean-array/index.md) | -| [DoubleArray](../-double-array/index.md) | -| [FileArray](../-file-array/index.md) | -| [IntegerArray](../-integer-array/index.md) | -| [ReferenceArray](../-reference-array/index.md) | -| [StringArray](../-string-array/index.md) | -| [BooleanArray](../-boolean-array/index.md) | -| [DoubleArray](../-double-array/index.md) | -| [FileArray](../-file-array/index.md) | -| [IntegerArray](../-integer-array/index.md) | -| [ReferenceArray](../-reference-array/index.md) | -| [StringArray](../-string-array/index.md) | - -## Functions - -| Name | Summary | -|---|---| -| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromString](from-string.md) | public [fromString](from-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value for the variable from a string
public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | -| [getAutoSize](get-auto-size.md) | public [getAutoSize](get-auto-size.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the autoSize flag. | -| [getDimensions](get-dimensions.md) | public [getDimensions](get-dimensions.md)(): [Variant](../-variant/index.md)
gets the dimensions of an array | -| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | -| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | -| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | -| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | -| [getLength](get-length.md) | public [getLength](get-length.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getLength](get-length.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | -| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | -| [getNumDimensions](get-num-dimensions.md) | public [getNumDimensions](get-num-dimensions.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of dimensions | -| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | -| [getSize](get-size.md) | public [getSize](get-size.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getSize](get-size.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | -| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | -| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | -| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | -| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | -| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | -| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | -| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setAutoSize](set-auto-size.md) | public [setAutoSize](set-auto-size.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the autoSize flag. | -| [setDimensions](set-dimensions.md) | public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the dimensions of the array | -| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | -| [setLength](set-length.md) | public [setLength](set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setLength](set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | -| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | -| [setNumDimensions](set-num-dimensions.md) | public [setNumDimensions](set-num-dimensions.md)(num: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the number of dimensions | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setSize](set-size.md) | public [setSize](set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setSize](set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | -| [toString](to-string.md) | public [toString](to-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [toStringAbsolute](to-string-absolute.md) | public [toStringAbsolute](to-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | +# Array + +public class [Array](index.md) : [Variable](../-variable/index.md) + +This is a base class for array types in ModelCenter + +#### Author + +Woyak, 9/2001 + +#### Inheritors + +| | +|---| +| [BooleanArray](../-boolean-array/index.md) | +| [DoubleArray](../-double-array/index.md) | +| [FileArray](../-file-array/index.md) | +| [IntegerArray](../-integer-array/index.md) | +| [ReferenceArray](../-reference-array/index.md) | +| [StringArray](../-string-array/index.md) | +| [BooleanArray](../-boolean-array/index.md) | +| [DoubleArray](../-double-array/index.md) | +| [FileArray](../-file-array/index.md) | +| [IntegerArray](../-integer-array/index.md) | +| [ReferenceArray](../-reference-array/index.md) | +| [StringArray](../-string-array/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromString](from-string.md) | public [fromString](from-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value for the variable from a string
public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | +| [getAutoSize](get-auto-size.md) | public [getAutoSize](get-auto-size.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the autoSize flag. | +| [getDimensions](get-dimensions.md) | public [getDimensions](get-dimensions.md)(): [Variant](../-variant/index.md)
gets the dimensions of an array | +| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | +| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | +| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | +| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | +| [getLength](get-length.md) | public [getLength](get-length.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getLength](get-length.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | +| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | +| [getNumDimensions](get-num-dimensions.md) | public [getNumDimensions](get-num-dimensions.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of dimensions | +| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | +| [getSize](get-size.md) | public [getSize](get-size.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getSize](get-size.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | +| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | +| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | +| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | +| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | +| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | +| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | +| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setAutoSize](set-auto-size.md) | public [setAutoSize](set-auto-size.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the autoSize flag. | +| [setDimensions](set-dimensions.md) | public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the dimensions of the array | +| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | +| [setLength](set-length.md) | public [setLength](set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setLength](set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | +| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | +| [setNumDimensions](set-num-dimensions.md) | public [setNumDimensions](set-num-dimensions.md)(num: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the number of dimensions | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setSize](set-size.md) | public [setSize](set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setSize](set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | +| [toString](to-string.md) | public [toString](to-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [toStringAbsolute](to-string-absolute.md) | public [toStringAbsolute](to-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-auto-size.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-auto-size.md index 436e52b7aa..0eefd65925 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-auto-size.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-auto-size.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Array](index.md)/[setAutoSize](set-auto-size.md) - -# setAutoSize - - -public [setAutoSize](set-auto-size.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets the autoSize flag. If true, the array will automatically resize to arrays it is linked to. - -#### Parameters - - - -| | -|---| -| flag | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setAutoSize + + +public [setAutoSize](set-auto-size.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets the autoSize flag. If true, the array will automatically resize to arrays it is linked to. + +#### Parameters + + + +| | +|---| +| flag | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md index c66f971547..6205243493 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md @@ -1,238 +1,236 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Array](index.md)/[setDimensions](set-dimensions.md) - -# setDimensions - - -public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the size of the dimensions of the array - -#### Parameters - - - -| | | -|---|---| -| d1 | the size of the 1st dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the size of the dimensions of the array - -#### Parameters - - - -| | | -|---|---| -| d1 | the size of the 1st dimension | -| d2 | the size of the 2nd dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the size of the dimensions of the array - -#### Parameters - - - -| | | -|---|---| -| d1 | the size of the 1st dimension | -| d2 | the size of the 2nd dimension | -| d3 | the size of the 3rd dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the size of the dimensions of the array - -#### Parameters - - - -| | | -|---|---| -| d1 | the size of the 1st dimension | -| d2 | the size of the 2nd dimension | -| d3 | the size of the 3rd dimension | -| d4 | the size of the 4th dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the size of the dimensions of the array - -#### Parameters - - - -| | | -|---|---| -| d1 | the size of the 1st dimension | -| d2 | the size of the 2nd dimension | -| d3 | the size of the 3rd dimension | -| d4 | the size of the 4th dimension | -| d5 | the size of the 5th dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the size of the dimensions of the array - -#### Parameters - - - -| | | -|---|---| -| d1 | the size of the 1st dimension | -| d2 | the size of the 2nd dimension | -| d3 | the size of the 3rd dimension | -| d4 | the size of the 4th dimension | -| d5 | the size of the 5th dimension | -| d6 | the size of the 6th dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the size of the dimensions of the array - -#### Parameters - - - -| | | -|---|---| -| d1 | the size of the 1st dimension | -| d2 | the size of the 2nd dimension | -| d3 | the size of the 3rd dimension | -| d4 | the size of the 4th dimension | -| d5 | the size of the 5th dimension | -| d6 | the size of the 6th dimension | -| d7 | the size of the 7th dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the size of the dimensions of the array - -#### Parameters - - - -| | | -|---|---| -| d1 | the size of the 1st dimension | -| d2 | the size of the 2nd dimension | -| d3 | the size of the 3rd dimension | -| d4 | the size of the 4th dimension | -| d5 | the size of the 5th dimension | -| d6 | the size of the 6th dimension | -| d7 | the size of the 7th dimension | -| d8 | the size of the 8th dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the size of the dimensions of the array - -#### Parameters - - - -| | | -|---|---| -| d1 | the size of the 1st dimension | -| d2 | the size of the 2nd dimension | -| d3 | the size of the 3rd dimension | -| d4 | the size of the 4th dimension | -| d5 | the size of the 5th dimension | -| d6 | the size of the 6th dimension | -| d7 | the size of the 7th dimension | -| d8 | the size of the 8th dimension | -| d9 | the size of the 9th dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the size of the dimensions of the array - -#### Parameters - - - -| | | -|---|---| -| d1 | the size of the 1st dimension | -| d2 | the size of the 2nd dimension | -| d3 | the size of the 3rd dimension | -| d4 | the size of the 4th dimension | -| d5 | the size of the 5th dimension | -| d6 | the size of the 6th dimension | -| d7 | the size of the 7th dimension | -| d8 | the size of the 8th dimension | -| d9 | the size of the 9th dimension | -| d10 | the size of the 10th dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDimensions + + +public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the size of the dimensions of the array + +#### Parameters + + + +| | | +|---|---| +| d1 | the size of the 1st dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the size of the dimensions of the array + +#### Parameters + + + +| | | +|---|---| +| d1 | the size of the 1st dimension | +| d2 | the size of the 2nd dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the size of the dimensions of the array + +#### Parameters + + + +| | | +|---|---| +| d1 | the size of the 1st dimension | +| d2 | the size of the 2nd dimension | +| d3 | the size of the 3rd dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the size of the dimensions of the array + +#### Parameters + + + +| | | +|---|---| +| d1 | the size of the 1st dimension | +| d2 | the size of the 2nd dimension | +| d3 | the size of the 3rd dimension | +| d4 | the size of the 4th dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the size of the dimensions of the array + +#### Parameters + + + +| | | +|---|---| +| d1 | the size of the 1st dimension | +| d2 | the size of the 2nd dimension | +| d3 | the size of the 3rd dimension | +| d4 | the size of the 4th dimension | +| d5 | the size of the 5th dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the size of the dimensions of the array + +#### Parameters + + + +| | | +|---|---| +| d1 | the size of the 1st dimension | +| d2 | the size of the 2nd dimension | +| d3 | the size of the 3rd dimension | +| d4 | the size of the 4th dimension | +| d5 | the size of the 5th dimension | +| d6 | the size of the 6th dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the size of the dimensions of the array + +#### Parameters + + + +| | | +|---|---| +| d1 | the size of the 1st dimension | +| d2 | the size of the 2nd dimension | +| d3 | the size of the 3rd dimension | +| d4 | the size of the 4th dimension | +| d5 | the size of the 5th dimension | +| d6 | the size of the 6th dimension | +| d7 | the size of the 7th dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the size of the dimensions of the array + +#### Parameters + + + +| | | +|---|---| +| d1 | the size of the 1st dimension | +| d2 | the size of the 2nd dimension | +| d3 | the size of the 3rd dimension | +| d4 | the size of the 4th dimension | +| d5 | the size of the 5th dimension | +| d6 | the size of the 6th dimension | +| d7 | the size of the 7th dimension | +| d8 | the size of the 8th dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the size of the dimensions of the array + +#### Parameters + + + +| | | +|---|---| +| d1 | the size of the 1st dimension | +| d2 | the size of the 2nd dimension | +| d3 | the size of the 3rd dimension | +| d4 | the size of the 4th dimension | +| d5 | the size of the 5th dimension | +| d6 | the size of the 6th dimension | +| d7 | the size of the 7th dimension | +| d8 | the size of the 8th dimension | +| d9 | the size of the 9th dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setDimensions](set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the size of the dimensions of the array + +#### Parameters + + + +| | | +|---|---| +| d1 | the size of the 1st dimension | +| d2 | the size of the 2nd dimension | +| d3 | the size of the 3rd dimension | +| d4 | the size of the 4th dimension | +| d5 | the size of the 5th dimension | +| d6 | the size of the 6th dimension | +| d7 | the size of the 7th dimension | +| d8 | the size of the 8th dimension | +| d9 | the size of the 9th dimension | +| d10 | the size of the 10th dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-length.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-length.md index fcae41cf58..3625fe220a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-length.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-length.md @@ -1,42 +1,40 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Array](index.md)/[setLength](set-length.md) - -# setLength - - -public [setLength](set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the size of the array. Same as setSize() - -#### Parameters - - - -| | | -|---|---| -| size | the number of elements to store in the array | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setLength](set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the size of a specific dimension in the array. Same as setSize() - -#### Parameters - - - -| | | -|---|---| -| size | the number of elements to store in the array | -| dimension | the dimension of interest (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setLength + + +public [setLength](set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the size of the array. Same as setSize() + +#### Parameters + + + +| | | +|---|---| +| size | the number of elements to store in the array | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setLength](set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the size of a specific dimension in the array. Same as setSize() + +#### Parameters + + + +| | | +|---|---| +| size | the number of elements to store in the array | +| dimension | the dimension of interest (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-num-dimensions.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-num-dimensions.md index bb8184abb8..f84c6ab4dc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-num-dimensions.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-num-dimensions.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Array](index.md)/[setNumDimensions](set-num-dimensions.md) - -# setNumDimensions - - -public [setNumDimensions](set-num-dimensions.md)(num: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the number of dimensions - -#### Parameters - - - -| | | -|---|---| -| num | the number of dimensions to have in the array | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setNumDimensions + + +public [setNumDimensions](set-num-dimensions.md)(num: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the number of dimensions + +#### Parameters + + + +| | | +|---|---| +| num | the number of dimensions to have in the array | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-size.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-size.md index 29cf11b89c..125322bf35 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-size.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/set-size.md @@ -1,42 +1,40 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Array](index.md)/[setSize](set-size.md) - -# setSize - - -public [setSize](set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the size of the array. Same as setLength() - -#### Parameters - - - -| | | -|---|---| -| size | the number of elements to store in the array | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setSize](set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the size of a specific dimension in the array. Same as setLength() - -#### Parameters - - - -| | | -|---|---| -| size | the number of elements to store in the array | -| dimension | the dimension of interest (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setSize + + +public [setSize](set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the size of the array. Same as setLength() + +#### Parameters + + + +| | | +|---|---| +| size | the number of elements to store in the array | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setSize](set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the size of a specific dimension in the array. Same as setLength() + +#### Parameters + + + +| | | +|---|---| +| size | the number of elements to store in the array | +| dimension | the dimension of interest (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/to-string-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/to-string-absolute.md index 8c4a1cb670..3290118705 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/to-string-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/to-string-absolute.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Array](index.md)/[toStringAbsolute](to-string-absolute.md) - -# toStringAbsolute - - -public [toStringAbsolute](to-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -converts the variable value to a string representation. If the variable is not currently valid, it is NOT validated. - -#### Return - -the string value of the variable - -#### Parameters - - - -| | | -|---|---| -| index | the array element to get (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toStringAbsolute + + +public [toStringAbsolute](to-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +converts the variable value to a string representation. If the variable is not currently valid, it is NOT validated. + +#### Return + +the string value of the variable + +#### Parameters + + + +| | | +|---|---| +| index | the array element to get (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/to-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/to-string.md index b0b29dc2da..1a267b3d99 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/to-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-array/to-string.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Array](index.md)/[toString](to-string.md) - -# toString - - -public [toString](to-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -converts the variable value to a string representation. If the variable is not currently valid, it is first validated. - -#### Return - -the string value of the variable - -#### Parameters - - - -| | | -|---|---| -| index | the array element to get (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toString + + +public [toString](to-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +converts the variable value to a string representation. If the variable is not currently valid, it is first validated. + +#### Return + +the string value of the variable + +#### Parameters + + + +| | | +|---|---| +| index | the array element to get (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-a-s-s-e-m-b-l-y.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-a-s-s-e-m-b-l-y.md index 89f8e4779c..285821002a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-a-s-s-e-m-b-l-y.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-a-s-s-e-m-b-l-y.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[ASSEMBLY](-a-s-s-e-m-b-l-y.md) - -# ASSEMBLY - - -val [ASSEMBLY](-a-s-s-e-m-b-l-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Assembly" - -Generic (data-driven) assembly type. +# ASSEMBLY + + +val [ASSEMBLY](-a-s-s-e-m-b-l-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Assembly" + +Generic (data-driven) assembly type. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-f-o-r_-e-a-c-h.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-f-o-r_-e-a-c-h.md index 9607359e44..63548367d9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-f-o-r_-e-a-c-h.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-f-o-r_-e-a-c-h.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[FOR_EACH](-f-o-r_-e-a-c-h.md) - -# FOR_EACH - - -val [~~FOR_EACH~~](-f-o-r_-e-a-c-h.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ForEach" - ---- - -### Deprecated - ---- - -For-each assembly type. +# FOR_EACH + + +val [~~FOR_EACH~~](-f-o-r_-e-a-c-h.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ForEach" + +--- + +### Deprecated + +--- + +For-each assembly type. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-i-f.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-i-f.md index b976ac669d..8cfdc579fa 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-i-f.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-i-f.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[IF](-i-f.md) - -# IF - - -val [IF](-i-f.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "If" - -IF-block assembly type. +# IF + + +val [IF](-i-f.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "If" + +IF-block assembly type. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-l-o-o-p.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-l-o-o-p.md index bb9192c68d..bed8cbe455 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-l-o-o-p.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-l-o-o-p.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[LOOP](-l-o-o-p.md) - -# LOOP - - -val [LOOP](-l-o-o-p.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Loop" - -Loop assembly type. +# LOOP + + +val [LOOP](-l-o-o-p.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Loop" + +Loop assembly type. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-p-a-r-a-l-l-e-l.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-p-a-r-a-l-l-e-l.md index 248b794b26..71bd1777bb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-p-a-r-a-l-l-e-l.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-p-a-r-a-l-l-e-l.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[PARALLEL](-p-a-r-a-l-l-e-l.md) - -# PARALLEL - - -val [PARALLEL](-p-a-r-a-l-l-e-l.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Parallel" - -Parallel assembly type. +# PARALLEL + + +val [PARALLEL](-p-a-r-a-l-l-e-l.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Parallel" + +Parallel assembly type. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-s-e-q-u-e-n-c-e.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-s-e-q-u-e-n-c-e.md index cd86dd9ba1..7f0965762c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-s-e-q-u-e-n-c-e.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/-s-e-q-u-e-n-c-e.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[SEQUENCE](-s-e-q-u-e-n-c-e.md) - -# SEQUENCE - - -val [SEQUENCE](-s-e-q-u-e-n-c-e.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Sequence" - -Generic (process-driven) assembly type. +# SEQUENCE + + +val [SEQUENCE](-s-e-q-u-e-n-c-e.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Sequence" + +Generic (process-driven) assembly type. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/add-assembly.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/add-assembly.md index e6f90de99c..8427db080f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/add-assembly.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/add-assembly.md @@ -1,50 +1,48 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[addAssembly](add-assembly.md) - -# addAssembly - - -public [addAssembly](add-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](index.md) - -adds a sub-assembly - -#### Return - -the new assembly - -#### Parameters - - - -| | | -|---|---| -| name | the new assembly name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [addAssembly](add-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), assemblyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](index.md) - -adds a sub-assembly of the specified type - -#### Return - -the new assembly - -#### Parameters - - - -| | | -|---|---| -| name | the new assembly name | -| assemblyType | the type of assembly to create: ASSEMBLY_TYPE_ASSEMBLY - traditional ModelCenter assembly The following additional assembly types are available in ModelCenter process models (i.e. modelType == MODEL_TYPE_PROCESS) ASSEMBLY_TYPE_SEQUENCE - sequential flow ASSEMBLY_TYPE_IF - if-then-else flow ASSEMBLY_TYPE_FOR_EACH - loop over a data array | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addAssembly + + +public [addAssembly](add-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](index.md) + +adds a sub-assembly + +#### Return + +the new assembly + +#### Parameters + + + +| | | +|---|---| +| name | the new assembly name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [addAssembly](add-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), assemblyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](index.md) + +adds a sub-assembly of the specified type + +#### Return + +the new assembly + +#### Parameters + + + +| | | +|---|---| +| name | the new assembly name | +| assemblyType | the type of assembly to create: ASSEMBLY_TYPE_ASSEMBLY - traditional ModelCenter assembly The following additional assembly types are available in ModelCenter process models (i.e. modelType == MODEL_TYPE_PROCESS) ASSEMBLY_TYPE_SEQUENCE - sequential flow ASSEMBLY_TYPE_IF - if-then-else flow ASSEMBLY_TYPE_FOR_EACH - loop over a data array | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/add-assembly2.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/add-assembly2.md index b9c9febcf5..3cf22453a7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/add-assembly2.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/add-assembly2.md @@ -1,54 +1,52 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[addAssembly2](add-assembly2.md) - -# addAssembly2 - - -public [addAssembly2](add-assembly2.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), yPos: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Assembly](index.md) - -adds a sub-assembly - -#### Return - -the new assembly - -#### Parameters - - - -| | | -|---|---| -| name | the new assembly name | -| xPos | x-coordinate to add the assembly at (in its parent area) | -| yPos | y-coordinate to add the assembly at (in its parent area) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [addAssembly2](add-assembly2.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), yPos: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), assemblyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](index.md) - -adds a sub-assembly of the specified type - -#### Return - -the new assembly - -#### Parameters - - - -| | | -|---|---| -| name | the new assembly name | -| xPos | x-coordinate to add the assembly at (in its parent area) | -| yPos | y-coordinate to add the assembly at (in its parent area) | -| assemblyType | the type of assembly to create:ASSEMBLY_TYPE_ASSEMBLY - traditional ModelCenter assemblyThe following additional assembly types are available in ModelCenter process models(i.e. modelType == MODEL_TYPE_PROCESS)ASSEMBLY_TYPE_SEQUENCE - sequential flowASSEMBLY_TYPE_IF - if-then-else flowASSEMBLY_TYPE_FOR_EACH - loop over a data array | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addAssembly2 + + +public [addAssembly2](add-assembly2.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), yPos: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Assembly](index.md) + +adds a sub-assembly + +#### Return + +the new assembly + +#### Parameters + + + +| | | +|---|---| +| name | the new assembly name | +| xPos | x-coordinate to add the assembly at (in its parent area) | +| yPos | y-coordinate to add the assembly at (in its parent area) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [addAssembly2](add-assembly2.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), yPos: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), assemblyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](index.md) + +adds a sub-assembly of the specified type + +#### Return + +the new assembly + +#### Parameters + + + +| | | +|---|---| +| name | the new assembly name | +| xPos | x-coordinate to add the assembly at (in its parent area) | +| yPos | y-coordinate to add the assembly at (in its parent area) | +| assemblyType | the type of assembly to create:ASSEMBLY_TYPE_ASSEMBLY - traditional ModelCenter assemblyThe following additional assembly types are available in ModelCenter process models(i.e. modelType == MODEL_TYPE_PROCESS)ASSEMBLY_TYPE_SEQUENCE - sequential flowASSEMBLY_TYPE_IF - if-then-else flowASSEMBLY_TYPE_FOR_EACH - loop over a data array | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/add-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/add-variable.md index 469abc4596..be4d3e61d2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/add-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/add-variable.md @@ -1,27 +1,25 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[addVariable](add-variable.md) - -# addVariable - - -public [addVariable](add-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) - -adds a variable to the assembly - -#### Return - -the new assembly - -#### Parameters - - - -| | | -|---|---| -| name | Name of the new variable to create. | -| type | Type of the new variable. Possible types are: double, int, string, file, double[], int[], boolean[], string[], quadfacet, surfaceofrevolution, nurbs, bspline, ruled, skinned, vrml, node | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addVariable + + +public [addVariable](add-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) + +adds a variable to the assembly + +#### Return + +the new assembly + +#### Parameters + + + +| | | +|---|---| +| name | Name of the new variable to create. | +| type | Type of the new variable. Possible types are: double, int, string, file, double[], int[], boolean[], string[], quadfacet, surfaceofrevolution, nurbs, bspline, ruled, skinned, vrml, node | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/convert-to-submodel.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/convert-to-submodel.md index 0a2882bf54..2b545744bd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/convert-to-submodel.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/convert-to-submodel.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[convertToSubmodel](convert-to-submodel.md) - -# convertToSubmodel - - -public [convertToSubmodel](convert-to-submodel.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), versionStatus: [ModelCenter.VersionStatus](../-model-center/-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -For internal use only +# convertToSubmodel + + +public [convertToSubmodel](convert-to-submodel.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), versionStatus: [ModelCenter.VersionStatus](../-model-center/-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +For internal use only diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/delete-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/delete-variable.md index fd58c4748f..65fbfcfe0e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/delete-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/delete-variable.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[deleteVariable](delete-variable.md) - -# deleteVariable - - -public [deleteVariable](delete-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -deletes a variable from the assembly - -#### Parameters - - - -| | | -|---|---| -| name | Name of the new variable to delete. | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# deleteVariable + + +public [deleteVariable](delete-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +deletes a variable from the assembly + +#### Parameters + + + +| | | +|---|---| +| name | Name of the new variable to delete. | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-assembly-type.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-assembly-type.md index 180ddd8adf..e574b644b1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-assembly-type.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-assembly-type.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[getAssemblyType](get-assembly-type.md) - -# getAssemblyType - - -public [getAssemblyType](get-assembly-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the type of assembly. - -#### Return - -the name of the assembly type - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getAssemblyType + + +public [getAssemblyType](get-assembly-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the type of assembly. + +#### Return + +the name of the assembly type + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-assembly.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-assembly.md index b7717230c2..7ac0eab9de 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-assembly.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-assembly.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[getAssembly](get-assembly.md) - -# getAssembly - - -public [getAssembly](get-assembly.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Assembly](index.md) - -gets the specified assembly - -#### Return - -the specified assembly - -#### Parameters - - - -| | | -|---|---| -| index | the assembly index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getAssembly](get-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](index.md) - -gets the specified assembly - -#### Return - -the specified assembly - -#### Parameters - - - -| | | -|---|---| -| name | the assembly name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getAssembly + + +public [getAssembly](get-assembly.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Assembly](index.md) + +gets the specified assembly + +#### Return + +the specified assembly + +#### Parameters + + + +| | | +|---|---| +| index | the assembly index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getAssembly](get-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](index.md) + +gets the specified assembly + +#### Return + +the specified assembly + +#### Parameters + + + +| | | +|---|---| +| name | the assembly name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-component.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-component.md index 0fe086eef8..cc9fb4e4cd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-component.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-component.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[getComponent](get-component.md) - -# getComponent - - -public [getComponent](get-component.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Component](../-component/index.md) - -gets the specified component - -#### Return - -the specified component - -#### Parameters - - - -| | | -|---|---| -| index | the component index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getComponent](get-component.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Component](../-component/index.md) - -gets the specified component - -#### Return - -the specified component - -#### Parameters - - - -| | | -|---|---| -| name | the component name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getComponent + + +public [getComponent](get-component.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Component](../-component/index.md) + +gets the specified component + +#### Return + +the specified component + +#### Parameters + + + +| | | +|---|---| +| index | the component index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getComponent](get-component.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Component](../-component/index.md) + +gets the specified component + +#### Return + +the specified component + +#### Parameters + + + +| | | +|---|---| +| name | the component name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-full-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-full-name.md index 2031c13e32..713c6cd197 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-full-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-full-name.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[getFullName](get-full-name.md) - -# getFullName - - -public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the full name of the current object, e.g. "Model.Script.x" - -#### Return - -the object name - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getFullName + + +public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the full name of the current object, e.g. "Model.Script.x" + +#### Return + +the object name + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-group.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-group.md index d35053868a..dcdb5a94e9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-group.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-group.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[getGroup](get-group.md) - -# getGroup - - -public [getGroup](get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](../-group/index.md) - -gets the specified group - -#### Return - -the specified group - -#### Parameters - - - -| | | -|---|---| -| index | the group index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getGroup](get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](../-group/index.md) - -gets the specified group - -#### Return - -the specified group - -#### Parameters - - - -| | | -|---|---| -| name | the variable name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getGroup + + +public [getGroup](get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](../-group/index.md) + +gets the specified group + +#### Return + +the specified group + +#### Parameters + + + +| | | +|---|---| +| index | the group index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getGroup](get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](../-group/index.md) + +gets the specified group + +#### Return + +the specified group + +#### Parameters + + + +| | | +|---|---| +| name | the variable name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-icon-i-d.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-icon-i-d.md index cd4d63dfa5..a9cb170b5d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-icon-i-d.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-icon-i-d.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[getIconID](get-icon-i-d.md) - -# getIconID - - -public [getIconID](get-icon-i-d.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -Gets the icon ID for the icon displayed for this Assembly. - -#### Return - -the ID of the icon +# getIconID + + +public [getIconID](get-icon-i-d.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Gets the icon ID for the icon displayed for this Assembly. + +#### Return + +the ID of the icon diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-index-in-parent.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-index-in-parent.md index d7fbd2a346..22ec7c630e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-index-in-parent.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-index-in-parent.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[getIndexInParent](get-index-in-parent.md) - -# getIndexInParent - - -public [getIndexInParent](get-index-in-parent.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -Gets the index of the assembly in its parent assembly. This includes both assemblies and components and can be used to generate an index for ModelCenter.moveTo(). - -#### Return - -the index +# getIndexInParent + + +public [getIndexInParent](get-index-in-parent.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Gets the index of the assembly in its parent assembly. This includes both assemblies and components and can be used to generate an index for ModelCenter.moveTo(). + +#### Return + +the index diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-metadata.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-metadata.md index 703539cb56..28fe040582 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-metadata.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-metadata.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[getMetadata](get-metadata.md) - -# getMetadata - - -public [getMetadata](get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) - -Get a metadata value. - -#### Return - -the the value, or null if the value is not set or of an unrecognized type - -#### Parameters - - - -| | | -|---|---| -| name | the metadata value's name | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | on error. | +# getMetadata + + +public [getMetadata](get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) + +Get a metadata value. + +#### Return + +the the value, or null if the value is not set or of an unrecognized type + +#### Parameters + + + +| | | +|---|---| +| name | the metadata value's name | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | on error. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-name.md index 50d6a4db7b..b3bd82ad9c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-name.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[getName](get-name.md) - -# getName - - -public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the name of the current object, e.g. "x" - -#### Return - -the object name - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getName + + +public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the name of the current object, e.g. "x" + +#### Return + +the object name + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-assemblies.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-assemblies.md index 832aac377c..fbad3663b2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-assemblies.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-assemblies.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[getNumAssemblies](get-num-assemblies.md) - -# getNumAssemblies - - -public [getNumAssemblies](get-num-assemblies.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -get the number of assemblies stored in this object - -#### Return - -the number of stored assemblies - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumAssemblies + + +public [getNumAssemblies](get-num-assemblies.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +get the number of assemblies stored in this object + +#### Return + +the number of stored assemblies + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-components.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-components.md index 5552af3650..3d391214b7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-components.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-components.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[getNumComponents](get-num-components.md) - -# getNumComponents - - -public [getNumComponents](get-num-components.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -get the number of components stored in this object - -#### Return - -the number of stored components - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumComponents + + +public [getNumComponents](get-num-components.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +get the number of components stored in this object + +#### Return + +the number of stored components + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-groups.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-groups.md index 3c628f05f8..fadeac32cb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-groups.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-groups.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[getNumGroups](get-num-groups.md) - -# getNumGroups - - -public [getNumGroups](get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -get the number of groups stored in this object - -#### Return - -the number of stored groups - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumGroups + + +public [getNumGroups](get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +get the number of groups stored in this object + +#### Return + +the number of stored groups + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-variables.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-variables.md index d32bc5e6fe..1985ce264e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-variables.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-variables.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[getNumVariables](get-num-variables.md) - -# getNumVariables - - -public [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -get the number of variables stored in this object - -#### Return - -the number of stored variables - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumVariables + + +public [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +get the number of variables stored in this object + +#### Return + +the number of stored variables + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-parent-assembly.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-parent-assembly.md index 66e71ac749..5cf0cf8b12 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-parent-assembly.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-parent-assembly.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[getParentAssembly](get-parent-assembly.md) - -# getParentAssembly - - -public [getParentAssembly](get-parent-assembly.md)(): [Assembly](index.md) - -gets the parent assembly of this component (fails if this is the model/root assembly) - -#### Return - -the assembly - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getParentAssembly + + +public [getParentAssembly](get-parent-assembly.md)(): [Assembly](index.md) + +gets the parent assembly of this component (fails if this is the model/root assembly) + +#### Return + +the assembly + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-position-x.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-position-x.md index 59af10c3a8..68ec9d2580 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-position-x.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-position-x.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[getPositionX](get-position-x.md) - -# getPositionX - - -public [getPositionX](get-position-x.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -gets the X co-ordinate value of the current object, - -#### Return - -the X co-ordinate of the position - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getPositionX + + +public [getPositionX](get-position-x.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +gets the X co-ordinate value of the current object, + +#### Return + +the X co-ordinate of the position + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-position-y.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-position-y.md index a257c69588..62e4ec4bcf 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-position-y.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-position-y.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[getPositionY](get-position-y.md) - -# getPositionY - - -public [getPositionY](get-position-y.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -gets the Y co-ordinate value of the current object, - -#### Return - -the Y co-ordinate of the position - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getPositionY + + +public [getPositionY](get-position-y.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +gets the Y co-ordinate value of the current object, + +#### Return + +the Y co-ordinate of the position + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-user-data.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-user-data.md index 2939e30896..e70bd1a14c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-user-data.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-user-data.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[getUserData](get-user-data.md) - -# getUserData - - -public [getUserData](get-user-data.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -Get user data of the component. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getUserData + + +public [getUserData](get-user-data.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Get user data of the component. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-variable.md index a707ecc2a6..0a1ccdf036 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/get-variable.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[getVariable](get-variable.md) - -# getVariable - - -public [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md) - -gets the specified variable - -#### Return - -the specified variable - -#### Parameters - - - -| | | -|---|---| -| index | the variable index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) - -gets the specified variable - -#### Return - -the specified variable - -#### Parameters - - - -| | | -|---|---| -| name | the variable name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getVariable + + +public [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md) + +gets the specified variable + +#### Return + +the specified variable + +#### Parameters + + + +| | | +|---|---| +| index | the variable index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) + +gets the specified variable + +#### Return + +the specified variable + +#### Parameters + + + +| | | +|---|---| +| name | the variable name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/index.md index 4b74d1c6a7..b378c0e2e1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/index.md @@ -1,59 +1,57 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md) - -# Assembly - - -public class [Assembly](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [IVariableHolder](../-i-variable-holder/index.md) - -This is the wrapper class that handles the native COM calls to a Component object. The class is used by Java plug-ins to ModelCenter. - -#### Author - -Woyak, 9-01 - -## Properties - -| Name | Summary | -|---|---| -| [ASSEMBLY](-a-s-s-e-m-b-l-y.md) | val [ASSEMBLY](-a-s-s-e-m-b-l-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Assembly"
Generic (data-driven) assembly type. | -| [FOR_EACH](-f-o-r_-e-a-c-h.md) | val [~~FOR_EACH~~](-f-o-r_-e-a-c-h.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ForEach"
For-each assembly type. | -| [IF](-i-f.md) | val [IF](-i-f.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "If"
IF-block assembly type. | -| [LOOP](-l-o-o-p.md) | val [LOOP](-l-o-o-p.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Loop"
Loop assembly type. | -| [PARALLEL](-p-a-r-a-l-l-e-l.md) | val [PARALLEL](-p-a-r-a-l-l-e-l.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Parallel"
Parallel assembly type. | -| [SEQUENCE](-s-e-q-u-e-n-c-e.md) | val [SEQUENCE](-s-e-q-u-e-n-c-e.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Sequence"
Generic (process-driven) assembly type. | - -## Functions - -| Name | Summary | -|---|---| -| [addAssembly](add-assembly.md) | public [addAssembly](add-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](index.md)
adds a sub-assembly
public [addAssembly](add-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), assemblyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](index.md)
adds a sub-assembly of the specified type | -| [addAssembly2](add-assembly2.md) | public [addAssembly2](add-assembly2.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), yPos: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Assembly](index.md)
adds a sub-assembly
public [addAssembly2](add-assembly2.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), yPos: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), assemblyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](index.md)
adds a sub-assembly of the specified type | -| [addVariable](add-variable.md) | public [addVariable](add-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
adds a variable to the assembly | -| [convertToSubmodel](convert-to-submodel.md) | public [convertToSubmodel](convert-to-submodel.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), versionStatus: [ModelCenter.VersionStatus](../-model-center/-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
For internal use only | -| [deleteVariable](delete-variable.md) | public [deleteVariable](delete-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
deletes a variable from the assembly | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [getAssembly](get-assembly.md) | public [getAssembly](get-assembly.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Assembly](index.md)
public [getAssembly](get-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](index.md)
gets the specified assembly | -| [getAssemblyType](get-assembly-type.md) | public [getAssemblyType](get-assembly-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of assembly. | -| [getComponent](get-component.md) | public [getComponent](get-component.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Component](../-component/index.md)
public [getComponent](get-component.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Component](../-component/index.md)
gets the specified component | -| [getFullName](get-full-name.md) | public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the full name of the current object, e.g. | -| [getGroup](get-group.md) | public [getGroup](get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](../-group/index.md)
public [getGroup](get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](../-group/index.md)
gets the specified group | -| [getIconID](get-icon-i-d.md) | public [getIconID](get-icon-i-d.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the icon ID for the icon displayed for this Assembly. | -| [getIndexInParent](get-index-in-parent.md) | public [getIndexInParent](get-index-in-parent.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the index of the assembly in its parent assembly. | -| [getMetadata](get-metadata.md) | public [getMetadata](get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](get-name.md) | public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the current object, e.g. | -| [getNumAssemblies](get-num-assemblies.md) | public [getNumAssemblies](get-num-assemblies.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of assemblies stored in this object | -| [getNumComponents](get-num-components.md) | public [getNumComponents](get-num-components.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of components stored in this object | -| [getNumGroups](get-num-groups.md) | public [getNumGroups](get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of groups stored in this object | -| [getNumVariables](get-num-variables.md) | public [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of variables stored in this object | -| [getParentAssembly](get-parent-assembly.md) | public [getParentAssembly](get-parent-assembly.md)(): [Assembly](index.md)
gets the parent assembly of this component (fails if this is the model/root assembly) | -| [getPositionX](get-position-x.md) | public [getPositionX](get-position-x.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the X co-ordinate value of the current object, | -| [getPositionY](get-position-y.md) | public [getPositionY](get-position-y.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the Y co-ordinate value of the current object, | -| [getUserData](get-user-data.md) | public [getUserData](get-user-data.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Get user data of the component. | -| [getVariable](get-variable.md) | public [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
public [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
gets the specified variable | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [rename](rename.md) | public [rename](rename.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Rename the assembly | -| [setIconID](set-icon-i-d.md) | public [setIconID](set-icon-i-d.md)(iconID: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Specifies the icon for use with this Assembly. | -| [setMetadata](set-metadata.md) | public [setMetadata](set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on an assembly. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setUserData](set-user-data.md) | public [setUserData](set-user-data.md)(val: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
Set user data of the Component | +# Assembly + + +public class [Assembly](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [IVariableHolder](../-i-variable-holder/index.md) + +This is the wrapper class that handles the native COM calls to a Component object. The class is used by Java plug-ins to ModelCenter. + +#### Author + +Woyak, 9-01 + +## Properties + +| Name | Summary | +|---|---| +| [ASSEMBLY](-a-s-s-e-m-b-l-y.md) | val [ASSEMBLY](-a-s-s-e-m-b-l-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Assembly"
Generic (data-driven) assembly type. | +| [FOR_EACH](-f-o-r_-e-a-c-h.md) | val [~~FOR_EACH~~](-f-o-r_-e-a-c-h.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ForEach"
For-each assembly type. | +| [IF](-i-f.md) | val [IF](-i-f.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "If"
IF-block assembly type. | +| [LOOP](-l-o-o-p.md) | val [LOOP](-l-o-o-p.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Loop"
Loop assembly type. | +| [PARALLEL](-p-a-r-a-l-l-e-l.md) | val [PARALLEL](-p-a-r-a-l-l-e-l.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Parallel"
Parallel assembly type. | +| [SEQUENCE](-s-e-q-u-e-n-c-e.md) | val [SEQUENCE](-s-e-q-u-e-n-c-e.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Sequence"
Generic (process-driven) assembly type. | + +## Functions + +| Name | Summary | +|---|---| +| [addAssembly](add-assembly.md) | public [addAssembly](add-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](index.md)
adds a sub-assembly
public [addAssembly](add-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), assemblyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](index.md)
adds a sub-assembly of the specified type | +| [addAssembly2](add-assembly2.md) | public [addAssembly2](add-assembly2.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), yPos: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Assembly](index.md)
adds a sub-assembly
public [addAssembly2](add-assembly2.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), yPos: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), assemblyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](index.md)
adds a sub-assembly of the specified type | +| [addVariable](add-variable.md) | public [addVariable](add-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
adds a variable to the assembly | +| [convertToSubmodel](convert-to-submodel.md) | public [convertToSubmodel](convert-to-submodel.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), versionStatus: [ModelCenter.VersionStatus](../-model-center/-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
For internal use only | +| [deleteVariable](delete-variable.md) | public [deleteVariable](delete-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
deletes a variable from the assembly | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [getAssembly](get-assembly.md) | public [getAssembly](get-assembly.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Assembly](index.md)
public [getAssembly](get-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](index.md)
gets the specified assembly | +| [getAssemblyType](get-assembly-type.md) | public [getAssemblyType](get-assembly-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of assembly. | +| [getComponent](get-component.md) | public [getComponent](get-component.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Component](../-component/index.md)
public [getComponent](get-component.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Component](../-component/index.md)
gets the specified component | +| [getFullName](get-full-name.md) | public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the full name of the current object, e.g. | +| [getGroup](get-group.md) | public [getGroup](get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](../-group/index.md)
public [getGroup](get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](../-group/index.md)
gets the specified group | +| [getIconID](get-icon-i-d.md) | public [getIconID](get-icon-i-d.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the icon ID for the icon displayed for this Assembly. | +| [getIndexInParent](get-index-in-parent.md) | public [getIndexInParent](get-index-in-parent.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the index of the assembly in its parent assembly. | +| [getMetadata](get-metadata.md) | public [getMetadata](get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](get-name.md) | public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the current object, e.g. | +| [getNumAssemblies](get-num-assemblies.md) | public [getNumAssemblies](get-num-assemblies.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of assemblies stored in this object | +| [getNumComponents](get-num-components.md) | public [getNumComponents](get-num-components.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of components stored in this object | +| [getNumGroups](get-num-groups.md) | public [getNumGroups](get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of groups stored in this object | +| [getNumVariables](get-num-variables.md) | public [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of variables stored in this object | +| [getParentAssembly](get-parent-assembly.md) | public [getParentAssembly](get-parent-assembly.md)(): [Assembly](index.md)
gets the parent assembly of this component (fails if this is the model/root assembly) | +| [getPositionX](get-position-x.md) | public [getPositionX](get-position-x.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the X co-ordinate value of the current object, | +| [getPositionY](get-position-y.md) | public [getPositionY](get-position-y.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the Y co-ordinate value of the current object, | +| [getUserData](get-user-data.md) | public [getUserData](get-user-data.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Get user data of the component. | +| [getVariable](get-variable.md) | public [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
public [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
gets the specified variable | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [rename](rename.md) | public [rename](rename.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Rename the assembly | +| [setIconID](set-icon-i-d.md) | public [setIconID](set-icon-i-d.md)(iconID: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Specifies the icon for use with this Assembly. | +| [setMetadata](set-metadata.md) | public [setMetadata](set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on an assembly. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setUserData](set-user-data.md) | public [setUserData](set-user-data.md)(val: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
Set user data of the Component | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/rename.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/rename.md index 997e62c8a9..7a4e0c15ce 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/rename.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/rename.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[rename](rename.md) - -# rename - - -public [rename](rename.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Rename the assembly - -#### Parameters - - - -| | | -|---|---| -| name | the new name of the assembly | +# rename + + +public [rename](rename.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Rename the assembly + +#### Parameters + + + +| | | +|---|---| +| name | the new name of the assembly | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/set-icon-i-d.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/set-icon-i-d.md index 5b086ee97c..e0c67eec4d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/set-icon-i-d.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/set-icon-i-d.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[setIconID](set-icon-i-d.md) - -# setIconID - - -public [setIconID](set-icon-i-d.md)(iconID: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -Specifies the icon for use with this Assembly. The * icon must be first registered with ModelCenter using the IModelCenter.addIcon() function. - -#### Parameters - - - -| | | -|---|---| -| iconID | the ID of the icon; -1 for the default icon | +# setIconID + + +public [setIconID](set-icon-i-d.md)(iconID: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +Specifies the icon for use with this Assembly. The * icon must be first registered with ModelCenter using the IModelCenter.addIcon() function. + +#### Parameters + + + +| | | +|---|---| +| iconID | the ID of the icon; -1 for the default icon | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/set-metadata.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/set-metadata.md index 081a5def52..487f78c0d2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/set-metadata.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/set-metadata.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[setMetadata](set-metadata.md) - -# setMetadata - - -public [setMetadata](set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Set a metadata value on an assembly. - -#### Parameters - - - -| | | -|---|---| -| name | the metadata value's name | -| type | the type of metadata | -| value | the string representation of the value to set | -| access | the access (private, readonly, public) | -| archive | whether to save the data with the model | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | on error. | +# setMetadata + + +public [setMetadata](set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Set a metadata value on an assembly. + +#### Parameters + + + +| | | +|---|---| +| name | the metadata value's name | +| type | the type of metadata | +| value | the string representation of the value to set | +| access | the access (private, readonly, public) | +| archive | whether to save the data with the model | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | on error. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/set-user-data.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/set-user-data.md index edc5c8f94b..845867d331 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/set-user-data.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-assembly/set-user-data.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Assembly](index.md)/[setUserData](set-user-data.md) - -# setUserData - - -public [setUserData](set-user-data.md)(val: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)) - -Set user data of the Component - -#### Parameters - - - -| | | -|---|---| -| val | the value to set | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setUserData + + +public [setUserData](set-user-data.md)(val: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)) + +Set user data of the Component + +#### Parameters + + + +| | | +|---|---| +| val | the value to set | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-description.md index 8fc3d04a3f..f0c010045f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-description.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[BooleanArray](index.md)/[getDescription](get-description.md) - -# getDescription - - -public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the description for the variable - -#### Return - -the description of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDescription + + +public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the description for the variable + +#### Return + +the description of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md index f2696c85a4..0bf1ba3f85 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md @@ -1,301 +1,299 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[BooleanArray](index.md)/[getValueAbsolute](get-value-absolute.md) - -# getValueAbsolute - - -public [getValueAbsolute](get-value-absolute.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| index | array index in string form, i.e. [1][2][3] | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | -| d10 | index in the 10th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValueAbsolute + + +public [getValueAbsolute](get-value-absolute.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| index | array index in string form, i.e. [1][2][3] | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | +| d10 | index in the 10th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md index 5b2ba58451..f36a036115 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md @@ -1,301 +1,299 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[BooleanArray](index.md)/[getValue](get-value.md) - -# getValue - - -public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| index | array index in string form, i.e. [1][2][3] | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | -| d10 | index in the 10th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValue + + +public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| index | array index in string form, i.e. [1][2][3] | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | +| d10 | index in the 10th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/index.md index 6e5b689daa..4757319df9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/index.md @@ -1,59 +1,57 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[BooleanArray](index.md) - -# BooleanArray - - -public class [BooleanArray](index.md) : [Array](../-array/index.md) - -A variable type class for ModelCenter - -#### Author - -Woyak, 10/2001 - -## Functions - -| Name | Summary | -|---|---| -| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromString](../-array/from-string.md) | public [fromString](../-array/from-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value for the variable from a string
public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | -| [getAutoSize](../-array/get-auto-size.md) | public [getAutoSize](../-array/get-auto-size.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the autoSize flag. | -| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | -| [getDimensions](../-array/get-dimensions.md) | public [getDimensions](../-array/get-dimensions.md)(): [Variant](../-variant/index.md)
gets the dimensions of an array | -| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | -| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | -| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | -| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | -| [getLength](../-array/get-length.md) | public [getLength](../-array/get-length.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getLength](../-array/get-length.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | -| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | -| [getNumDimensions](../-array/get-num-dimensions.md) | public [getNumDimensions](../-array/get-num-dimensions.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of dimensions | -| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | -| [getSize](../-array/get-size.md) | public [getSize](../-array/get-size.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getSize](../-array/get-size.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | -| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | -| [getValue](get-value.md) | public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the value of the variable at a specific location | -| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the value of the variable at a specific location without validatating. | -| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | -| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | -| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | -| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | -| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | -| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setAutoSize](../-array/set-auto-size.md) | public [setAutoSize](../-array/set-auto-size.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the autoSize flag. | -| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | -| [setDimensions](../-array/set-dimensions.md) | public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the dimensions of the array | -| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | -| [setLength](../-array/set-length.md) | public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | -| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | -| [setNumDimensions](../-array/set-num-dimensions.md) | public [setNumDimensions](../-array/set-num-dimensions.md)(num: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the number of dimensions | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setSize](../-array/set-size.md) | public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | -| [setValue](set-value.md) | public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value of the variable at a specific location | -| [toString](../-array/to-string.md) | public [toString](../-array/to-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [toStringAbsolute](../-array/to-string-absolute.md) | public [toStringAbsolute](../-array/to-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | +# BooleanArray + + +public class [BooleanArray](index.md) : [Array](../-array/index.md) + +A variable type class for ModelCenter + +#### Author + +Woyak, 10/2001 + +## Functions + +| Name | Summary | +|---|---| +| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromString](../-array/from-string.md) | public [fromString](../-array/from-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value for the variable from a string
public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | +| [getAutoSize](../-array/get-auto-size.md) | public [getAutoSize](../-array/get-auto-size.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the autoSize flag. | +| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | +| [getDimensions](../-array/get-dimensions.md) | public [getDimensions](../-array/get-dimensions.md)(): [Variant](../-variant/index.md)
gets the dimensions of an array | +| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | +| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | +| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | +| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | +| [getLength](../-array/get-length.md) | public [getLength](../-array/get-length.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getLength](../-array/get-length.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | +| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | +| [getNumDimensions](../-array/get-num-dimensions.md) | public [getNumDimensions](../-array/get-num-dimensions.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of dimensions | +| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | +| [getSize](../-array/get-size.md) | public [getSize](../-array/get-size.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getSize](../-array/get-size.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | +| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | +| [getValue](get-value.md) | public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the value of the variable at a specific location | +| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the value of the variable at a specific location without validatating. | +| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | +| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | +| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | +| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | +| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | +| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setAutoSize](../-array/set-auto-size.md) | public [setAutoSize](../-array/set-auto-size.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the autoSize flag. | +| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | +| [setDimensions](../-array/set-dimensions.md) | public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the dimensions of the array | +| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | +| [setLength](../-array/set-length.md) | public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | +| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | +| [setNumDimensions](../-array/set-num-dimensions.md) | public [setNumDimensions](../-array/set-num-dimensions.md)(num: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the number of dimensions | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setSize](../-array/set-size.md) | public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | +| [setValue](set-value.md) | public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value of the variable at a specific location | +| [toString](../-array/to-string.md) | public [toString](../-array/to-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [toStringAbsolute](../-array/to-string-absolute.md) | public [toStringAbsolute](../-array/to-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-description.md index 420402403e..0147b158ab 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-description.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[BooleanArray](index.md)/[setDescription](set-description.md) - -# setDescription - - -public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the description for the variable - -#### Parameters - - - -| | | -|---|---| -| description | the description of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDescription + + +public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the description for the variable + +#### Parameters + + + +| | | +|---|---| +| description | the description of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md index 781837ef65..3b8b4134c5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md @@ -1,268 +1,266 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[BooleanArray](index.md)/[setValue](set-value.md) - -# setValue - - -public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| index | index in string form, i.e. [1][2][3] | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | -| d10 | index in the 10th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setValue + + +public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| index | index in string form, i.e. [1][2][3] | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | +| d10 | index in the 10th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/get-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/get-description.md index 0edf351b18..f0c010045f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/get-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/get-description.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[BooleanVariable](index.md)/[getDescription](get-description.md) - -# getDescription - - -public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the description for the variable - -#### Return - -the description of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDescription + + +public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the description for the variable + +#### Return + +the description of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/get-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/get-value-absolute.md index a31f254eb5..e57cc83f37 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/get-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/get-value-absolute.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[BooleanVariable](index.md)/[getValueAbsolute](get-value-absolute.md) - -# getValueAbsolute - - -public [getValueAbsolute](get-value-absolute.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable without validating it - -#### Return - -the value of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValueAbsolute + + +public [getValueAbsolute](get-value-absolute.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable without validating it + +#### Return + +the value of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/get-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/get-value.md index 3fe7dcca40..cd888298a3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/get-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/get-value.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[BooleanVariable](index.md)/[getValue](get-value.md) - -# getValue - - -public [getValue](get-value.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of the variable - -#### Return - -the value of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValue + + +public [getValue](get-value.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of the variable + +#### Return + +the value of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/index.md index e0733dd5e9..d4482dda26 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/index.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[BooleanVariable](index.md) - -# BooleanVariable - - -public class [BooleanVariable](index.md) : [Variable](../-variable/index.md) - -A variable type class for ModelCenter - -#### Author - -Woyak, 9/2001 - -## Functions - -| Name | Summary | -|---|---| -| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromString](../-variable/from-string.md) | public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | -| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | -| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | -| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | -| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | -| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | -| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | -| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | -| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | -| [getValue](get-value.md) | public [getValue](get-value.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the value of the variable | -| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the value of the variable without validating it | -| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | -| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | -| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | -| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | -| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | -| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | -| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | -| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setValue](set-value.md) | public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the value of the variable | -| [toString](../-variable/to-string.md) | public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [toStringAbsolute](../-variable/to-string-absolute.md) | public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | +# BooleanVariable + + +public class [BooleanVariable](index.md) : [Variable](../-variable/index.md) + +A variable type class for ModelCenter + +#### Author + +Woyak, 9/2001 + +## Functions + +| Name | Summary | +|---|---| +| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromString](../-variable/from-string.md) | public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | +| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | +| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | +| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | +| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | +| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | +| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | +| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | +| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | +| [getValue](get-value.md) | public [getValue](get-value.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the value of the variable | +| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the value of the variable without validating it | +| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | +| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | +| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | +| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | +| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | +| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | +| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | +| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setValue](set-value.md) | public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the value of the variable | +| [toString](../-variable/to-string.md) | public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [toStringAbsolute](../-variable/to-string-absolute.md) | public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/set-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/set-description.md index 3e537acee0..0147b158ab 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/set-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/set-description.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[BooleanVariable](index.md)/[setDescription](set-description.md) - -# setDescription - - -public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the description for the variable - -#### Parameters - - - -| | | -|---|---| -| description | the description of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDescription + + +public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the description for the variable + +#### Parameters + + + +| | | +|---|---| +| description | the description of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/set-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/set-value.md index c9df13a9af..4f10daa2dd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/set-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/set-value.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[BooleanVariable](index.md)/[setValue](set-value.md) - -# setValue - - -public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets the value of the variable - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setValue + + +public [setValue](set-value.md)(value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets the value of the variable + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/checkin-on-flush.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/checkin-on-flush.md index 952ad68ee1..df229e1d01 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/checkin-on-flush.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/checkin-on-flush.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[CachePin](index.md)/[checkinOnFlush](checkin-on-flush.md) - -# checkinOnFlush - - -public [checkinOnFlush](checkin-on-flush.md)(messsage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Checkin with the specified message when the file is unpinned. It must be open for write, and will be placed under version control if it isn't already. If the medium does not support version control, this is a no-op. - -#### Parameters - - - -| | | -|---|---| -| messsage | the checkin message; may not be null | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# checkinOnFlush + + +public [checkinOnFlush](checkin-on-flush.md)(messsage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Checkin with the specified message when the file is unpinned. It must be open for write, and will be placed under version control if it isn't already. If the medium does not support version control, this is a no-op. + +#### Parameters + + + +| | | +|---|---| +| messsage | the checkin message; may not be null | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/get-local-path.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/get-local-path.md index 6be51fa5be..8c9b0ede5c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/get-local-path.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/get-local-path.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[CachePin](index.md)/[getLocalPath](get-local-path.md) - -# getLocalPath - - -public [getLocalPath](get-local-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Get the local path of the file in the cache. - -#### Return - -the local path of the file, or empty if nothing is pinned. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getLocalPath + + +public [getLocalPath](get-local-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Get the local path of the file in the cache. + +#### Return + +the local path of the file, or empty if nothing is pinned. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/get-url.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/get-url.md index 8faf12d858..18c6c33628 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/get-url.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/get-url.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[CachePin](index.md)/[getUrl](get-url.md) - -# getUrl - - -public [getUrl](get-url.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Get the original URI of the resource. - -#### Return - -the original URI of the resource, or empty if nothing is pinned. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getUrl + + +public [getUrl](get-url.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Get the original URI of the resource. + +#### Return + +the original URI of the resource, or empty if nothing is pinned. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/index.md index 6781d0c629..3ec63a3f10 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/index.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[CachePin](index.md) - -# CachePin - - -public class [CachePin](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -This is the wrapper class that handles the native COM calls to a CachePin. The class is used by Java plug-ins to ModelCenter. - -## Functions - -| Name | Summary | -|---|---| -| [checkinOnFlush](checkin-on-flush.md) | public [checkinOnFlush](checkin-on-flush.md)(messsage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Checkin with the specified message when the file is unpinned. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [getLocalPath](get-local-path.md) | public [getLocalPath](get-local-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the local path of the file in the cache. | -| [getUrl](get-url.md) | public [getUrl](get-url.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the original URI of the resource. | -| [isValid](is-valid.md) | public [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is this object pinning a file? | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [releasePin](release-pin.md) | public [releasePin](release-pin.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Unpin the current file if a file is pinned. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +# CachePin + + +public class [CachePin](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +This is the wrapper class that handles the native COM calls to a CachePin. The class is used by Java plug-ins to ModelCenter. + +## Functions + +| Name | Summary | +|---|---| +| [checkinOnFlush](checkin-on-flush.md) | public [checkinOnFlush](checkin-on-flush.md)(messsage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Checkin with the specified message when the file is unpinned. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [getLocalPath](get-local-path.md) | public [getLocalPath](get-local-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the local path of the file in the cache. | +| [getUrl](get-url.md) | public [getUrl](get-url.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the original URI of the resource. | +| [isValid](is-valid.md) | public [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is this object pinning a file? | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [releasePin](release-pin.md) | public [releasePin](release-pin.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Unpin the current file if a file is pinned. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/is-valid.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/is-valid.md index 13416fbbb7..8c8a9b5c96 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/is-valid.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/is-valid.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[CachePin](index.md)/[isValid](is-valid.md) - -# isValid - - -public [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Is this object pinning a file? - -#### Return - -true if it is, otherwise, false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isValid + + +public [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Is this object pinning a file? + +#### Return + +true if it is, otherwise, false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/release-pin.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/release-pin.md index 097624f2d7..a41d7cd03a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/release-pin.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-cache-pin/release-pin.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[CachePin](index.md)/[releasePin](release-pin.md) - -# releasePin - - -public [releasePin](release-pin.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Unpin the current file if a file is pinned. Does not guarantee that the file will be flushed unless this was the last active pin on the file. - -#### Return - -true if a file was previously pinned, otherwise, false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# releasePin + + +public [releasePin](release-pin.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Unpin the current file if a file is pinned. Does not guarantee that the file will be flushed unless this was the last active pin on the file. + +#### Return + +true if a file was previously pinned, otherwise, false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/-completed-run-data.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/-completed-run-data.md index 18c12ceeff..bd363172cd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/-completed-run-data.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/-completed-run-data.md @@ -1,21 +1,19 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[CompletedRunData](index.md)/[CompletedRunData](-completed-run-data.md) - -# CompletedRunData - - -constructor(runIDs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, errorIDs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, errorMessages: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, variableValues: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>>, endSequenceNumber: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), nextSequenceNumber: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -Creates a new CompletedRunData object. - -#### Parameters - - - -| | | -|---|---| -| runIDs | an array of runIDs that have completed. | -| errorIDs | an array of errorIDs for each corresponding run in runIDs. A value of 0 indicates success, all other values indicate failure. | -| errorMessages | An array of error messages for each corresponding run in runIDs. | -| variableValues | A multi-dimensional array of variable values. The first index corresponds to each run in runIDs, the second index is for each variable in that run. | -| endSequenceNumber | the index of the last available completed run. | -| nextSequenceNumber | use this as the value of startSequenceNumber in the next subsequent call to getCompletedRunData. This value may be greater than (startSequenceNumber + runs) if a given run completed multiple times due to re-runs. | +# CompletedRunData + + +constructor(runIDs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, errorIDs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, errorMessages: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, variableValues: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>>, endSequenceNumber: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), nextSequenceNumber: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +Creates a new CompletedRunData object. + +#### Parameters + + + +| | | +|---|---| +| runIDs | an array of runIDs that have completed. | +| errorIDs | an array of errorIDs for each corresponding run in runIDs. A value of 0 indicates success, all other values indicate failure. | +| errorMessages | An array of error messages for each corresponding run in runIDs. | +| variableValues | A multi-dimensional array of variable values. The first index corresponds to each run in runIDs, the second index is for each variable in that run. | +| endSequenceNumber | the index of the last available completed run. | +| nextSequenceNumber | use this as the value of startSequenceNumber in the next subsequent call to getCompletedRunData. This value may be greater than (startSequenceNumber + runs) if a given run completed multiple times due to re-runs. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-end-sequence-number.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-end-sequence-number.md index dc6e46db9e..80b17066a1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-end-sequence-number.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-end-sequence-number.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[CompletedRunData](index.md)/[getEndSequenceNumber](get-end-sequence-number.md) - -# getEndSequenceNumber - - -public [getEndSequenceNumber](get-end-sequence-number.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -Gets the end sequence number. The end sequence number is the last index of compleded runs (runIDs). +# getEndSequenceNumber + + +public [getEndSequenceNumber](get-end-sequence-number.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Gets the end sequence number. The end sequence number is the last index of compleded runs (runIDs). diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-error-i-ds.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-error-i-ds.md index 5ded36575e..db6465bc6b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-error-i-ds.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-error-i-ds.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[CompletedRunData](index.md)/[getErrorIDs](get-error-i-ds.md) - -# getErrorIDs - - -public [getErrorIDs](get-error-i-ds.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)> - -Gets an array of errorIDs for each corresponding run in runIDs. A value of 0 indicates success, all other values indicate failure. - -#### Return - -the error IDs +# getErrorIDs + + +public [getErrorIDs](get-error-i-ds.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)> + +Gets an array of errorIDs for each corresponding run in runIDs. A value of 0 indicates success, all other values indicate failure. + +#### Return + +the error IDs diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-error-messages.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-error-messages.md index 7d6ddbafc7..0eba50948f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-error-messages.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-error-messages.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[CompletedRunData](index.md)/[getErrorMessages](get-error-messages.md) - -# getErrorMessages - - -public [getErrorMessages](get-error-messages.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> - -Gets an array of error messages for each corresponding run in runIDs. - -#### Return - -the error messages +# getErrorMessages + + +public [getErrorMessages](get-error-messages.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> + +Gets an array of error messages for each corresponding run in runIDs. + +#### Return + +the error messages diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-next-sequence-number.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-next-sequence-number.md index 3fc5a5d059..ccb21d55a5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-next-sequence-number.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-next-sequence-number.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[CompletedRunData](index.md)/[getNextSequenceNumber](get-next-sequence-number.md) - -# getNextSequenceNumber - - -public [getNextSequenceNumber](get-next-sequence-number.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -Gets the next sequence number, which can be used as the value of startSequenceNumber in the next subsequent call to getCompletedRunData. This value may be greater than (startSequenceNumber + runs) if a given run completed multiple times due to re-runs. - -#### Return - -the next sequence number +# getNextSequenceNumber + + +public [getNextSequenceNumber](get-next-sequence-number.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Gets the next sequence number, which can be used as the value of startSequenceNumber in the next subsequent call to getCompletedRunData. This value may be greater than (startSequenceNumber + runs) if a given run completed multiple times due to re-runs. + +#### Return + +the next sequence number diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-run-i-ds.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-run-i-ds.md index b0eeba9b0f..a0f0140fea 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-run-i-ds.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-run-i-ds.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[CompletedRunData](index.md)/[getRunIDs](get-run-i-ds.md) - -# getRunIDs - - -public [getRunIDs](get-run-i-ds.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)> - -Gets an array of the IDs of the runs that have completed. - -#### Return - -the completed run IDs +# getRunIDs + + +public [getRunIDs](get-run-i-ds.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)> + +Gets an array of the IDs of the runs that have completed. + +#### Return + +the completed run IDs diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-variable-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-variable-values.md index ec11f3a11c..fb1234c6a2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-variable-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-variable-values.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[CompletedRunData](index.md)/[getVariableValues](get-variable-values.md) - -# getVariableValues - - -public [getVariableValues](get-variable-values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>> - -Gets a multi-dimensional array of variable values. The first index corresponds to each run in runIDs, the second index is for each variable in that run. - -#### Return - -the variable values +# getVariableValues + + +public [getVariableValues](get-variable-values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>> + +Gets a multi-dimensional array of variable values. The first index corresponds to each run in runIDs, the second index is for each variable in that run. + +#### Return + +the variable values diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/index.md index 848257f229..a53f3daea1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/index.md @@ -1,29 +1,27 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[CompletedRunData](index.md) - -# CompletedRunData - - -public class [CompletedRunData](index.md) - -Structure that contains information about completed runs. - -#### Author - -mbelcher - -## Constructors - -| | | -|---|---| -| [CompletedRunData](-completed-run-data.md) | constructor(runIDs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, errorIDs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, errorMessages: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, variableValues: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>>, endSequenceNumber: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), nextSequenceNumber: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Creates a new CompletedRunData object. | - -## Functions - -| Name | Summary | -|---|---| -| [getEndSequenceNumber](get-end-sequence-number.md) | public [getEndSequenceNumber](get-end-sequence-number.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the end sequence number. | -| [getErrorIDs](get-error-i-ds.md) | public [getErrorIDs](get-error-i-ds.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>
Gets an array of errorIDs for each corresponding run in runIDs. | -| [getErrorMessages](get-error-messages.md) | public [getErrorMessages](get-error-messages.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>
Gets an array of error messages for each corresponding run in runIDs. | -| [getNextSequenceNumber](get-next-sequence-number.md) | public [getNextSequenceNumber](get-next-sequence-number.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the next sequence number, which can be used as the value of startSequenceNumber in the next subsequent call to getCompletedRunData. | -| [getRunIDs](get-run-i-ds.md) | public [getRunIDs](get-run-i-ds.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>
Gets an array of the IDs of the runs that have completed. | -| [getVariableValues](get-variable-values.md) | public [getVariableValues](get-variable-values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>>
Gets a multi-dimensional array of variable values. | +# CompletedRunData + + +public class [CompletedRunData](index.md) + +Structure that contains information about completed runs. + +#### Author + +mbelcher + +## Constructors + +| | | +|---|---| +| [CompletedRunData](-completed-run-data.md) | constructor(runIDs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, errorIDs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, errorMessages: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, variableValues: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>>, endSequenceNumber: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), nextSequenceNumber: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Creates a new CompletedRunData object. | + +## Functions + +| Name | Summary | +|---|---| +| [getEndSequenceNumber](get-end-sequence-number.md) | public [getEndSequenceNumber](get-end-sequence-number.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the end sequence number. | +| [getErrorIDs](get-error-i-ds.md) | public [getErrorIDs](get-error-i-ds.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>
Gets an array of errorIDs for each corresponding run in runIDs. | +| [getErrorMessages](get-error-messages.md) | public [getErrorMessages](get-error-messages.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>
Gets an array of error messages for each corresponding run in runIDs. | +| [getNextSequenceNumber](get-next-sequence-number.md) | public [getNextSequenceNumber](get-next-sequence-number.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the next sequence number, which can be used as the value of startSequenceNumber in the next subsequent call to getCompletedRunData. | +| [getRunIDs](get-run-i-ds.md) | public [getRunIDs](get-run-i-ds.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>
Gets an array of the IDs of the runs that have completed. | +| [getVariableValues](get-variable-values.md) | public [getVariableValues](get-variable-values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>>
Gets a multi-dimensional array of variable values. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md index 9defb7d68e..b2d704e84e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[COMPONENT_TYPE_ASSEMBLY](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md) - -# COMPONENT_TYPE_ASSEMBLY - - -val [COMPONENT_TYPE_ASSEMBLY](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Assembly" +# COMPONENT_TYPE_ASSEMBLY + + +val [COMPONENT_TYPE_ASSEMBLY](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Assembly" diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md index 957c83fddb..c6b21f58e8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[COMPONENT_TYPE_COMPONENT](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md) - -# COMPONENT_TYPE_COMPONENT - - -val [COMPONENT_TYPE_COMPONENT](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Component" +# COMPONENT_TYPE_COMPONENT + + +val [COMPONENT_TYPE_COMPONENT](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Component" diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md index 4116b929cb..b87c1d1f03 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[COMPONENT_TYPE_EMPTY](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md) - -# COMPONENT_TYPE_EMPTY - - -val [COMPONENT_TYPE_EMPTY](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Empty" +# COMPONENT_TYPE_EMPTY + + +val [COMPONENT_TYPE_EMPTY](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Empty" diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md index 8869bf6e9c..e388b80c64 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[COMPONENT_TYPE_FOR_EACH](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md) - -# COMPONENT_TYPE_FOR_EACH - - -val [~~COMPONENT_TYPE_FOR_EACH~~](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ForEach" - ---- - -### Deprecated - ---- +# COMPONENT_TYPE_FOR_EACH + + +val [~~COMPONENT_TYPE_FOR_EACH~~](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ForEach" + +--- + +### Deprecated + +--- diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md index 754d6e5f63..793944c3fc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[COMPONENT_TYPE_IF](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md) - -# COMPONENT_TYPE_IF - - -val [COMPONENT_TYPE_IF](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "If" +# COMPONENT_TYPE_IF + + +val [COMPONENT_TYPE_IF](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "If" diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md index a2ef9e013b..e9b67a85f6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[COMPONENT_TYPE_LOOP](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md) - -# COMPONENT_TYPE_LOOP - - -val [COMPONENT_TYPE_LOOP](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Loop" +# COMPONENT_TYPE_LOOP + + +val [COMPONENT_TYPE_LOOP](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Loop" diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md index 80bc0ed14f..935f440bf8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[COMPONENT_TYPE_PARALLEL](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md) - -# COMPONENT_TYPE_PARALLEL - - -val [COMPONENT_TYPE_PARALLEL](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Parallel" +# COMPONENT_TYPE_PARALLEL + + +val [COMPONENT_TYPE_PARALLEL](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Parallel" diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md index 6979065977..f9f230c7df 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[COMPONENT_TYPE_SCRIPTCOMPONENT](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md) - -# COMPONENT_TYPE_SCRIPTCOMPONENT - - -val [COMPONENT_TYPE_SCRIPTCOMPONENT](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ScriptComponent" +# COMPONENT_TYPE_SCRIPTCOMPONENT + + +val [COMPONENT_TYPE_SCRIPTCOMPONENT](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ScriptComponent" diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md index 7104f1bfbd..d4664c9f8e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[COMPONENT_TYPE_SEQUENCE](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md) - -# COMPONENT_TYPE_SEQUENCE - - -val [COMPONENT_TYPE_SEQUENCE](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Sequence" +# COMPONENT_TYPE_SEQUENCE + + +val [COMPONENT_TYPE_SEQUENCE](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Sequence" diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/download-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/download-values.md index d3ee4e1f5e..df341596fa 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/download-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/download-values.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[downloadValues](download-values.md) - -# downloadValues - - -public [downloadValues](download-values.md)() - -downloads the component's variable values from Analysis Server, if it's an Analysis Server component - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# downloadValues + + +public [downloadValues](download-values.md)() + +downloads the component's variable values from Analysis Server, if it's an Analysis Server component + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-associated-files.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-associated-files.md index fda95b76d7..490576fd07 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-associated-files.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-associated-files.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[getAssociatedFiles](get-associated-files.md) - -# getAssociatedFiles - - -public [getAssociatedFiles](get-associated-files.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> - -gets the associated files of the component - -#### Return - -the associated files - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getAssociatedFiles + + +public [getAssociatedFiles](get-associated-files.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> + +gets the associated files of the component + +#### Return + +the associated files + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-full-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-full-name.md index d4722af364..713c6cd197 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-full-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-full-name.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[getFullName](get-full-name.md) - -# getFullName - - -public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the full name of the current object, e.g. "Model.Script.x" - -#### Return - -the object name - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getFullName + + +public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the full name of the current object, e.g. "Model.Script.x" + +#### Return + +the object name + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-group.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-group.md index d78f38488a..7671c83e5b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-group.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-group.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[getGroup](get-group.md) - -# getGroup - - -public [getGroup](get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](../-group/index.md) - -gets the specified group - -#### Return - -the specified group - -#### Parameters - - - -| | | -|---|---| -| index | the group index (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getGroup](get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](../-group/index.md) - -gets the specified group - -#### Return - -the specified group - -#### Parameters - - - -| | | -|---|---| -| name | the variable name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getGroup + + +public [getGroup](get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](../-group/index.md) + +gets the specified group + +#### Return + +the specified group + +#### Parameters + + + +| | | +|---|---| +| index | the group index (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getGroup](get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](../-group/index.md) + +gets the specified group + +#### Return + +the specified group + +#### Parameters + + + +| | | +|---|---| +| name | the variable name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-index-in-parent.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-index-in-parent.md index 55cc0999e3..4aaf32af27 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-index-in-parent.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-index-in-parent.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[getIndexInParent](get-index-in-parent.md) - -# getIndexInParent - - -public [getIndexInParent](get-index-in-parent.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -Gets the index of the component in its parent assembly. This includes both assemblies and components and can be used to generate an index for ModelCenter.moveTo(). - -#### Return - -the index +# getIndexInParent + + +public [getIndexInParent](get-index-in-parent.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Gets the index of the component in its parent assembly. This includes both assemblies and components and can be used to generate an index for ModelCenter.moveTo(). + +#### Return + +the index diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-metadata.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-metadata.md index 66f5a36fff..b6f4dcd4c3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-metadata.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-metadata.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[getMetadata](get-metadata.md) - -# getMetadata - - -public [getMetadata](get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) - -Get a metadata value. - -#### Return - -the the value, or null if the value is not set or of an unrecognized type - -#### Parameters - - - -| | | -|---|---| -| name | the metadata value's name | +# getMetadata + + +public [getMetadata](get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) + +Get a metadata value. + +#### Return + +the the value, or null if the value is not set or of an unrecognized type + +#### Parameters + + + +| | | +|---|---| +| name | the metadata value's name | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-name.md index 6b266b550b..b3bd82ad9c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-name.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[getName](get-name.md) - -# getName - - -public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the name of the current object, e.g. "x" - -#### Return - -the object name - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getName + + +public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the name of the current object, e.g. "x" + +#### Return + +the object name + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-num-groups.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-num-groups.md index e27a8862f3..fadeac32cb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-num-groups.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-num-groups.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[getNumGroups](get-num-groups.md) - -# getNumGroups - - -public [getNumGroups](get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -get the number of groups stored in this object - -#### Return - -the number of stored groups - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumGroups + + +public [getNumGroups](get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +get the number of groups stored in this object + +#### Return + +the number of stored groups + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-num-variables.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-num-variables.md index 6f404b6bb1..1985ce264e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-num-variables.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-num-variables.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[getNumVariables](get-num-variables.md) - -# getNumVariables - - -public [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -get the number of variables stored in this object - -#### Return - -the number of stored variables - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumVariables + + +public [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +get the number of variables stored in this object + +#### Return + +the number of stored variables + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-parent-assembly.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-parent-assembly.md index dd7d1369c1..147b1dfc07 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-parent-assembly.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-parent-assembly.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[getParentAssembly](get-parent-assembly.md) - -# getParentAssembly - - -public [getParentAssembly](get-parent-assembly.md)(): [Assembly](../-assembly/index.md) - -gets the parent assembly of this component (fails if this is the model/root assembly) - -#### Return - -the assembly - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getParentAssembly + + +public [getParentAssembly](get-parent-assembly.md)(): [Assembly](../-assembly/index.md) + +gets the parent assembly of this component (fails if this is the model/root assembly) + +#### Return + +the assembly + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-position-x.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-position-x.md index 99ecea4654..68ec9d2580 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-position-x.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-position-x.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[getPositionX](get-position-x.md) - -# getPositionX - - -public [getPositionX](get-position-x.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -gets the X co-ordinate value of the current object, - -#### Return - -the X co-ordinate of the position - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getPositionX + + +public [getPositionX](get-position-x.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +gets the X co-ordinate value of the current object, + +#### Return + +the X co-ordinate of the position + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-position-y.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-position-y.md index f9dc63d788..62e4ec4bcf 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-position-y.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-position-y.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[getPositionY](get-position-y.md) - -# getPositionY - - -public [getPositionY](get-position-y.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -gets the Y co-ordinate value of the current object, - -#### Return - -the Y co-ordinate of the position - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getPositionY + + +public [getPositionY](get-position-y.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +gets the Y co-ordinate value of the current object, + +#### Return + +the Y co-ordinate of the position + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-source.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-source.md index 5a30429f6c..0b7443a2cd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-source.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-source.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[getSource](get-source.md) - -# getSource - - -public [getSource](get-source.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the server path for the component, e.g. "mcre://localhost/spring" - -#### Return - -the server path +# getSource + + +public [getSource](get-source.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the server path for the component, e.g. "mcre://localhost/spring" + +#### Return + +the server path diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-type.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-type.md index 25a65c47e0..54e2c8e314 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-type.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-type.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[getType](get-type.md) - -# getType - - -public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the type of the component: COMPONENT_TYPE_COMPONENT = "Component" COMPONENT_TYPE_SCRIPTCOMPONENT = "ScriptComponent" COMPONENT_TYPE_ASSEMBLY = "Assembly" COMPONENT_TYPE_SEQUENCE = "Sequence" COMPONENT_TYPE_IF = "If" COMPONENT_TYPE_PARALLEL = "Parallel" COMPONENT_TYPE_EMPTY = "Empty" COMPONENT_TYPE_FOR_EACH = "ForEach" - -#### Return - -the component type +# getType + + +public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the type of the component: COMPONENT_TYPE_COMPONENT = "Component" COMPONENT_TYPE_SCRIPTCOMPONENT = "ScriptComponent" COMPONENT_TYPE_ASSEMBLY = "Assembly" COMPONENT_TYPE_SEQUENCE = "Sequence" COMPONENT_TYPE_IF = "If" COMPONENT_TYPE_PARALLEL = "Parallel" COMPONENT_TYPE_EMPTY = "Empty" COMPONENT_TYPE_FOR_EACH = "ForEach" + +#### Return + +the component type diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-user-data.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-user-data.md index a093a25b92..e70bd1a14c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-user-data.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-user-data.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[getUserData](get-user-data.md) - -# getUserData - - -public [getUserData](get-user-data.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -Get user data of the component. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getUserData + + +public [getUserData](get-user-data.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Get user data of the component. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-variable.md index 858b8d531b..9f38e96d32 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/get-variable.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[getVariable](get-variable.md) - -# getVariable - - -public [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md) - -gets the specified variable - -#### Return - -the specified variable - -#### Parameters - - - -| | | -|---|---| -| index | the variable index (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) - -gets the specified variable. - -#### Return - -the specified variable - -#### Parameters - - - -| | | -|---|---| -| name | the variable name. Can be a dotted notation string for a variable relative to this component. | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getVariable + + +public [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md) + +gets the specified variable + +#### Return + +the specified variable + +#### Parameters + + + +| | | +|---|---| +| index | the variable index (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) + +gets the specified variable. + +#### Return + +the specified variable + +#### Parameters + + + +| | | +|---|---| +| name | the variable name. Can be a dotted notation string for a variable relative to this component. | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/index.md index aafc410db6..71119a1607 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/index.md @@ -1,68 +1,66 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md) - -# Component - -public class [Component](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [IVariableHolder](../-i-variable-holder/index.md) - -This is the wrapper class that handles the native COM calls to a Component object. The class is used by Java plug-ins to ModelCenter. - -#### Author - -Woyak, 9-01 - -#### Inheritors - -| | -|---| -| [IfComponent](../-if-component/index.md) | -| [ScriptComponent](../-script-component/index.md) | -| [IfComponent](../-if-component/index.md) | -| [ScriptComponent](../-script-component/index.md) | - -## Properties - -| Name | Summary | -|---|---| -| [COMPONENT_TYPE_ASSEMBLY](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md) | val [COMPONENT_TYPE_ASSEMBLY](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Assembly" | -| [COMPONENT_TYPE_COMPONENT](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md) | val [COMPONENT_TYPE_COMPONENT](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Component" | -| [COMPONENT_TYPE_EMPTY](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md) | val [COMPONENT_TYPE_EMPTY](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Empty" | -| [COMPONENT_TYPE_FOR_EACH](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md) | val [~~COMPONENT_TYPE_FOR_EACH~~](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ForEach" | -| [COMPONENT_TYPE_IF](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md) | val [COMPONENT_TYPE_IF](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "If" | -| [COMPONENT_TYPE_LOOP](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md) | val [COMPONENT_TYPE_LOOP](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Loop" | -| [COMPONENT_TYPE_PARALLEL](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md) | val [COMPONENT_TYPE_PARALLEL](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Parallel" | -| [COMPONENT_TYPE_SCRIPTCOMPONENT](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md) | val [COMPONENT_TYPE_SCRIPTCOMPONENT](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ScriptComponent" | -| [COMPONENT_TYPE_SEQUENCE](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md) | val [COMPONENT_TYPE_SEQUENCE](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Sequence" | - -## Functions - -| Name | Summary | -|---|---| -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [downloadValues](download-values.md) | public [downloadValues](download-values.md)()
downloads the component's variable values from Analysis Server, if it's an Analysis Server component | -| [getAssociatedFiles](get-associated-files.md) | public [getAssociatedFiles](get-associated-files.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
gets the associated files of the component | -| [getFullName](get-full-name.md) | public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the full name of the current object, e.g. | -| [getGroup](get-group.md) | public [getGroup](get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](../-group/index.md)
public [getGroup](get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](../-group/index.md)
gets the specified group | -| [getIndexInParent](get-index-in-parent.md) | public [getIndexInParent](get-index-in-parent.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the index of the component in its parent assembly. | -| [getMetadata](get-metadata.md) | public [getMetadata](get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](get-name.md) | public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the current object, e.g. | -| [getNumGroups](get-num-groups.md) | public [getNumGroups](get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of groups stored in this object | -| [getNumVariables](get-num-variables.md) | public [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of variables stored in this object | -| [getParentAssembly](get-parent-assembly.md) | public [getParentAssembly](get-parent-assembly.md)(): [Assembly](../-assembly/index.md)
gets the parent assembly of this component (fails if this is the model/root assembly) | -| [getPositionX](get-position-x.md) | public [getPositionX](get-position-x.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the X co-ordinate value of the current object, | -| [getPositionY](get-position-y.md) | public [getPositionY](get-position-y.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the Y co-ordinate value of the current object, | -| [getSource](get-source.md) | public [getSource](get-source.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the server path for the component, e.g. | -| [getType](get-type.md) | public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the type of the component: COMPONENT_TYPE_COMPONENT = "Component" COMPONENT_TYPE_SCRIPTCOMPONENT = "ScriptComponent" COMPONENT_TYPE_ASSEMBLY = "Assembly" COMPONENT_TYPE_SEQUENCE = "Sequence" COMPONENT_TYPE_IF = "If" COMPONENT_TYPE_PARALLEL = "Parallel" COMPONENT_TYPE_EMPTY = "Empty" COMPONENT_TYPE_FOR_EACH = "ForEach" | -| [getUserData](get-user-data.md) | public [getUserData](get-user-data.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Get user data of the component. | -| [getVariable](get-variable.md) | public [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
gets the specified variable
public [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
gets the specified variable. | -| [invalidate](invalidate.md) | public [invalidate](invalidate.md)()
causes the component to be invalidated | -| [invokeMethod](invoke-method.md) | public [invokeMethod](invoke-method.md)(method: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
invokes a method of the Component | -| [reconnect](reconnect.md) | public [reconnect](reconnect.md)()
reconnects the component | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [rename](rename.md) | public [rename](rename.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Rename the component | -| [run](run.md) | public [run](run.md)()
causes the component to run | -| [setAssociatedFiles](set-associated-files.md) | public [setAssociatedFiles](set-associated-files.md)(val: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>)
sets the associated files of the component | -| [setMetadata](set-metadata.md) | public [setMetadata](set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a component | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setUserData](set-user-data.md) | public [setUserData](set-user-data.md)(val: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
Set user data of the Component | -| [show](show.md) | public [show](show.md)()
Show the GUI form associated with the component, if any. | +# Component + +public class [Component](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [IVariableHolder](../-i-variable-holder/index.md) + +This is the wrapper class that handles the native COM calls to a Component object. The class is used by Java plug-ins to ModelCenter. + +#### Author + +Woyak, 9-01 + +#### Inheritors + +| | +|---| +| [IfComponent](../-if-component/index.md) | +| [ScriptComponent](../-script-component/index.md) | +| [IfComponent](../-if-component/index.md) | +| [ScriptComponent](../-script-component/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [COMPONENT_TYPE_ASSEMBLY](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md) | val [COMPONENT_TYPE_ASSEMBLY](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Assembly" | +| [COMPONENT_TYPE_COMPONENT](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md) | val [COMPONENT_TYPE_COMPONENT](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Component" | +| [COMPONENT_TYPE_EMPTY](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md) | val [COMPONENT_TYPE_EMPTY](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Empty" | +| [COMPONENT_TYPE_FOR_EACH](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md) | val [~~COMPONENT_TYPE_FOR_EACH~~](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ForEach" | +| [COMPONENT_TYPE_IF](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md) | val [COMPONENT_TYPE_IF](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "If" | +| [COMPONENT_TYPE_LOOP](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md) | val [COMPONENT_TYPE_LOOP](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Loop" | +| [COMPONENT_TYPE_PARALLEL](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md) | val [COMPONENT_TYPE_PARALLEL](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Parallel" | +| [COMPONENT_TYPE_SCRIPTCOMPONENT](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md) | val [COMPONENT_TYPE_SCRIPTCOMPONENT](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ScriptComponent" | +| [COMPONENT_TYPE_SEQUENCE](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md) | val [COMPONENT_TYPE_SEQUENCE](-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Sequence" | + +## Functions + +| Name | Summary | +|---|---| +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [downloadValues](download-values.md) | public [downloadValues](download-values.md)()
downloads the component's variable values from Analysis Server, if it's an Analysis Server component | +| [getAssociatedFiles](get-associated-files.md) | public [getAssociatedFiles](get-associated-files.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
gets the associated files of the component | +| [getFullName](get-full-name.md) | public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the full name of the current object, e.g. | +| [getGroup](get-group.md) | public [getGroup](get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](../-group/index.md)
public [getGroup](get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](../-group/index.md)
gets the specified group | +| [getIndexInParent](get-index-in-parent.md) | public [getIndexInParent](get-index-in-parent.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the index of the component in its parent assembly. | +| [getMetadata](get-metadata.md) | public [getMetadata](get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](get-name.md) | public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the current object, e.g. | +| [getNumGroups](get-num-groups.md) | public [getNumGroups](get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of groups stored in this object | +| [getNumVariables](get-num-variables.md) | public [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of variables stored in this object | +| [getParentAssembly](get-parent-assembly.md) | public [getParentAssembly](get-parent-assembly.md)(): [Assembly](../-assembly/index.md)
gets the parent assembly of this component (fails if this is the model/root assembly) | +| [getPositionX](get-position-x.md) | public [getPositionX](get-position-x.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the X co-ordinate value of the current object, | +| [getPositionY](get-position-y.md) | public [getPositionY](get-position-y.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the Y co-ordinate value of the current object, | +| [getSource](get-source.md) | public [getSource](get-source.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the server path for the component, e.g. | +| [getType](get-type.md) | public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the type of the component: COMPONENT_TYPE_COMPONENT = "Component" COMPONENT_TYPE_SCRIPTCOMPONENT = "ScriptComponent" COMPONENT_TYPE_ASSEMBLY = "Assembly" COMPONENT_TYPE_SEQUENCE = "Sequence" COMPONENT_TYPE_IF = "If" COMPONENT_TYPE_PARALLEL = "Parallel" COMPONENT_TYPE_EMPTY = "Empty" COMPONENT_TYPE_FOR_EACH = "ForEach" | +| [getUserData](get-user-data.md) | public [getUserData](get-user-data.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Get user data of the component. | +| [getVariable](get-variable.md) | public [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
gets the specified variable
public [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
gets the specified variable. | +| [invalidate](invalidate.md) | public [invalidate](invalidate.md)()
causes the component to be invalidated | +| [invokeMethod](invoke-method.md) | public [invokeMethod](invoke-method.md)(method: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
invokes a method of the Component | +| [reconnect](reconnect.md) | public [reconnect](reconnect.md)()
reconnects the component | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [rename](rename.md) | public [rename](rename.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Rename the component | +| [run](run.md) | public [run](run.md)()
causes the component to run | +| [setAssociatedFiles](set-associated-files.md) | public [setAssociatedFiles](set-associated-files.md)(val: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>)
sets the associated files of the component | +| [setMetadata](set-metadata.md) | public [setMetadata](set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a component | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setUserData](set-user-data.md) | public [setUserData](set-user-data.md)(val: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
Set user data of the Component | +| [show](show.md) | public [show](show.md)()
Show the GUI form associated with the component, if any. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/invalidate.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/invalidate.md index cc9683975a..41b4629812 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/invalidate.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/invalidate.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[invalidate](invalidate.md) - -# invalidate - - -public [invalidate](invalidate.md)() - -causes the component to be invalidated - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# invalidate + + +public [invalidate](invalidate.md)() + +causes the component to be invalidated + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/invoke-method.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/invoke-method.md index 173a27891b..3bd63a1fb2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/invoke-method.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/invoke-method.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[invokeMethod](invoke-method.md) - -# invokeMethod - - -public [invokeMethod](invoke-method.md)(method: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -invokes a method of the Component - -#### Parameters - - - -| | | -|---|---| -| method | the method name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# invokeMethod + + +public [invokeMethod](invoke-method.md)(method: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +invokes a method of the Component + +#### Parameters + + + +| | | +|---|---| +| method | the method name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/reconnect.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/reconnect.md index f7bb48c366..3706d9e97a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/reconnect.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/reconnect.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[reconnect](reconnect.md) - -# reconnect - - -public [reconnect](reconnect.md)() - -reconnects the component - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# reconnect + + +public [reconnect](reconnect.md)() + +reconnects the component + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/rename.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/rename.md index 710f0bd0d1..15bbd3e5e9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/rename.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/rename.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[rename](rename.md) - -# rename - - -public [rename](rename.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Rename the component - -#### Parameters - - - -| | | -|---|---| -| name | the new name of the component | +# rename + + +public [rename](rename.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Rename the component + +#### Parameters + + + +| | | +|---|---| +| name | the new name of the component | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/run.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/run.md index e3f9bd21da..e18938298d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/run.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/run.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[run](run.md) - -# run - - -public [run](run.md)() - -causes the component to run - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# run + + +public [run](run.md)() + +causes the component to run + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/set-associated-files.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/set-associated-files.md index 010688d5cc..6169487e8d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/set-associated-files.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/set-associated-files.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[setAssociatedFiles](set-associated-files.md) - -# setAssociatedFiles - - -public [setAssociatedFiles](set-associated-files.md)(val: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>) - -sets the associated files of the component - -#### Parameters - - - -| | | -|---|---| -| val | the set of associated files to set | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setAssociatedFiles + + +public [setAssociatedFiles](set-associated-files.md)(val: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>) + +sets the associated files of the component + +#### Parameters + + + +| | | +|---|---| +| val | the set of associated files to set | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/set-metadata.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/set-metadata.md index cceaad6f39..866f5aa5bd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/set-metadata.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/set-metadata.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[setMetadata](set-metadata.md) - -# setMetadata - - -public [setMetadata](set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Set a metadata value on a component - -#### Parameters - - - -| | | -|---|---| -| name | the metadata value's name | -| type | the type of metadata | -| value | the string representation of the value to set | -| access | the access (private, readonly, public) | -| archive | whether to save the data with the model | +# setMetadata + + +public [setMetadata](set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Set a metadata value on a component + +#### Parameters + + + +| | | +|---|---| +| name | the metadata value's name | +| type | the type of metadata | +| value | the string representation of the value to set | +| access | the access (private, readonly, public) | +| archive | whether to save the data with the model | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/set-user-data.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/set-user-data.md index 2320caf9ff..845867d331 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/set-user-data.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/set-user-data.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[setUserData](set-user-data.md) - -# setUserData - - -public [setUserData](set-user-data.md)(val: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)) - -Set user data of the Component - -#### Parameters - - - -| | | -|---|---| -| val | the value to set | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setUserData + + +public [setUserData](set-user-data.md)(val: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)) + +Set user data of the Component + +#### Parameters + + + +| | | +|---|---| +| val | the value to set | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/show.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/show.md index c86782e853..2f0c843c89 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/show.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-component/show.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Component](index.md)/[show](show.md) - -# show - - -public [show](show.md)() - -Show the GUI form associated with the component, if any. +# show + + +public [show](show.md)() + +Show the GUI form associated with the component, if any. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/add-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/add-variable.md index 5f09a12ed2..4bcd933edd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/add-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/add-variable.md @@ -1,29 +1,27 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[CustomDesignPoint](index.md)/[addVariable](add-variable.md) - -# addVariable - - -public [addVariable](add-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isNumeric: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), isValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), isInput: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Adds a variable to the custom design point - -#### Parameters - - - -| | | -|---|---| -| name | the Data Collector name of the variable(can be anything) | -| equation | the equation(usually full ModelCenter variable name) | -| isNumeric | whether or not the variable is numeric | -| isValid | whether or not the variable is valid for this run | -| isInput | whether or not this variable is an input | -| type | the variable's type, i.e. "double" | -| units | the units of the variable | -| value | the value of the variable for this run | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addVariable + + +public [addVariable](add-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isNumeric: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), isValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), isInput: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Adds a variable to the custom design point + +#### Parameters + + + +| | | +|---|---| +| name | the Data Collector name of the variable(can be anything) | +| equation | the equation(usually full ModelCenter variable name) | +| isNumeric | whether or not the variable is numeric | +| isValid | whether or not the variable is valid for this run | +| isInput | whether or not this variable is an input | +| type | the variable's type, i.e. "double" | +| units | the units of the variable | +| value | the value of the variable for this run | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/get-i-d2.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/get-i-d2.md index ff160219cd..bd2b0f1ae8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/get-i-d2.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/get-i-d2.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[CustomDesignPoint](index.md)/[getID2](get-i-d2.md) - -# getID2 - - -public [getID2](get-i-d2.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -Public method for getting the ID for this object - -#### Return - -ID - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getID2 + + +public [getID2](get-i-d2.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +Public method for getting the ID for this object + +#### Return + +ID + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/index.md index 9db2e4bcd2..5f5b7c60bd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/index.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[CustomDesignPoint](index.md) - -# CustomDesignPoint - - -public class [CustomDesignPoint](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -This is the wrapper class that handles the native COM calls to a custom design point. The class is used by Java plug-ins to ModelCenter. - -#### Author - -Mullins, 10-02 - -## Functions - -| Name | Summary | -|---|---| -| [addVariable](add-variable.md) | public [addVariable](add-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isNumeric: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), isValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), isInput: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Adds a variable to the custom design point | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [getID2](get-i-d2.md) | public [getID2](get-i-d2.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Public method for getting the ID for this object | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [runFailed](run-failed.md) | public [runFailed](run-failed.md)(reason: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Tells the Data Collector that this run failed | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +# CustomDesignPoint + + +public class [CustomDesignPoint](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +This is the wrapper class that handles the native COM calls to a custom design point. The class is used by Java plug-ins to ModelCenter. + +#### Author + +Mullins, 10-02 + +## Functions + +| Name | Summary | +|---|---| +| [addVariable](add-variable.md) | public [addVariable](add-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isNumeric: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), isValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), isInput: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Adds a variable to the custom design point | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [getID2](get-i-d2.md) | public [getID2](get-i-d2.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Public method for getting the ID for this object | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [runFailed](run-failed.md) | public [runFailed](run-failed.md)(reason: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Tells the Data Collector that this run failed | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/run-failed.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/run-failed.md index e61a1dbec5..d19398456c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/run-failed.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/run-failed.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[CustomDesignPoint](index.md)/[runFailed](run-failed.md) - -# runFailed - - -public [runFailed](run-failed.md)(reason: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Tells the Data Collector that this run failed - -#### Parameters - - - -| | | -|---|---| -| reason | the reason the run failed | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# runFailed + + +public [runFailed](run-failed.md)(reason: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Tells the Data Collector that this run failed + +#### Parameters + + + +| | | +|---|---| +| reason | the reason the run failed | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/-d-h-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/-d-h-variable.md index fa68891e1b..bd511d6ff8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/-d-h-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/-d-h-variable.md @@ -1,19 +1,17 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[DHVariable](-d-h-variable.md) - -# DHVariable - - -constructor(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -Connects this Java object to the specified session of ModelCenter - -#### Parameters - - - -| | | -|---|---| -| id | A pointer to the COM interface. This constructor will add a COM reference. The reference will be removed when this object is finalized (or closed) | - - -constructor(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) +# DHVariable + + +constructor(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +Connects this Java object to the specified session of ModelCenter + +#### Parameters + + + +| | | +|---|---| +| id | A pointer to the COM interface. This constructor will add a COM reference. The reference will be removed when this object is finalized (or closed) | + + +constructor(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-alias.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-alias.md index 03c912b34a..75426c4a30 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-alias.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-alias.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[getEnumAlias](get-enum-alias.md) - -# getEnumAlias - - -public [getEnumAlias](get-enum-alias.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the Enum Alias given an index - -#### Return - -the Enum Alias - -#### Parameters - - - -| | | -|---|---| -| index | the position in the array of the item to get the enumerations for (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEnumAlias + + +public [getEnumAlias](get-enum-alias.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the Enum Alias given an index + +#### Return + +the Enum Alias + +#### Parameters + + + +| | | +|---|---| +| index | the position in the array of the item to get the enumerations for (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-aliases.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-aliases.md index 8efa6a15f9..6c8d728ff1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-aliases.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-aliases.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[getEnumAliases](get-enum-aliases.md) - -# getEnumAliases - - -public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the Enum Aliases - -#### Return - -String - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEnumAliases + + +public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the Enum Aliases + +#### Return + +String + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-value.md index 2ac0f3ea86..1f70e87581 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-value.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[getEnumValue](get-enum-value.md) - -# getEnumValue - - -public [getEnumValue](get-enum-value.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the Enum Value - -#### Return - -the Enum Value - -#### Parameters - - - -| | | -|---|---| -| index | the position in the array of the item to get the enumerations for (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEnumValue + + +public [getEnumValue](get-enum-value.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the Enum Value + +#### Return + +the Enum Value + +#### Parameters + + + +| | | +|---|---| +| index | the position in the array of the item to get the enumerations for (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-values.md index 8595a8cae9..bc36f37f49 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-values.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[getEnumValues](get-enum-values.md) - -# getEnumValues - - -public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the Enum Values - -#### Return - -String - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEnumValues + + +public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the Enum Values + +#### Return + +String + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-equation.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-equation.md index 09740fa214..46ea78f3ff 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-equation.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-equation.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[getEquation](get-equation.md) - -# getEquation - - -public [getEquation](get-equation.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the Equation - -#### Return - -String - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEquation + + +public [getEquation](get-equation.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the Equation + +#### Return + +String + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-format.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-format.md index de05c62a6f..e0c1d1cc72 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-format.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-format.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[getFormat](get-format.md) - -# getFormat - - -public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the format - -#### Return - -String - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getFormat + + +public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the format + +#### Return + +String + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-lower-bound.md index d542f05818..e51324a2af 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-lower-bound.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[getLowerBound](get-lower-bound.md) - -# getLowerBound - - -public [getLowerBound](get-lower-bound.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -gets the LowerBound - -#### Return - -an Object - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getLowerBound + + +public [getLowerBound](get-lower-bound.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +gets the LowerBound + +#### Return + +an Object + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-meta-data.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-meta-data.md index 7bb13b1ee9..d0d0d0a4d0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-meta-data.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-meta-data.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[getMetaData](get-meta-data.md) - -# getMetaData - - -public [getMetaData](get-meta-data.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the specified meta data - -#### Return - -the value associated with the specified key - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getMetaData + + +public [getMetaData](get-meta-data.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the specified meta data + +#### Return + +the value associated with the specified key + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-name.md index 038252c786..bdf9560508 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-name.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[getName](get-name.md) - -# getName - - -public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -returns the name - -#### Return - -String - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getName + + +public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +returns the name + +#### Return + +String + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-num-enum-alias.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-num-enum-alias.md index 239e22525c..ba6bcd562d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-num-enum-alias.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-num-enum-alias.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[getNumEnumAlias](get-num-enum-alias.md) - -# getNumEnumAlias - - -public [getNumEnumAlias](get-num-enum-alias.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the number of Enum Alias - -#### Return - -the Number of Enum Alias - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumEnumAlias + + +public [getNumEnumAlias](get-num-enum-alias.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the number of Enum Alias + +#### Return + +the Number of Enum Alias + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-num-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-num-enum-values.md index 89ecb4d3bb..30b0ef676d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-num-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-num-enum-values.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[getNumEnumValues](get-num-enum-values.md) - -# getNumEnumValues - - -public [getNumEnumValues](get-num-enum-values.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the Number of Enum Values - -#### Return - -long - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumEnumValues + + +public [getNumEnumValues](get-num-enum-values.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the Number of Enum Values + +#### Return + +long + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-type.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-type.md index 31af5105ae..813056145c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-type.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-type.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[getType](get-type.md) - -# getType - - -public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the type - -#### Return - -the type - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getType + + +public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the type + +#### Return + +the type + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-units.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-units.md index 2d30d9a574..528c4dfe6e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-units.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-units.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[getUnits](get-units.md) - -# getUnits - - -public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -get the units - -#### Return - -the units - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getUnits + + +public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +get the units + +#### Return + +the units + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-upper-bound.md index c72a5d5463..bfb76ee406 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-upper-bound.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[getUpperBound](get-upper-bound.md) - -# getUpperBound - - -public [getUpperBound](get-upper-bound.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -returns the Upper Bound - -#### Return - -an Object - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getUpperBound + + +public [getUpperBound](get-upper-bound.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +returns the Upper Bound + +#### Return + +an Object + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/index.md index 20d1098af7..915cf34589 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/index.md @@ -1,54 +1,52 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md) - -# DHVariable - - -public class [DHVariable](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -This is the wrapper class that handles the native COM calls to a Data History Variable. The class is used by Java plug-ins to ModelCenter. - -## Constructors - -| | | -|---|---| -| [DHVariable](-d-h-variable.md) | constructor(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Connects this Java object to the specified session of ModelCenter
constructor(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | - -## Functions - -| Name | Summary | -|---|---| -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [getEnumAlias](get-enum-alias.md) | public [getEnumAlias](get-enum-alias.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the Enum Alias given an index | -| [getEnumAliases](get-enum-aliases.md) | public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the Enum Aliases | -| [getEnumValue](get-enum-value.md) | public [getEnumValue](get-enum-value.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the Enum Value | -| [getEnumValues](get-enum-values.md) | public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the Enum Values | -| [getEquation](get-equation.md) | public [getEquation](get-equation.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the Equation | -| [getFormat](get-format.md) | public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the format | -| [getLowerBound](get-lower-bound.md) | public [getLowerBound](get-lower-bound.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
gets the LowerBound | -| [getMetaData](get-meta-data.md) | public [getMetaData](get-meta-data.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the specified meta data | -| [getName](get-name.md) | public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
returns the name | -| [getNumEnumAlias](get-num-enum-alias.md) | public [getNumEnumAlias](get-num-enum-alias.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of Enum Alias | -| [getNumEnumValues](get-num-enum-values.md) | public [getNumEnumValues](get-num-enum-values.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the Number of Enum Values | -| [getType](get-type.md) | public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the type | -| [getUnits](get-units.md) | public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the units | -| [getUpperBound](get-upper-bound.md) | public [getUpperBound](get-upper-bound.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
returns the Upper Bound | -| [isDesignVar](is-design-var.md) | public [isDesignVar](is-design-var.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks to see if there is a Design Variable | -| [isInput](is-input.md) | public [isInput](is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks for input | -| [isNumeric](is-numeric.md) | public [isNumeric](is-numeric.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks to see if numeric | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [removeMetadata](remove-metadata.md) | public [removeMetadata](remove-metadata.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
removes the metadata for the specified key | -| [setDesignVar](set-design-var.md) | public [setDesignVar](set-design-var.md)(isDesignVar: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets if this is a Design Variable | -| [setEnumAliases](set-enum-aliases.md) | public [setEnumAliases](set-enum-aliases.md)(aliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Enum Aliases | -| [setEnumValues](set-enum-values.md) | public [setEnumValues](set-enum-values.md)(values: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Enum Values | -| [setEquation](set-equation.md) | public [setEquation](set-equation.md)(equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Equation | -| [setFormat](set-format.md) | public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the format | -| [setInput](set-input.md) | public [setInput](set-input.md)(isInput: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets whether the variable is an input | -| [setLowerBound](set-lower-bound.md) | public [setLowerBound](set-lower-bound.md)(lwrBnd: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
gets ModelCenter --was IDispatch in COM | -| [setMetaData](set-meta-data.md) | public [setMetaData](set-meta-data.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the specified meta data | -| [setName](set-name.md) | public [setName](set-name.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the name | -| [setNumeric](set-numeric.md) | public [setNumeric](set-numeric.md)(isNumeric: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets whether or not the variable represents a numeric value. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setType](set-type.md) | public [setType](set-type.md)(type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the type | -| [setUnits](set-units.md) | public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the units | -| [setUpperBound](set-upper-bound.md) | public [setUpperBound](set-upper-bound.md)(upprBnd: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
sets the Upper Bound | +# DHVariable + + +public class [DHVariable](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +This is the wrapper class that handles the native COM calls to a Data History Variable. The class is used by Java plug-ins to ModelCenter. + +## Constructors + +| | | +|---|---| +| [DHVariable](-d-h-variable.md) | constructor(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Connects this Java object to the specified session of ModelCenter
constructor(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | + +## Functions + +| Name | Summary | +|---|---| +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [getEnumAlias](get-enum-alias.md) | public [getEnumAlias](get-enum-alias.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the Enum Alias given an index | +| [getEnumAliases](get-enum-aliases.md) | public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the Enum Aliases | +| [getEnumValue](get-enum-value.md) | public [getEnumValue](get-enum-value.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the Enum Value | +| [getEnumValues](get-enum-values.md) | public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the Enum Values | +| [getEquation](get-equation.md) | public [getEquation](get-equation.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the Equation | +| [getFormat](get-format.md) | public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the format | +| [getLowerBound](get-lower-bound.md) | public [getLowerBound](get-lower-bound.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
gets the LowerBound | +| [getMetaData](get-meta-data.md) | public [getMetaData](get-meta-data.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the specified meta data | +| [getName](get-name.md) | public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
returns the name | +| [getNumEnumAlias](get-num-enum-alias.md) | public [getNumEnumAlias](get-num-enum-alias.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of Enum Alias | +| [getNumEnumValues](get-num-enum-values.md) | public [getNumEnumValues](get-num-enum-values.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the Number of Enum Values | +| [getType](get-type.md) | public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the type | +| [getUnits](get-units.md) | public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the units | +| [getUpperBound](get-upper-bound.md) | public [getUpperBound](get-upper-bound.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
returns the Upper Bound | +| [isDesignVar](is-design-var.md) | public [isDesignVar](is-design-var.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks to see if there is a Design Variable | +| [isInput](is-input.md) | public [isInput](is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks for input | +| [isNumeric](is-numeric.md) | public [isNumeric](is-numeric.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks to see if numeric | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [removeMetadata](remove-metadata.md) | public [removeMetadata](remove-metadata.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
removes the metadata for the specified key | +| [setDesignVar](set-design-var.md) | public [setDesignVar](set-design-var.md)(isDesignVar: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets if this is a Design Variable | +| [setEnumAliases](set-enum-aliases.md) | public [setEnumAliases](set-enum-aliases.md)(aliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Enum Aliases | +| [setEnumValues](set-enum-values.md) | public [setEnumValues](set-enum-values.md)(values: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Enum Values | +| [setEquation](set-equation.md) | public [setEquation](set-equation.md)(equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Equation | +| [setFormat](set-format.md) | public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the format | +| [setInput](set-input.md) | public [setInput](set-input.md)(isInput: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets whether the variable is an input | +| [setLowerBound](set-lower-bound.md) | public [setLowerBound](set-lower-bound.md)(lwrBnd: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
gets ModelCenter --was IDispatch in COM | +| [setMetaData](set-meta-data.md) | public [setMetaData](set-meta-data.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the specified meta data | +| [setName](set-name.md) | public [setName](set-name.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the name | +| [setNumeric](set-numeric.md) | public [setNumeric](set-numeric.md)(isNumeric: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets whether or not the variable represents a numeric value. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setType](set-type.md) | public [setType](set-type.md)(type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the type | +| [setUnits](set-units.md) | public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the units | +| [setUpperBound](set-upper-bound.md) | public [setUpperBound](set-upper-bound.md)(upprBnd: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
sets the Upper Bound | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/is-design-var.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/is-design-var.md index a57606e98f..f97e42bede 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/is-design-var.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/is-design-var.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[isDesignVar](is-design-var.md) - -# isDesignVar - - -public [isDesignVar](is-design-var.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -checks to see if there is a Design Variable - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isDesignVar + + +public [isDesignVar](is-design-var.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +checks to see if there is a Design Variable + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/is-input.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/is-input.md index c76eb35bc2..51e0ed432f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/is-input.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/is-input.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[isInput](is-input.md) - -# isInput - - -public [isInput](is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -checks for input - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isInput + + +public [isInput](is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +checks for input + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/is-numeric.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/is-numeric.md index 134da566e0..1cd2c32216 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/is-numeric.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/is-numeric.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[isNumeric](is-numeric.md) - -# isNumeric - - -public [isNumeric](is-numeric.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -checks to see if numeric - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isNumeric + + +public [isNumeric](is-numeric.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +checks to see if numeric + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/remove-metadata.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/remove-metadata.md index cca924cfba..68364416a7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/remove-metadata.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/remove-metadata.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[removeMetadata](remove-metadata.md) - -# removeMetadata - - -public [removeMetadata](remove-metadata.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -removes the metadata for the specified key - -#### Parameters - - - -| | | -|---|---| -| key | key for metadata to remove | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# removeMetadata + + +public [removeMetadata](remove-metadata.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +removes the metadata for the specified key + +#### Parameters + + + +| | | +|---|---| +| key | key for metadata to remove | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-design-var.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-design-var.md index 2ae86992bf..d3d80497cf 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-design-var.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-design-var.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[setDesignVar](set-design-var.md) - -# setDesignVar - - -public [setDesignVar](set-design-var.md)(isDesignVar: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets if this is a Design Variable - -#### Parameters - - - -| | | -|---|---| -| isDesignVar | true or false | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDesignVar + + +public [setDesignVar](set-design-var.md)(isDesignVar: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets if this is a Design Variable + +#### Parameters + + + +| | | +|---|---| +| isDesignVar | true or false | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-enum-aliases.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-enum-aliases.md index b07612e0a4..a45c20ed58 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-enum-aliases.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-enum-aliases.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[setEnumAliases](set-enum-aliases.md) - -# setEnumAliases - - -public [setEnumAliases](set-enum-aliases.md)(aliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the Enum Aliases - -#### Parameters - - - -| | | -|---|---| -| aliases | aliases | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setEnumAliases + + +public [setEnumAliases](set-enum-aliases.md)(aliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the Enum Aliases + +#### Parameters + + + +| | | +|---|---| +| aliases | aliases | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-enum-values.md index 5b1f26c985..9b8c076588 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-enum-values.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[setEnumValues](set-enum-values.md) - -# setEnumValues - - -public [setEnumValues](set-enum-values.md)(values: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the Enum Values - -#### Parameters - - - -| | -|---| -| values | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setEnumValues + + +public [setEnumValues](set-enum-values.md)(values: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the Enum Values + +#### Parameters + + + +| | +|---| +| values | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-equation.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-equation.md index 75ecbac5f4..c53d56a96f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-equation.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-equation.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[setEquation](set-equation.md) - -# setEquation - - -public [setEquation](set-equation.md)(equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the Equation - -#### Parameters - - - -| | -|---| -| equation | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setEquation + + +public [setEquation](set-equation.md)(equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the Equation + +#### Parameters + + + +| | +|---| +| equation | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-format.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-format.md index 773eeaac42..af9c5e97e6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-format.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-format.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[setFormat](set-format.md) - -# setFormat - - -public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the format - -#### Parameters - - - -| | -|---| -| format | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setFormat + + +public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the format + +#### Parameters + + + +| | +|---| +| format | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-input.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-input.md index a34bb0ee13..49d9712cab 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-input.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-input.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[setInput](set-input.md) - -# setInput - - -public [setInput](set-input.md)(isInput: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets whether the variable is an input - -#### Parameters - - - -| | | -|---|---| -| isInput | whether this is an input | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setInput + + +public [setInput](set-input.md)(isInput: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets whether the variable is an input + +#### Parameters + + + +| | | +|---|---| +| isInput | whether this is an input | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-lower-bound.md index f207e2ca97..75f2f75591 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-lower-bound.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[setLowerBound](set-lower-bound.md) - -# setLowerBound - - -public [setLowerBound](set-lower-bound.md)(lwrBnd: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)) - -gets ModelCenter --was IDispatch in COM - -#### Parameters - - - -| | | -|---|---| -| lwrBnd | an Object | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setLowerBound + + +public [setLowerBound](set-lower-bound.md)(lwrBnd: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)) + +gets ModelCenter --was IDispatch in COM + +#### Parameters + + + +| | | +|---|---| +| lwrBnd | an Object | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-meta-data.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-meta-data.md index 836706f8c6..bddba43046 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-meta-data.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-meta-data.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[setMetaData](set-meta-data.md) - -# setMetaData - - -public [setMetaData](set-meta-data.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the specified meta data - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setMetaData + + +public [setMetaData](set-meta-data.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the specified meta data + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-name.md index 1ce60ddfd1..d780f3be13 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-name.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[setName](set-name.md) - -# setName - - -public [setName](set-name.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the name - -#### Parameters - - - -| | -|---| -| name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setName + + +public [setName](set-name.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the name + +#### Parameters + + + +| | +|---| +| name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-numeric.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-numeric.md index 3414a432ac..7497b9c821 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-numeric.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-numeric.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[setNumeric](set-numeric.md) - -# setNumeric - - -public [setNumeric](set-numeric.md)(isNumeric: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Sets whether or not the variable represents a numeric value. - -#### Parameters - - - -| | | -|---|---| -| isNumeric | if true, the variable is numeric | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setNumeric + + +public [setNumeric](set-numeric.md)(isNumeric: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Sets whether or not the variable represents a numeric value. + +#### Parameters + + + +| | | +|---|---| +| isNumeric | if true, the variable is numeric | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-type.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-type.md index c0f0a25a67..c3336a3a73 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-type.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-type.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[setType](set-type.md) - -# setType - - -public [setType](set-type.md)(type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the type - -#### Parameters - - - -| | -|---| -| type | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setType + + +public [setType](set-type.md)(type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the type + +#### Parameters + + + +| | +|---| +| type | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-units.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-units.md index 725b6ff01b..ca163b6e2e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-units.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-units.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[setUnits](set-units.md) - -# setUnits - - -public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the units - -#### Parameters - - - -| | | -|---|---| -| units | the units to set | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setUnits + + +public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the units + +#### Parameters + + + +| | | +|---|---| +| units | the units to set | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-upper-bound.md index 67591bc6ef..4f5d6d63dc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-upper-bound.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DHVariable](index.md)/[setUpperBound](set-upper-bound.md) - -# setUpperBound - - -public [setUpperBound](set-upper-bound.md)(upprBnd: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)) - -sets the Upper Bound - -#### Parameters - - - -| | | -|---|---| -| upprBnd | an Object | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setUpperBound + + +public [setUpperBound](set-upper-bound.md)(upprBnd: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)) + +sets the Upper Bound + +#### Parameters + + + +| | | +|---|---| +| upprBnd | an Object | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/-data-collector.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/-data-collector.md index 91744ed400..e9b64fe225 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/-data-collector.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/-data-collector.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[DataCollector](-data-collector.md) - -# DataCollector - - -constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -Connects this Java object to the specified session of ModelCenter - -#### Parameters - - - -| | | -|---|---| -| pstrm | A pointer to the COM interface. This constructor will add a COM reference. The reference will be removed when this object is finalized (or closed) | +# DataCollector + + +constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +Connects this Java object to the specified session of ModelCenter + +#### Parameters + + + +| | | +|---|---| +| pstrm | A pointer to the COM interface. This constructor will add a COM reference. The reference will be removed when this object is finalized (or closed) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/add-custom.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/add-custom.md index 2114854771..b810ea3c21 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/add-custom.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/add-custom.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[addCustom](add-custom.md) - -# addCustom - - -public [addCustom](add-custom.md)(eqn: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -adds a custom variable to be displayed in the Data Collector - -#### Parameters - - - -| | | -|---|---| -| eqn | the equation of variables, e.g.: "Model.Script.x + Model.Script.y" | -| label | the label for the equation, e.g.: "Design Var 1" | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addCustom + + +public [addCustom](add-custom.md)(eqn: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +adds a custom variable to be displayed in the Data Collector + +#### Parameters + + + +| | | +|---|---| +| eqn | the equation of variables, e.g.: "Model.Script.x + Model.Script.y" | +| label | the label for the equation, e.g.: "Design Var 1" | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/create-empty-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/create-empty-runs.md index 4ec4adb600..e142a33142 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/create-empty-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/create-empty-runs.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[createEmptyRuns](create-empty-runs.md) - -# createEmptyRuns - - -public [createEmptyRuns](create-empty-runs.md)(numEmptyRuns: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -For internal use only +# createEmptyRuns + + +public [createEmptyRuns](create-empty-runs.md)(numEmptyRuns: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +For internal use only diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-carpet-plot-tab.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-carpet-plot-tab.md index 7ed3380b89..497b416e2f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-carpet-plot-tab.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-carpet-plot-tab.md @@ -1,10 +1,8 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[enableCarpetPlotTab](enable-carpet-plot-tab.md) - -# enableCarpetPlotTab - - -public [enableCarpetPlotTab](enable-carpet-plot-tab.md)(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), var1: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), var2: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plotVar: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -public [enableCarpetPlotTab](enable-carpet-plot-tab.md)(var1: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), var2: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plotVar: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -For internal use only +# enableCarpetPlotTab + + +public [enableCarpetPlotTab](enable-carpet-plot-tab.md)(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), var1: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), var2: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plotVar: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +public [enableCarpetPlotTab](enable-carpet-plot-tab.md)(var1: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), var2: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plotVar: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +For internal use only diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-graph-tab.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-graph-tab.md index f00aa367ff..e4f8502876 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-graph-tab.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-graph-tab.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[enableGraphTab](enable-graph-tab.md) - -# enableGraphTab - - -public [enableGraphTab](enable-graph-tab.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Enables the Graph tab - -#### Parameters - - - -| | | -|---|---| -| flag | true(enable) or false(disable) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# enableGraphTab + + +public [enableGraphTab](enable-graph-tab.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Enables the Graph tab + +#### Parameters + + + +| | | +|---|---| +| flag | true(enable) or false(disable) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-main-effects-tab.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-main-effects-tab.md index 186629f8d0..053fb08850 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-main-effects-tab.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-main-effects-tab.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[enableMainEffectsTab](enable-main-effects-tab.md) - -# enableMainEffectsTab - - -public [enableMainEffectsTab](enable-main-effects-tab.md)() - -For internal use only +# enableMainEffectsTab + + +public [enableMainEffectsTab](enable-main-effects-tab.md)() + +For internal use only diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/end-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/end-runs.md index 6134945ab1..ae74f51378 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/end-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/end-runs.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[endRuns](end-runs.md) - -# endRuns - - -public [endRuns](end-runs.md)() - -lets the Data Collector know that all runs have completed - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# endRuns + + +public [endRuns](end-runs.md)() + +lets the Data Collector know that all runs have completed + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/export-to-c-s-v.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/export-to-c-s-v.md index 36c1c1cc79..c946859810 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/export-to-c-s-v.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/export-to-c-s-v.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[exportToCSV](export-to-c-s-v.md) - -# exportToCSV - - -public [exportToCSV](export-to-c-s-v.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -exports the trade study data to a comma-separated file - -#### Parameters - - - -| | | -|---|---| -| fileName | the .csv file to save to | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# exportToCSV + + +public [exportToCSV](export-to-c-s-v.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +exports the trade study data to a comma-separated file + +#### Parameters + + + +| | | +|---|---| +| fileName | the .csv file to save to | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/from-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/from-string.md index cde541bf5e..0851935f4d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/from-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/from-string.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[fromString](from-string.md) - -# fromString - - -public [fromString](from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Restores a Data Collector setup from a string generated by "toString" - -#### Parameters - - - -| | | -|---|---| -| str | the setup string | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# fromString + + +public [fromString](from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Restores a Data Collector setup from a string generated by "toString" + +#### Parameters + + + +| | | +|---|---| +| str | the setup string | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-data-explorer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-data-explorer.md index dbf946882e..20c0cedb04 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-data-explorer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-data-explorer.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[getDataExplorer](get-data-explorer.md) - -# getDataExplorer - - -public [getDataExplorer](get-data-explorer.md)(): [DataExplorer](../-data-explorer/index.md) - -Gets the associated Data Explorer window - -#### Return - -the associated Data Explorer window object - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDataExplorer + + +public [getDataExplorer](get-data-explorer.md)(): [DataExplorer](../-data-explorer/index.md) + +Gets the associated Data Explorer window + +#### Return + +the associated Data Explorer window object + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-error-i-d.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-error-i-d.md index 65edbe2e48..cdfd2578b7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-error-i-d.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-error-i-d.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[getErrorID](get-error-i-d.md) - -# getErrorID - - -public [getErrorID](get-error-i-d.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -get the error id for the specified run - -#### Return - -the error id - will be 0 if no error occurred - -#### Parameters - - - -| | | -|---|---| -| run | the run to get the error for (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getErrorID + + +public [getErrorID](get-error-i-d.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +get the error id for the specified run + +#### Return + +the error id - will be 0 if no error occurred + +#### Parameters + + + +| | | +|---|---| +| run | the run to get the error for (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-error-message.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-error-message.md index 2eca16fc83..7344320348 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-error-message.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-error-message.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[getErrorMessage](get-error-message.md) - -# getErrorMessage - - -public [getErrorMessage](get-error-message.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the error message associated with the specified run - -#### Return - -the error message - -#### Parameters - - - -| | | -|---|---| -| run | the run to get the error for (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getErrorMessage + + +public [getErrorMessage](get-error-message.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the error message associated with the specified run + +#### Return + +the error message + +#### Parameters + + + +| | | +|---|---| +| run | the run to get the error for (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-num-failed-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-num-failed-runs.md index fbc9efe4eb..11ac6df75b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-num-failed-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-num-failed-runs.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[getNumFailedRuns](get-num-failed-runs.md) - -# getNumFailedRuns - - -public [getNumFailedRuns](get-num-failed-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the number of failed runs - -#### Return - -the number of failed runs - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumFailedRuns + + +public [getNumFailedRuns](get-num-failed-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the number of failed runs + +#### Return + +the number of failed runs + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-num-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-num-runs.md index ba76515900..8fc89d1868 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-num-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-num-runs.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[getNumRuns](get-num-runs.md) - -# getNumRuns - - -public [getNumRuns](get-num-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the number of runs stored in the Data Collector - -#### Return - -the number of runs - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumRuns + + +public [getNumRuns](get-num-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the number of runs stored in the Data Collector + +#### Return + +the number of runs + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-num-variables.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-num-variables.md index e920b3b08a..356c29e7da 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-num-variables.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-num-variables.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[getNumVariables](get-num-variables.md) - -# getNumVariables - - -public [getNumVariables](get-num-variables.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the number of variables stored in the Data Collector - -#### Return - -the number of variables - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumVariables + + +public [getNumVariables](get-num-variables.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the number of variables stored in the Data Collector + +#### Return + +the number of variables + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-value.md index 52f4c6eb58..76067547cf 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-value.md @@ -1,51 +1,49 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[getValue](get-value.md) - -# getValue - - -public [getValue](get-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Variant](../-variant/index.md) - -gets the value for a specified variable - -#### Return - -the variable value - -#### Parameters - - - -| | | -|---|---| -| name | the variable to get the value for | -| run | the run to get the value for (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Variant](../-variant/index.md) - -gets the value for a specified variable - -#### Return - -the variable value - -#### Parameters - - - -| | | -|---|---| -| index | the variable to get the value for (0-based index) | -| run | the run to get the value for (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValue + + +public [getValue](get-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Variant](../-variant/index.md) + +gets the value for a specified variable + +#### Return + +the variable value + +#### Parameters + + + +| | | +|---|---| +| name | the variable to get the value for | +| run | the run to get the value for (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Variant](../-variant/index.md) + +gets the value for a specified variable + +#### Return + +the variable value + +#### Parameters + + + +| | | +|---|---| +| index | the variable to get the value for (0-based index) | +| run | the run to get the value for (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-variable-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-variable-description.md index 273784f7d4..ef95fb3490 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-variable-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-variable-description.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[getVariableDescription](get-variable-description.md) - -# getVariableDescription - - -public [getVariableDescription](get-variable-description.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [VariableDescription](../-variable-description/index.md) - -gets a description object for the specified variable - -#### Return - -a VariableDescription object - -#### Parameters - - - -| | | -|---|---| -| name | the name of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getVariableDescription](get-variable-description.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [VariableDescription](../-variable-description/index.md) - -gets a description object for the specified variable - -#### Return - -a VariableDescription object - -#### Parameters - - - -| | | -|---|---| -| index | the array index of the variable (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getVariableDescription + + +public [getVariableDescription](get-variable-description.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [VariableDescription](../-variable-description/index.md) + +gets a description object for the specified variable + +#### Return + +a VariableDescription object + +#### Parameters + + + +| | | +|---|---| +| name | the name of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getVariableDescription](get-variable-description.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [VariableDescription](../-variable-description/index.md) + +gets a description object for the specified variable + +#### Return + +a VariableDescription object + +#### Parameters + + + +| | | +|---|---| +| index | the array index of the variable (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/hide.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/hide.md index ab686cd904..3a7f62f37f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/hide.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/hide.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[hide](hide.md) - -# hide - - -public [hide](hide.md)() - -caused the Data Collector to hide - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# hide + + +public [hide](hide.md)() + +caused the Data Collector to hide + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/index.md index 32aee5e35e..16134cb02b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/index.md @@ -1,58 +1,56 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md) - -# DataCollector - - -public class [DataCollector](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -This is the wrapper class that handles the native COM calls to a Data Collector. The class is used by Java plug-ins to ModelCenter. - -#### Author - -Woyak, 9-01 - -## Constructors - -| | | -|---|---| -| [DataCollector](-data-collector.md) | constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Connects this Java object to the specified session of ModelCenter | - -## Functions - -| Name | Summary | -|---|---| -| [addCustom](add-custom.md) | public [addCustom](add-custom.md)(eqn: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
adds a custom variable to be displayed in the Data Collector | -| [createEmptyRuns](create-empty-runs.md) | public [createEmptyRuns](create-empty-runs.md)(numEmptyRuns: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
For internal use only | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [enableCarpetPlotTab](enable-carpet-plot-tab.md) | public [enableCarpetPlotTab](enable-carpet-plot-tab.md)(var1: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), var2: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plotVar: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [enableCarpetPlotTab](enable-carpet-plot-tab.md)(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), var1: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), var2: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plotVar: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
For internal use only | -| [enableGraphTab](enable-graph-tab.md) | public [enableGraphTab](enable-graph-tab.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Enables the Graph tab | -| [enableMainEffectsTab](enable-main-effects-tab.md) | public [enableMainEffectsTab](enable-main-effects-tab.md)()
For internal use only | -| [endRuns](end-runs.md) | public [endRuns](end-runs.md)()
lets the Data Collector know that all runs have completed | -| [exportToCSV](export-to-c-s-v.md) | public [exportToCSV](export-to-c-s-v.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
exports the trade study data to a comma-separated file | -| [fromString](from-string.md) | public [fromString](from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Restores a Data Collector setup from a string generated by "toString" | -| [getDataExplorer](get-data-explorer.md) | public [getDataExplorer](get-data-explorer.md)(): [DataExplorer](../-data-explorer/index.md)
Gets the associated Data Explorer window | -| [getErrorID](get-error-i-d.md) | public [getErrorID](get-error-i-d.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
get the error id for the specified run | -| [getErrorMessage](get-error-message.md) | public [getErrorMessage](get-error-message.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the error message associated with the specified run | -| [getNumFailedRuns](get-num-failed-runs.md) | public [getNumFailedRuns](get-num-failed-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of failed runs | -| [getNumRuns](get-num-runs.md) | public [getNumRuns](get-num-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of runs stored in the Data Collector | -| [getNumVariables](get-num-variables.md) | public [getNumVariables](get-num-variables.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of variables stored in the Data Collector | -| [getValue](get-value.md) | public [getValue](get-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Variant](../-variant/index.md)
public [getValue](get-value.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Variant](../-variant/index.md)
gets the value for a specified variable | -| [getVariableDescription](get-variable-description.md) | public [getVariableDescription](get-variable-description.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [VariableDescription](../-variable-description/index.md)
public [getVariableDescription](get-variable-description.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [VariableDescription](../-variable-description/index.md)
gets a description object for the specified variable | -| [hide](hide.md) | public [hide](hide.md)()
caused the Data Collector to hide | -| [isValid](is-valid.md) | public [isValid](is-valid.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [isValid](is-valid.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks to see if a variable value is valid or not | -| [isVisible](is-visible.md) | public [isVisible](is-visible.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determine if the data collector is visible. | -| [newCustomDesignPoint](new-custom-design-point.md) | public [newCustomDesignPoint](new-custom-design-point.md)(): [CustomDesignPoint](../-custom-design-point/index.md)
For internal use only | -| [newInstance](new-instance.md) | public [newInstance](new-instance.md)(): [DataCollector](index.md)
creates a new DataCollector object (that is connected to the same ModelCenter session) that is not currently attached to any thread. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [save](save.md) | public [save](save.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), displayName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), author: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), saveModel: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
saves the trade study | -| [selectX](select-x.md) | public [selectX](select-x.md)(label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
selects a variable for the X-axis | -| [selectY](select-y.md) | public [selectY](select-y.md)(label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
selects a variable for the Y-axis | -| [setCustomRun](set-custom-run.md) | public [setCustomRun](set-custom-run.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), customDesignPoint: [CustomDesignPoint](../-custom-design-point/index.md))
For internal use only | -| [setNumExpectedRuns](set-num-expected-runs.md) | public [setNumExpectedRuns](set-num-expected-runs.md)(numRuns: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
lets the Data Collector how many runs are expected. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [show](show.md) | public [show](show.md)()
caused the Data Collector to be displayed | -| [startRuns](start-runs.md) | public [startRuns](start-runs.md)()
lets the Data Collector know that it has been setup and runs are beginning | -| [storeCurrentDesignPoint](store-current-design-point.md) | public [storeCurrentDesignPoint](store-current-design-point.md)()
causes the Data Collector to store the current data from ModelCenter | -| [storeCustomDesignPoint](store-custom-design-point.md) | public [storeCustomDesignPoint](store-custom-design-point.md)(customDesignPoint: [CustomDesignPoint](../-custom-design-point/index.md))
For internal use only | -| [toString](to-string.md) | public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the Data Collector setup to a string | +# DataCollector + + +public class [DataCollector](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +This is the wrapper class that handles the native COM calls to a Data Collector. The class is used by Java plug-ins to ModelCenter. + +#### Author + +Woyak, 9-01 + +## Constructors + +| | | +|---|---| +| [DataCollector](-data-collector.md) | constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Connects this Java object to the specified session of ModelCenter | + +## Functions + +| Name | Summary | +|---|---| +| [addCustom](add-custom.md) | public [addCustom](add-custom.md)(eqn: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
adds a custom variable to be displayed in the Data Collector | +| [createEmptyRuns](create-empty-runs.md) | public [createEmptyRuns](create-empty-runs.md)(numEmptyRuns: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
For internal use only | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [enableCarpetPlotTab](enable-carpet-plot-tab.md) | public [enableCarpetPlotTab](enable-carpet-plot-tab.md)(var1: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), var2: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plotVar: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [enableCarpetPlotTab](enable-carpet-plot-tab.md)(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), var1: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), var2: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plotVar: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
For internal use only | +| [enableGraphTab](enable-graph-tab.md) | public [enableGraphTab](enable-graph-tab.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Enables the Graph tab | +| [enableMainEffectsTab](enable-main-effects-tab.md) | public [enableMainEffectsTab](enable-main-effects-tab.md)()
For internal use only | +| [endRuns](end-runs.md) | public [endRuns](end-runs.md)()
lets the Data Collector know that all runs have completed | +| [exportToCSV](export-to-c-s-v.md) | public [exportToCSV](export-to-c-s-v.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
exports the trade study data to a comma-separated file | +| [fromString](from-string.md) | public [fromString](from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Restores a Data Collector setup from a string generated by "toString" | +| [getDataExplorer](get-data-explorer.md) | public [getDataExplorer](get-data-explorer.md)(): [DataExplorer](../-data-explorer/index.md)
Gets the associated Data Explorer window | +| [getErrorID](get-error-i-d.md) | public [getErrorID](get-error-i-d.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
get the error id for the specified run | +| [getErrorMessage](get-error-message.md) | public [getErrorMessage](get-error-message.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the error message associated with the specified run | +| [getNumFailedRuns](get-num-failed-runs.md) | public [getNumFailedRuns](get-num-failed-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of failed runs | +| [getNumRuns](get-num-runs.md) | public [getNumRuns](get-num-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of runs stored in the Data Collector | +| [getNumVariables](get-num-variables.md) | public [getNumVariables](get-num-variables.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of variables stored in the Data Collector | +| [getValue](get-value.md) | public [getValue](get-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Variant](../-variant/index.md)
public [getValue](get-value.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Variant](../-variant/index.md)
gets the value for a specified variable | +| [getVariableDescription](get-variable-description.md) | public [getVariableDescription](get-variable-description.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [VariableDescription](../-variable-description/index.md)
public [getVariableDescription](get-variable-description.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [VariableDescription](../-variable-description/index.md)
gets a description object for the specified variable | +| [hide](hide.md) | public [hide](hide.md)()
caused the Data Collector to hide | +| [isValid](is-valid.md) | public [isValid](is-valid.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [isValid](is-valid.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks to see if a variable value is valid or not | +| [isVisible](is-visible.md) | public [isVisible](is-visible.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determine if the data collector is visible. | +| [newCustomDesignPoint](new-custom-design-point.md) | public [newCustomDesignPoint](new-custom-design-point.md)(): [CustomDesignPoint](../-custom-design-point/index.md)
For internal use only | +| [newInstance](new-instance.md) | public [newInstance](new-instance.md)(): [DataCollector](index.md)
creates a new DataCollector object (that is connected to the same ModelCenter session) that is not currently attached to any thread. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [save](save.md) | public [save](save.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), displayName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), author: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), saveModel: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
saves the trade study | +| [selectX](select-x.md) | public [selectX](select-x.md)(label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
selects a variable for the X-axis | +| [selectY](select-y.md) | public [selectY](select-y.md)(label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
selects a variable for the Y-axis | +| [setCustomRun](set-custom-run.md) | public [setCustomRun](set-custom-run.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), customDesignPoint: [CustomDesignPoint](../-custom-design-point/index.md))
For internal use only | +| [setNumExpectedRuns](set-num-expected-runs.md) | public [setNumExpectedRuns](set-num-expected-runs.md)(numRuns: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
lets the Data Collector how many runs are expected. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [show](show.md) | public [show](show.md)()
caused the Data Collector to be displayed | +| [startRuns](start-runs.md) | public [startRuns](start-runs.md)()
lets the Data Collector know that it has been setup and runs are beginning | +| [storeCurrentDesignPoint](store-current-design-point.md) | public [storeCurrentDesignPoint](store-current-design-point.md)()
causes the Data Collector to store the current data from ModelCenter | +| [storeCustomDesignPoint](store-custom-design-point.md) | public [storeCustomDesignPoint](store-custom-design-point.md)(customDesignPoint: [CustomDesignPoint](../-custom-design-point/index.md))
For internal use only | +| [toString](to-string.md) | public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the Data Collector setup to a string | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/is-valid.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/is-valid.md index e1451a48ef..0e79e1dac6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/is-valid.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/is-valid.md @@ -1,51 +1,49 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[isValid](is-valid.md) - -# isValid - - -public [isValid](is-valid.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -checks to see if a variable value is valid or not - -#### Return - -true or false - -#### Parameters - - - -| | | -|---|---| -| name | the variable to get the value for | -| run | the run to get the value for (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [isValid](is-valid.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -checks to see if a variable value is valid or not - -#### Return - -true or false - -#### Parameters - - - -| | | -|---|---| -| index | the variable to get the value for (0-based index) | -| run | the run to get the value for (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isValid + + +public [isValid](is-valid.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +checks to see if a variable value is valid or not + +#### Return + +true or false + +#### Parameters + + + +| | | +|---|---| +| name | the variable to get the value for | +| run | the run to get the value for (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [isValid](is-valid.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +checks to see if a variable value is valid or not + +#### Return + +true or false + +#### Parameters + + + +| | | +|---|---| +| index | the variable to get the value for (0-based index) | +| run | the run to get the value for (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/is-visible.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/is-visible.md index b72adefdd1..eeff31b3fc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/is-visible.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/is-visible.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[isVisible](is-visible.md) - -# isVisible - - -public [isVisible](is-visible.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Determine if the data collector is visible. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isVisible + + +public [isVisible](is-visible.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Determine if the data collector is visible. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/new-custom-design-point.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/new-custom-design-point.md index 13f494d242..388cb9779c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/new-custom-design-point.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/new-custom-design-point.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[newCustomDesignPoint](new-custom-design-point.md) - -# newCustomDesignPoint - - -public [newCustomDesignPoint](new-custom-design-point.md)(): [CustomDesignPoint](../-custom-design-point/index.md) - -For internal use only +# newCustomDesignPoint + + +public [newCustomDesignPoint](new-custom-design-point.md)(): [CustomDesignPoint](../-custom-design-point/index.md) + +For internal use only diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/new-instance.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/new-instance.md index 198e575068..325becbfc5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/new-instance.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/new-instance.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[newInstance](new-instance.md) - -# newInstance - - -public [newInstance](new-instance.md)(): [DataCollector](index.md) - -creates a new DataCollector object (that is connected to the same ModelCenter session) that is not currently attached to any thread. Use this method if you need to call DataCollector from multiple threads. The spawning thread should call this function for each thread that needs to call DataCollector. The new instance should be passed to the spawned thread and used there. - -#### Return - -a DataCollector instance that is not attached to any thread - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# newInstance + + +public [newInstance](new-instance.md)(): [DataCollector](index.md) + +creates a new DataCollector object (that is connected to the same ModelCenter session) that is not currently attached to any thread. Use this method if you need to call DataCollector from multiple threads. The spawning thread should call this function for each thread that needs to call DataCollector. The new instance should be passed to the spawned thread and used there. + +#### Return + +a DataCollector instance that is not attached to any thread + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/save.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/save.md index 2e990b94ea..bd8eddacfb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/save.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/save.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[save](save.md) - -# save - - -public [save](save.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), displayName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), author: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), saveModel: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -saves the trade study - -#### Parameters - - - -| | | -|---|---| -| fileName | the .pxt file to save to | -| displayName | the name to display in the Project Tree in ModelCenter | -| description | a description of the trade study | -| author | trade study data creator | -| saveModel | if true, include the Model in the trade study file | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# save + + +public [save](save.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), displayName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), author: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), saveModel: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +saves the trade study + +#### Parameters + + + +| | | +|---|---| +| fileName | the .pxt file to save to | +| displayName | the name to display in the Project Tree in ModelCenter | +| description | a description of the trade study | +| author | trade study data creator | +| saveModel | if true, include the Model in the trade study file | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/select-x.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/select-x.md index a88e11d2ff..e6478ba7ee 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/select-x.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/select-x.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[selectX](select-x.md) - -# selectX - - -public [selectX](select-x.md)(label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -selects a variable for the X-axis - -#### Parameters - - - -| | | -|---|---| -| label | the item in the Data Collector to select | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# selectX + + +public [selectX](select-x.md)(label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +selects a variable for the X-axis + +#### Parameters + + + +| | | +|---|---| +| label | the item in the Data Collector to select | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/select-y.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/select-y.md index 2347120b42..db1b2e451d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/select-y.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/select-y.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[selectY](select-y.md) - -# selectY - - -public [selectY](select-y.md)(label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -selects a variable for the Y-axis - -#### Parameters - - - -| | | -|---|---| -| label | the item in the Data Collector to select | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# selectY + + +public [selectY](select-y.md)(label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +selects a variable for the Y-axis + +#### Parameters + + + +| | | +|---|---| +| label | the item in the Data Collector to select | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/set-custom-run.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/set-custom-run.md index 7239a8a9ae..c05a2c0fb9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/set-custom-run.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/set-custom-run.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[setCustomRun](set-custom-run.md) - -# setCustomRun - - -public [setCustomRun](set-custom-run.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), customDesignPoint: [CustomDesignPoint](../-custom-design-point/index.md)) - -For internal use only +# setCustomRun + + +public [setCustomRun](set-custom-run.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), customDesignPoint: [CustomDesignPoint](../-custom-design-point/index.md)) + +For internal use only diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/set-num-expected-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/set-num-expected-runs.md index c60f9a2f27..17fa6103be 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/set-num-expected-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/set-num-expected-runs.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[setNumExpectedRuns](set-num-expected-runs.md) - -# setNumExpectedRuns - - -public [setNumExpectedRuns](set-num-expected-runs.md)(numRuns: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -lets the Data Collector how many runs are expected. If this function is called, a progress meter will be displayed in the Data Collector while the trade study is running. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setNumExpectedRuns + + +public [setNumExpectedRuns](set-num-expected-runs.md)(numRuns: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +lets the Data Collector how many runs are expected. If this function is called, a progress meter will be displayed in the Data Collector while the trade study is running. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/show.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/show.md index 407f99178b..2a231b5ab1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/show.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/show.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[show](show.md) - -# show - - -public [show](show.md)() - -caused the Data Collector to be displayed - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# show + + +public [show](show.md)() + +caused the Data Collector to be displayed + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/start-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/start-runs.md index e74cd7d654..f649f44b3f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/start-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/start-runs.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[startRuns](start-runs.md) - -# startRuns - - -public [startRuns](start-runs.md)() - -lets the Data Collector know that it has been setup and runs are beginning - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# startRuns + + +public [startRuns](start-runs.md)() + +lets the Data Collector know that it has been setup and runs are beginning + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/store-current-design-point.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/store-current-design-point.md index 24551a0032..ef6b08d6bf 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/store-current-design-point.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/store-current-design-point.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[storeCurrentDesignPoint](store-current-design-point.md) - -# storeCurrentDesignPoint - - -public [storeCurrentDesignPoint](store-current-design-point.md)() - -causes the Data Collector to store the current data from ModelCenter - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# storeCurrentDesignPoint + + +public [storeCurrentDesignPoint](store-current-design-point.md)() + +causes the Data Collector to store the current data from ModelCenter + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/store-custom-design-point.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/store-custom-design-point.md index 3cf8f53da4..1795afa86e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/store-custom-design-point.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/store-custom-design-point.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[storeCustomDesignPoint](store-custom-design-point.md) - -# storeCustomDesignPoint - - -public [storeCustomDesignPoint](store-custom-design-point.md)(customDesignPoint: [CustomDesignPoint](../-custom-design-point/index.md)) - -For internal use only +# storeCustomDesignPoint + + +public [storeCustomDesignPoint](store-custom-design-point.md)(customDesignPoint: [CustomDesignPoint](../-custom-design-point/index.md)) + +For internal use only diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/to-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/to-string.md index 7fe9c311f4..d63413e552 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/to-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-collector/to-string.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataCollector](index.md)/[toString](to-string.md) - -# toString - - -public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Converts the Data Collector setup to a string - -#### Return - -setup string +# toString + + +public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Converts the Data Collector setup to a string + +#### Return + +setup string diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/-p-h-x-d-e-keepalive/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/-p-h-x-d-e-keepalive/index.md index c6b67c32cf..9c58cb258a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/-p-h-x-d-e-keepalive/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/-p-h-x-d-e-keepalive/index.md @@ -1,15 +1,13 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[DataExplorer](../index.md)/[PHXDEKeepalive](index.md) - -# PHXDEKeepalive - - -open inner class [PHXDEKeepalive](index.md) : [PHXCOMObject](../../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -## Functions - -| Name | Summary | -|---|---| -| [disableGC](../../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [release](../../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setReferenceDebugMode](../../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +# PHXDEKeepalive + + +open inner class [PHXDEKeepalive](index.md) : [PHXCOMObject](../../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +## Functions + +| Name | Summary | +|---|---| +| [disableGC](../../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [release](../../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setReferenceDebugMode](../../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/add-page.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/add-page.md index 0172a8cb24..9173a62df6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/add-page.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/add-page.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[addPage](add-page.md) - -# addPage - - -public [addPage](add-page.md)(type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), insertBefore: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), setupString: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Adds a page in the DataExplorer --used to be IDispatch in COM - -#### Parameters - - - -| | | -|---|---| -| type | the type of item to add to the DataExplorer | -| insertBefore | the item in which to add the new item after (0-based index) | -| setupString | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addPage + + +public [addPage](add-page.md)(type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), insertBefore: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), setupString: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Adds a page in the DataExplorer --used to be IDispatch in COM + +#### Parameters + + + +| | | +|---|---| +| type | the type of item to add to the DataExplorer | +| insertBefore | the item in which to add the new item after (0-based index) | +| setupString | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/add-runs-to-comparison-list.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/add-runs-to-comparison-list.md index 9bd898222a..9da7a4d890 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/add-runs-to-comparison-list.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/add-runs-to-comparison-list.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[addRunsToComparisonList](add-runs-to-comparison-list.md) - -# addRunsToComparisonList - - -public [addRunsToComparisonList](add-runs-to-comparison-list.md)(runIDs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)>) - -add a list of runs to the design comparison list - -#### Parameters - - - -| | | -|---|---| -| runIDs | ID of runs (zero based) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addRunsToComparisonList + + +public [addRunsToComparisonList](add-runs-to-comparison-list.md)(runIDs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)>) + +add a list of runs to the design comparison list + +#### Parameters + + + +| | | +|---|---| +| runIDs | ID of runs (zero based) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/add-to-comparison-list.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/add-to-comparison-list.md index fdfb28be46..417153ecc9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/add-to-comparison-list.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/add-to-comparison-list.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[addToComparisonList](add-to-comparison-list.md) - -# addToComparisonList - - -public [addToComparisonList](add-to-comparison-list.md)(runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -add a run to the design comparison list - -#### Parameters - - - -| | | -|---|---| -| runID | run ID (zero based) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addToComparisonList + + +public [addToComparisonList](add-to-comparison-list.md)(runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +add a run to the design comparison list + +#### Parameters + + + +| | | +|---|---| +| runID | run ID (zero based) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/from-x-m-l-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/from-x-m-l-file.md index 9f4f0d412c..c6616240d5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/from-x-m-l-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/from-x-m-l-file.md @@ -1,42 +1,40 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[fromXMLFile](from-x-m-l-file.md) - -# fromXMLFile - - -public [fromXMLFile](from-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -from XML file - -#### Parameters - - - -| | | -|---|---| -| fileName | the name of the XML file | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [fromXMLFile](from-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), root: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -from XML file - -#### Parameters - - - -| | | -|---|---| -| fileName | the name of the XML file | -| root | (was [optional]VARIANT) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# fromXMLFile + + +public [fromXMLFile](from-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +from XML file + +#### Parameters + + + +| | | +|---|---| +| fileName | the name of the XML file | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [fromXMLFile](from-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), root: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +from XML file + +#### Parameters + + + +| | | +|---|---| +| fileName | the name of the XML file | +| root | (was [optional]VARIANT) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/from-x-m-l.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/from-x-m-l.md index 04e5099e0b..260bfb3f58 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/from-x-m-l.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/from-x-m-l.md @@ -1,42 +1,40 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[fromXML](from-x-m-l.md) - -# fromXML - - -public [fromXML](from-x-m-l.md)(xml: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -from XML - -#### Parameters - - - -| | | -|---|---| -| xml | string | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [fromXML](from-x-m-l.md)(xml: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), root: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -from XML - -#### Parameters - - - -| | | -|---|---| -| xml | string | -| root | (was [optional] Variant} | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# fromXML + + +public [fromXML](from-x-m-l.md)(xml: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +from XML + +#### Parameters + + + +| | | +|---|---| +| xml | string | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [fromXML](from-x-m-l.md)(xml: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), root: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +from XML + +#### Parameters + + + +| | | +|---|---| +| xml | string | +| root | (was [optional] Variant} | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-associated-model-file-u-u-i-d.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-associated-model-file-u-u-i-d.md index 2b23669a6b..7297cb5afb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-associated-model-file-u-u-i-d.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-associated-model-file-u-u-i-d.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[getAssociatedModelFileUUID](get-associated-model-file-u-u-i-d.md) - -# getAssociatedModelFileUUID - - -public [getAssociatedModelFileUUID](get-associated-model-file-u-u-i-d.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the AssociatedModelFileUUID - -#### Return - -String - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getAssociatedModelFileUUID + + +public [getAssociatedModelFileUUID](get-associated-model-file-u-u-i-d.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the AssociatedModelFileUUID + +#### Return + +String + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-associated-model-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-associated-model-file.md index 090b5ae36d..bcaa68454e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-associated-model-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-associated-model-file.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[getAssociatedModelFile](get-associated-model-file.md) - -# getAssociatedModelFile - - -public [getAssociatedModelFile](get-associated-model-file.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the AssociatedModelFile - -#### Return - -String - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getAssociatedModelFile + + +public [getAssociatedModelFile](get-associated-model-file.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the AssociatedModelFile + +#### Return + +String + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-author.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-author.md index 1fd0a58148..3a903d233a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-author.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-author.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[getAuthor](get-author.md) - -# getAuthor - - -public [getAuthor](get-author.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -returns the author - -#### Return - -String - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getAuthor + + +public [getAuthor](get-author.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +returns the author + +#### Return + +String + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-creation-date.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-creation-date.md index 5b6d552742..353aa20e43 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-creation-date.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-creation-date.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[getCreationDate](get-creation-date.md) - -# getCreationDate - - -public [getCreationDate](get-creation-date.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -returns the creation date - -#### Return - -String - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getCreationDate + + +public [getCreationDate](get-creation-date.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +returns the creation date + +#### Return + +String + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-da-x-format.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-da-x-format.md index b9ad3fa36a..c841cc61cd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-da-x-format.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-da-x-format.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[getDaXFormat](get-da-x-format.md) - -# getDaXFormat - - -public [getDaXFormat](get-da-x-format.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -#### Deprecated - -After ModelCenter 11.2.1, as the StandaloneDaX has been removed - -#### Return - -false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDaXFormat + + +public [getDaXFormat](get-da-x-format.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +#### Deprecated + +After ModelCenter 11.2.1, as the StandaloneDaX has been removed + +#### Return + +false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-da-x-type.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-da-x-type.md index 22eb07c2bc..07e5bbc148 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-da-x-type.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-da-x-type.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[getDaXType](get-da-x-type.md) - -# getDaXType - - -public [getDaXType](get-da-x-type.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -check whether the type of data explorer (free/non-free) - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDaXType + + +public [getDaXType](get-da-x-type.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +check whether the type of data explorer (free/non-free) + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-data-history.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-data-history.md index e93f2f9e2a..247f3c1447 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-data-history.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-data-history.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[getDataHistory](get-data-history.md) - -# getDataHistory - - -public [getDataHistory](get-data-history.md)(): [DataHistory](../-data-history/index.md) - -gets the DataHistory --was IDispatch in COM - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDataHistory + + +public [getDataHistory](get-data-history.md)(): [DataHistory](../-data-history/index.md) + +gets the DataHistory --was IDispatch in COM + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-description.md index fd7029bba3..806afbf49d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-description.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[getDescription](get-description.md) - -# getDescription - - -public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the description - -#### Return - -String - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDescription + + +public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the description + +#### Return + +String + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-display-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-display-name.md index c1c10980a8..d6828837eb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-display-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-display-name.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[getDisplayName](get-display-name.md) - -# getDisplayName - - -public [getDisplayName](get-display-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the Displayname - -#### Return - -String - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDisplayName + + +public [getDisplayName](get-display-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the Displayname + +#### Return + +String + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-file-uri.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-file-uri.md index 474b12e882..ca4668dabd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-file-uri.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-file-uri.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[getFileUri](get-file-uri.md) - -# getFileUri - - -public [getFileUri](get-file-uri.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Get the File URI loaded into this DataExplorer. - -#### Return - -the URI of the file loaded in this DataExplorer, empty string if no file is currently loaded. - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if getting the URI fails | +# getFileUri + + +public [getFileUri](get-file-uri.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Get the File URI loaded into this DataExplorer. + +#### Return + +the URI of the file loaded in this DataExplorer, empty string if no file is currently loaded. + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if getting the URI fails | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-h-w-n-d.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-h-w-n-d.md index 5575bfad13..1012e46d86 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-h-w-n-d.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-h-w-n-d.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[getHWND](get-h-w-n-d.md) - -# getHWND - - -public [getHWND](get-h-w-n-d.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) +# getHWND + + +public [getHWND](get-h-w-n-d.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-keepalive.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-keepalive.md index 33d9545aeb..c510a4599f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-keepalive.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-keepalive.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[getKeepalive](get-keepalive.md) - -# getKeepalive - - -public [getKeepalive](get-keepalive.md)(): [DataExplorer.PHXDEKeepalive](-p-h-x-d-e-keepalive/index.md) - -Function for internal use only +# getKeepalive + + +public [getKeepalive](get-keepalive.md)(): [DataExplorer.PHXDEKeepalive](-p-h-x-d-e-keepalive/index.md) + +Function for internal use only diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-model-center.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-model-center.md index 2f253c5961..3fe837eaee 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-model-center.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-model-center.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[getModelCenter](get-model-center.md) - -# getModelCenter - - -public [getModelCenter](get-model-center.md)(): [ModelCenter](../-model-center/index.md) - -gets ModelCenter --was IDispatch in COM - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getModelCenter + + +public [getModelCenter](get-model-center.md)(): [ModelCenter](../-model-center/index.md) + +gets ModelCenter --was IDispatch in COM + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-num-pages.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-num-pages.md index 1340299a51..a98e380827 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-num-pages.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-num-pages.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[getNumPages](get-num-pages.md) - -# getNumPages - - -public [getNumPages](get-num-pages.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -returns the number of pages - -#### Return - -long - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumPages + + +public [getNumPages](get-num-pages.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +returns the number of pages + +#### Return + +long + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-page-type.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-page-type.md index 4d71a3cb46..e5d9d9ce8b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-page-type.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-page-type.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[getPageType](get-page-type.md) - -# getPageType - - -public [getPageType](get-page-type.md)(page: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the page type - -#### Return - -the page type - -#### Parameters - - - -| | | -|---|---| -| page | the index of the page (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getPageType + + +public [getPageType](get-page-type.md)(page: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the page type + +#### Return + +the page type + +#### Parameters + + + +| | | +|---|---| +| page | the index of the page (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-selected-page.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-selected-page.md index 7dc5f3566c..bbbb3e42a8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-selected-page.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-selected-page.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[getSelectedPage](get-selected-page.md) - -# getSelectedPage - - -public [getSelectedPage](get-selected-page.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the selected page from the DataExplorer - -#### Return - -long - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getSelectedPage + + +public [getSelectedPage](get-selected-page.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the selected page from the DataExplorer + +#### Return + +long + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-trade-study-setup.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-trade-study-setup.md index b65ea91130..4f05529bb6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-trade-study-setup.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-trade-study-setup.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[getTradeStudySetup](get-trade-study-setup.md) - -# getTradeStudySetup - - -public [getTradeStudySetup](get-trade-study-setup.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the TradeStudySetup - -#### Return - -String - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getTradeStudySetup + + +public [getTradeStudySetup](get-trade-study-setup.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the TradeStudySetup + +#### Return + +String + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-trade-study-type.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-trade-study-type.md index 87356bfada..9e6c7a90d6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-trade-study-type.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-trade-study-type.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[getTradeStudyType](get-trade-study-type.md) - -# getTradeStudyType - - -public [getTradeStudyType](get-trade-study-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the TradeStudyType - -#### Return - -String - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getTradeStudyType + + +public [getTradeStudyType](get-trade-study-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the TradeStudyType + +#### Return + +String + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/hide.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/hide.md index 68fe20b32f..b40450fdb1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/hide.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/hide.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[hide](hide.md) - -# hide - - -public [hide](hide.md)() +# hide + + +public [hide](hide.md)() diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/ignore-default-plot-setup.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/ignore-default-plot-setup.md index 1b54ddba01..41127fb37c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/ignore-default-plot-setup.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/ignore-default-plot-setup.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[ignoreDefaultPlotSetup](ignore-default-plot-setup.md) - -# ignoreDefaultPlotSetup - - -public [ignoreDefaultPlotSetup](ignore-default-plot-setup.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -check whether the default plot setup should be ignored - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# ignoreDefaultPlotSetup + + +public [ignoreDefaultPlotSetup](ignore-default-plot-setup.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +check whether the default plot setup should be ignored + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/index.md index 118fb7d1a6..76727d1a37 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/index.md @@ -1,84 +1,82 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md) - -# DataExplorer - - -public class [DataExplorer](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -This is the wrapper class that handles the native COM calls to a Data Explorer. The class is used by Java plug-ins to ModelCenter. - -## Types - -| Name | Summary | -|---|---| -| [PHXDEKeepalive](-p-h-x-d-e-keepalive/index.md) | open inner class [PHXDEKeepalive](-p-h-x-d-e-keepalive/index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) | - -## Functions - -| Name | Summary | -|---|---| -| [addPage](add-page.md) | public [addPage](add-page.md)(type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), insertBefore: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), setupString: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Adds a page in the DataExplorer --used to be IDispatch in COM | -| [addRunsToComparisonList](add-runs-to-comparison-list.md) | public [addRunsToComparisonList](add-runs-to-comparison-list.md)(runIDs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)>)
add a list of runs to the design comparison list | -| [addToComparisonList](add-to-comparison-list.md) | public [addToComparisonList](add-to-comparison-list.md)(runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
add a run to the design comparison list | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromXML](from-x-m-l.md) | public [fromXML](from-x-m-l.md)(xml: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [fromXML](from-x-m-l.md)(xml: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), root: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
from XML | -| [fromXMLFile](from-x-m-l-file.md) | public [fromXMLFile](from-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [fromXMLFile](from-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), root: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
from XML file | -| [getAssociatedModelFile](get-associated-model-file.md) | public [getAssociatedModelFile](get-associated-model-file.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the AssociatedModelFile | -| [getAssociatedModelFileUUID](get-associated-model-file-u-u-i-d.md) | public [getAssociatedModelFileUUID](get-associated-model-file-u-u-i-d.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the AssociatedModelFileUUID | -| [getAuthor](get-author.md) | public [getAuthor](get-author.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
returns the author | -| [getCreationDate](get-creation-date.md) | public [getCreationDate](get-creation-date.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
returns the creation date | -| [getDataHistory](get-data-history.md) | public [getDataHistory](get-data-history.md)(): [DataHistory](../-data-history/index.md)
gets the DataHistory --was IDispatch in COM | -| [getDaXFormat](get-da-x-format.md) | public [getDaXFormat](get-da-x-format.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | -| [getDaXType](get-da-x-type.md) | public [getDaXType](get-da-x-type.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
check whether the type of data explorer (free/non-free) | -| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description | -| [getDisplayName](get-display-name.md) | public [getDisplayName](get-display-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the Displayname | -| [getFileUri](get-file-uri.md) | public [getFileUri](get-file-uri.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the File URI loaded into this DataExplorer. | -| [getHWND](get-h-w-n-d.md) | public [getHWND](get-h-w-n-d.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | -| [getKeepalive](get-keepalive.md) | public [getKeepalive](get-keepalive.md)(): [DataExplorer.PHXDEKeepalive](-p-h-x-d-e-keepalive/index.md)
Function for internal use only | -| [getModelCenter](get-model-center.md) | public [getModelCenter](get-model-center.md)(): [ModelCenter](../-model-center/index.md)
gets ModelCenter --was IDispatch in COM | -| [getNumPages](get-num-pages.md) | public [getNumPages](get-num-pages.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
returns the number of pages | -| [getPageType](get-page-type.md) | public [getPageType](get-page-type.md)(page: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the page type | -| [getSelectedPage](get-selected-page.md) | public [getSelectedPage](get-selected-page.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the selected page from the DataExplorer | -| [getTradeStudySetup](get-trade-study-setup.md) | public [getTradeStudySetup](get-trade-study-setup.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the TradeStudySetup | -| [getTradeStudyType](get-trade-study-type.md) | public [getTradeStudyType](get-trade-study-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the TradeStudyType | -| [hide](hide.md) | public [hide](hide.md)() | -| [ignoreDefaultPlotSetup](ignore-default-plot-setup.md) | public [ignoreDefaultPlotSetup](ignore-default-plot-setup.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
check whether the default plot setup should be ignored | -| [invokeInsertPageGUI](invoke-insert-page-g-u-i.md) | public [invokeInsertPageGUI](invoke-insert-page-g-u-i.md)()
Invokes the act of inserting a page in the GUI | -| [invokeMenuItem](invoke-menu-item.md) | public [invokeMenuItem](invoke-menu-item.md)(item: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
invokes a given menu item | -| [isMenuItemChecked](is-menu-item-checked.md) | public [isMenuItemChecked](is-menu-item-checked.md)(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
return the check status of Data Explorer menu item (such as tooltip enabled) | -| [isMenuItemEnabled](is-menu-item-enabled.md) | public [isMenuItemEnabled](is-menu-item-enabled.md)(item: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
check to see if the menu item is enabled (t/f) | -| [isVisible](is-visible.md) | public [isVisible](is-visible.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | -| [movePage](move-page.md) | public [movePage](move-page.md)(page: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), insertBefore: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
moves a page in the DataExplorer | -| [multiDelete](multi-delete.md) | public [multiDelete](multi-delete.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
string of index for deleting pages | -| [multiPageCopy](multi-page-copy.md) | public [multiPageCopy](multi-page-copy.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
string of index for copying pages | -| [multiPageCut](multi-page-cut.md) | public [multiPageCut](multi-page-cut.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
string of index for cutting pages | -| [newInstance](new-instance.md) | public [newInstance](new-instance.md)(): [DataExplorer](index.md)
creates a new DataExplorer object | -| [pageCopy](page-copy.md) | public [pageCopy](page-copy.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
copies a page in the DataExplorer | -| [pageCut](page-cut.md) | public [pageCut](page-cut.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
cuts a page from the DataExplorer | -| [pagePaste](page-paste.md) | public [pagePaste](page-paste.md)()
Pastes a page from the DataExplorer | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [removeFromComparisonList](remove-from-comparison-list.md) | public [removeFromComparisonList](remove-from-comparison-list.md)(runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
remove a run from the design comparison list | -| [removePage](remove-page.md) | public [removePage](remove-page.md)(page: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
remove a page from the DataExplorer | -| [selectPage](select-page.md) | public [selectPage](select-page.md)(page: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
selects a certain page in the DataExplorer | -| [setAssociatedModelFile](set-associated-model-file.md) | public [setAssociatedModelFile](set-associated-model-file.md)(filename: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the AssociatedModelFile | -| [setAssociatedModelFileUUID](set-associated-model-file-u-u-i-d.md) | public [setAssociatedModelFileUUID](set-associated-model-file-u-u-i-d.md)(fileUUID: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the AssociatedModelFileUUID | -| [setAuthor](set-author.md) | public [setAuthor](set-author.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the author | -| [setCreationDate](set-creation-date.md) | public [setCreationDate](set-creation-date.md)(creationDate: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the creation date | -| [setDescription](set-description.md) | public [setDescription](set-description.md)(desc: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description | -| [setDisplayName](set-display-name.md) | public [setDisplayName](set-display-name.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Displayname | -| [setFileUri](set-file-uri.md) | public [setFileUri](set-file-uri.md)(fileUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Set the File URI loaded in this DataExplorer. | -| [setGeomViewerRunID](set-geom-viewer-run-i-d.md) | public [setGeomViewerRunID](set-geom-viewer-run-i-d.md)(viewerID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
set runID for the design viewer. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setTradeStudySetup](set-trade-study-setup.md) | public [setTradeStudySetup](set-trade-study-setup.md)(tsSetup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the TradeStudySetup | -| [setTradeStudyType](set-trade-study-type.md) | public [setTradeStudyType](set-trade-study-type.md)(tsType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the TradeStudyType | -| [setupPlotsPost](setup-plots-post.md) | public [setupPlotsPost](setup-plots-post.md)()
add plots when the trade study finished. | -| [setupPlotsPre](setup-plots-pre.md) | public [setupPlotsPre](setup-plots-pre.md)()
add plots when Data Collector is created. | -| [show](show.md) | public [show](show.md)() | -| [showGeomTooltip](show-geom-tooltip.md) | public [showGeomTooltip](show-geom-tooltip.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
add plots when the trade study finished. | -| [showGeomViewer](show-geom-viewer.md) | public [showGeomViewer](show-geom-viewer.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
add plots when the trade study finished. | -| [toXML](to-x-m-l.md) | public [toXML](to-x-m-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [toXML](to-x-m-l.md)(includeRunData: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
to XML | -| [toXMLFile](to-x-m-l-file.md) | public [toXMLFile](to-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [toXMLFile](to-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), includeRunData: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
turns the given file into an XML file | -| [updateComparisonViewHint](update-comparison-view-hint.md) | public [updateComparisonViewHint](update-comparison-view-hint.md)(restore: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
trigger updating the comparison view | -| [updateGeomViewerHint](update-geom-viewer-hint.md) | public [updateGeomViewerHint](update-geom-viewer-hint.md)(viewerID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
trigger updating design viewers. | -| [updateThumbHint](update-thumb-hint.md) | public [updateThumbHint](update-thumb-hint.md)(item: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
updates a thumb hint | +# DataExplorer + + +public class [DataExplorer](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +This is the wrapper class that handles the native COM calls to a Data Explorer. The class is used by Java plug-ins to ModelCenter. + +## Types + +| Name | Summary | +|---|---| +| [PHXDEKeepalive](-p-h-x-d-e-keepalive/index.md) | open inner class [PHXDEKeepalive](-p-h-x-d-e-keepalive/index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [addPage](add-page.md) | public [addPage](add-page.md)(type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), insertBefore: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), setupString: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Adds a page in the DataExplorer --used to be IDispatch in COM | +| [addRunsToComparisonList](add-runs-to-comparison-list.md) | public [addRunsToComparisonList](add-runs-to-comparison-list.md)(runIDs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)>)
add a list of runs to the design comparison list | +| [addToComparisonList](add-to-comparison-list.md) | public [addToComparisonList](add-to-comparison-list.md)(runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
add a run to the design comparison list | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromXML](from-x-m-l.md) | public [fromXML](from-x-m-l.md)(xml: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [fromXML](from-x-m-l.md)(xml: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), root: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
from XML | +| [fromXMLFile](from-x-m-l-file.md) | public [fromXMLFile](from-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [fromXMLFile](from-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), root: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
from XML file | +| [getAssociatedModelFile](get-associated-model-file.md) | public [getAssociatedModelFile](get-associated-model-file.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the AssociatedModelFile | +| [getAssociatedModelFileUUID](get-associated-model-file-u-u-i-d.md) | public [getAssociatedModelFileUUID](get-associated-model-file-u-u-i-d.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the AssociatedModelFileUUID | +| [getAuthor](get-author.md) | public [getAuthor](get-author.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
returns the author | +| [getCreationDate](get-creation-date.md) | public [getCreationDate](get-creation-date.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
returns the creation date | +| [getDataHistory](get-data-history.md) | public [getDataHistory](get-data-history.md)(): [DataHistory](../-data-history/index.md)
gets the DataHistory --was IDispatch in COM | +| [getDaXFormat](get-da-x-format.md) | public [getDaXFormat](get-da-x-format.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [getDaXType](get-da-x-type.md) | public [getDaXType](get-da-x-type.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
check whether the type of data explorer (free/non-free) | +| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description | +| [getDisplayName](get-display-name.md) | public [getDisplayName](get-display-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the Displayname | +| [getFileUri](get-file-uri.md) | public [getFileUri](get-file-uri.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the File URI loaded into this DataExplorer. | +| [getHWND](get-h-w-n-d.md) | public [getHWND](get-h-w-n-d.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | +| [getKeepalive](get-keepalive.md) | public [getKeepalive](get-keepalive.md)(): [DataExplorer.PHXDEKeepalive](-p-h-x-d-e-keepalive/index.md)
Function for internal use only | +| [getModelCenter](get-model-center.md) | public [getModelCenter](get-model-center.md)(): [ModelCenter](../-model-center/index.md)
gets ModelCenter --was IDispatch in COM | +| [getNumPages](get-num-pages.md) | public [getNumPages](get-num-pages.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
returns the number of pages | +| [getPageType](get-page-type.md) | public [getPageType](get-page-type.md)(page: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the page type | +| [getSelectedPage](get-selected-page.md) | public [getSelectedPage](get-selected-page.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the selected page from the DataExplorer | +| [getTradeStudySetup](get-trade-study-setup.md) | public [getTradeStudySetup](get-trade-study-setup.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the TradeStudySetup | +| [getTradeStudyType](get-trade-study-type.md) | public [getTradeStudyType](get-trade-study-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the TradeStudyType | +| [hide](hide.md) | public [hide](hide.md)() | +| [ignoreDefaultPlotSetup](ignore-default-plot-setup.md) | public [ignoreDefaultPlotSetup](ignore-default-plot-setup.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
check whether the default plot setup should be ignored | +| [invokeInsertPageGUI](invoke-insert-page-g-u-i.md) | public [invokeInsertPageGUI](invoke-insert-page-g-u-i.md)()
Invokes the act of inserting a page in the GUI | +| [invokeMenuItem](invoke-menu-item.md) | public [invokeMenuItem](invoke-menu-item.md)(item: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
invokes a given menu item | +| [isMenuItemChecked](is-menu-item-checked.md) | public [isMenuItemChecked](is-menu-item-checked.md)(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
return the check status of Data Explorer menu item (such as tooltip enabled) | +| [isMenuItemEnabled](is-menu-item-enabled.md) | public [isMenuItemEnabled](is-menu-item-enabled.md)(item: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
check to see if the menu item is enabled (t/f) | +| [isVisible](is-visible.md) | public [isVisible](is-visible.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [movePage](move-page.md) | public [movePage](move-page.md)(page: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), insertBefore: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
moves a page in the DataExplorer | +| [multiDelete](multi-delete.md) | public [multiDelete](multi-delete.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
string of index for deleting pages | +| [multiPageCopy](multi-page-copy.md) | public [multiPageCopy](multi-page-copy.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
string of index for copying pages | +| [multiPageCut](multi-page-cut.md) | public [multiPageCut](multi-page-cut.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
string of index for cutting pages | +| [newInstance](new-instance.md) | public [newInstance](new-instance.md)(): [DataExplorer](index.md)
creates a new DataExplorer object | +| [pageCopy](page-copy.md) | public [pageCopy](page-copy.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
copies a page in the DataExplorer | +| [pageCut](page-cut.md) | public [pageCut](page-cut.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
cuts a page from the DataExplorer | +| [pagePaste](page-paste.md) | public [pagePaste](page-paste.md)()
Pastes a page from the DataExplorer | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [removeFromComparisonList](remove-from-comparison-list.md) | public [removeFromComparisonList](remove-from-comparison-list.md)(runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
remove a run from the design comparison list | +| [removePage](remove-page.md) | public [removePage](remove-page.md)(page: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
remove a page from the DataExplorer | +| [selectPage](select-page.md) | public [selectPage](select-page.md)(page: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
selects a certain page in the DataExplorer | +| [setAssociatedModelFile](set-associated-model-file.md) | public [setAssociatedModelFile](set-associated-model-file.md)(filename: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the AssociatedModelFile | +| [setAssociatedModelFileUUID](set-associated-model-file-u-u-i-d.md) | public [setAssociatedModelFileUUID](set-associated-model-file-u-u-i-d.md)(fileUUID: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the AssociatedModelFileUUID | +| [setAuthor](set-author.md) | public [setAuthor](set-author.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the author | +| [setCreationDate](set-creation-date.md) | public [setCreationDate](set-creation-date.md)(creationDate: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the creation date | +| [setDescription](set-description.md) | public [setDescription](set-description.md)(desc: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description | +| [setDisplayName](set-display-name.md) | public [setDisplayName](set-display-name.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Displayname | +| [setFileUri](set-file-uri.md) | public [setFileUri](set-file-uri.md)(fileUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Set the File URI loaded in this DataExplorer. | +| [setGeomViewerRunID](set-geom-viewer-run-i-d.md) | public [setGeomViewerRunID](set-geom-viewer-run-i-d.md)(viewerID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
set runID for the design viewer. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setTradeStudySetup](set-trade-study-setup.md) | public [setTradeStudySetup](set-trade-study-setup.md)(tsSetup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the TradeStudySetup | +| [setTradeStudyType](set-trade-study-type.md) | public [setTradeStudyType](set-trade-study-type.md)(tsType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the TradeStudyType | +| [setupPlotsPost](setup-plots-post.md) | public [setupPlotsPost](setup-plots-post.md)()
add plots when the trade study finished. | +| [setupPlotsPre](setup-plots-pre.md) | public [setupPlotsPre](setup-plots-pre.md)()
add plots when Data Collector is created. | +| [show](show.md) | public [show](show.md)() | +| [showGeomTooltip](show-geom-tooltip.md) | public [showGeomTooltip](show-geom-tooltip.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
add plots when the trade study finished. | +| [showGeomViewer](show-geom-viewer.md) | public [showGeomViewer](show-geom-viewer.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
add plots when the trade study finished. | +| [toXML](to-x-m-l.md) | public [toXML](to-x-m-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [toXML](to-x-m-l.md)(includeRunData: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
to XML | +| [toXMLFile](to-x-m-l-file.md) | public [toXMLFile](to-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [toXMLFile](to-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), includeRunData: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
turns the given file into an XML file | +| [updateComparisonViewHint](update-comparison-view-hint.md) | public [updateComparisonViewHint](update-comparison-view-hint.md)(restore: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
trigger updating the comparison view | +| [updateGeomViewerHint](update-geom-viewer-hint.md) | public [updateGeomViewerHint](update-geom-viewer-hint.md)(viewerID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
trigger updating design viewers. | +| [updateThumbHint](update-thumb-hint.md) | public [updateThumbHint](update-thumb-hint.md)(item: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
updates a thumb hint | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/invoke-insert-page-g-u-i.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/invoke-insert-page-g-u-i.md index 7b785f5a9e..741adda177 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/invoke-insert-page-g-u-i.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/invoke-insert-page-g-u-i.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[invokeInsertPageGUI](invoke-insert-page-g-u-i.md) - -# invokeInsertPageGUI - - -public [invokeInsertPageGUI](invoke-insert-page-g-u-i.md)() - -Invokes the act of inserting a page in the GUI - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# invokeInsertPageGUI + + +public [invokeInsertPageGUI](invoke-insert-page-g-u-i.md)() + +Invokes the act of inserting a page in the GUI + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/invoke-menu-item.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/invoke-menu-item.md index d8359fd6fe..518b41e27b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/invoke-menu-item.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/invoke-menu-item.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[invokeMenuItem](invoke-menu-item.md) - -# invokeMenuItem - - -public [invokeMenuItem](invoke-menu-item.md)(item: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -invokes a given menu item - -#### Parameters - - - -| | | -|---|---| -| item | item to be invoked (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# invokeMenuItem + + +public [invokeMenuItem](invoke-menu-item.md)(item: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +invokes a given menu item + +#### Parameters + + + +| | | +|---|---| +| item | item to be invoked (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/is-menu-item-checked.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/is-menu-item-checked.md index eb5e87acaa..a8b6e1e7eb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/is-menu-item-checked.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/is-menu-item-checked.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[isMenuItemChecked](is-menu-item-checked.md) - -# isMenuItemChecked - - -public [isMenuItemChecked](is-menu-item-checked.md)(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -return the check status of Data Explorer menu item (such as tooltip enabled) - -#### Return - -true if the menu item is selected. false otherwise - -#### Parameters - - - -| | | -|---|---| -| id | menu item ID | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isMenuItemChecked + + +public [isMenuItemChecked](is-menu-item-checked.md)(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +return the check status of Data Explorer menu item (such as tooltip enabled) + +#### Return + +true if the menu item is selected. false otherwise + +#### Parameters + + + +| | | +|---|---| +| id | menu item ID | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/is-menu-item-enabled.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/is-menu-item-enabled.md index 3b01b7a3e1..2cf25fc185 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/is-menu-item-enabled.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/is-menu-item-enabled.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[isMenuItemEnabled](is-menu-item-enabled.md) - -# isMenuItemEnabled - - -public [isMenuItemEnabled](is-menu-item-enabled.md)(item: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -check to see if the menu item is enabled (t/f) - -#### Return - -true or false - -#### Parameters - - - -| | | -|---|---| -| item | the id of the menu item (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isMenuItemEnabled + + +public [isMenuItemEnabled](is-menu-item-enabled.md)(item: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +check to see if the menu item is enabled (t/f) + +#### Return + +true or false + +#### Parameters + + + +| | | +|---|---| +| item | the id of the menu item (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/is-visible.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/is-visible.md index 1c7b03349a..28df9d5767 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/is-visible.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/is-visible.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[isVisible](is-visible.md) - -# isVisible - - -public [isVisible](is-visible.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) +# isVisible + + +public [isVisible](is-visible.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/move-page.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/move-page.md index 5783c05856..1bec5c1722 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/move-page.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/move-page.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[movePage](move-page.md) - -# movePage - - -public [movePage](move-page.md)(page: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), insertBefore: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -moves a page in the DataExplorer - -#### Parameters - - - -| | | -|---|---| -| page | the item in the DataExplorer to move (0-based index) | -| insertBefore | the item in which to move the page before (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# movePage + + +public [movePage](move-page.md)(page: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), insertBefore: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +moves a page in the DataExplorer + +#### Parameters + + + +| | | +|---|---| +| page | the item in the DataExplorer to move (0-based index) | +| insertBefore | the item in which to move the page before (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/multi-delete.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/multi-delete.md index 1ab4be4d58..5cf54c9fb6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/multi-delete.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/multi-delete.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[multiDelete](multi-delete.md) - -# multiDelete - - -public [multiDelete](multi-delete.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -string of index for deleting pages - -#### Parameters - - - -| | | -|---|---| -| index | index of thumbnails (zero based) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# multiDelete + + +public [multiDelete](multi-delete.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +string of index for deleting pages + +#### Parameters + + + +| | | +|---|---| +| index | index of thumbnails (zero based) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/multi-page-copy.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/multi-page-copy.md index 59efaaeb60..28c1169322 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/multi-page-copy.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/multi-page-copy.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[multiPageCopy](multi-page-copy.md) - -# multiPageCopy - - -public [multiPageCopy](multi-page-copy.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -string of index for copying pages - -#### Parameters - - - -| | | -|---|---| -| index | index of thumbnails (zero based) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# multiPageCopy + + +public [multiPageCopy](multi-page-copy.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +string of index for copying pages + +#### Parameters + + + +| | | +|---|---| +| index | index of thumbnails (zero based) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/multi-page-cut.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/multi-page-cut.md index 6e31ba38a7..7ffad96d70 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/multi-page-cut.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/multi-page-cut.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[multiPageCut](multi-page-cut.md) - -# multiPageCut - - -public [multiPageCut](multi-page-cut.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -string of index for cutting pages - -#### Parameters - - - -| | | -|---|---| -| index | index of thumbnails (zero based) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# multiPageCut + + +public [multiPageCut](multi-page-cut.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +string of index for cutting pages + +#### Parameters + + + +| | | +|---|---| +| index | index of thumbnails (zero based) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/new-instance.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/new-instance.md index 0721f5a9af..78fbc5c1d5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/new-instance.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/new-instance.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[newInstance](new-instance.md) - -# newInstance - - -public [newInstance](new-instance.md)(): [DataExplorer](index.md) - -creates a new DataExplorer object - -#### Return - -a DataExplorer instance that is not attached to any thread - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# newInstance + + +public [newInstance](new-instance.md)(): [DataExplorer](index.md) + +creates a new DataExplorer object + +#### Return + +a DataExplorer instance that is not attached to any thread + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/page-copy.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/page-copy.md index 51afd4ba68..dc917dac50 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/page-copy.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/page-copy.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[pageCopy](page-copy.md) - -# pageCopy - - -public [pageCopy](page-copy.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -copies a page in the DataExplorer - -#### Parameters - - - -| | | -|---|---| -| index | the position in the array of the page to be copied (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# pageCopy + + +public [pageCopy](page-copy.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +copies a page in the DataExplorer + +#### Parameters + + + +| | | +|---|---| +| index | the position in the array of the page to be copied (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/page-cut.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/page-cut.md index bd996a73a9..d4e2fdaead 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/page-cut.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/page-cut.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[pageCut](page-cut.md) - -# pageCut - - -public [pageCut](page-cut.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -cuts a page from the DataExplorer - -#### Parameters - - - -| | | -|---|---| -| index | the position in the array of the item to be cut (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# pageCut + + +public [pageCut](page-cut.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +cuts a page from the DataExplorer + +#### Parameters + + + +| | | +|---|---| +| index | the position in the array of the item to be cut (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/page-paste.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/page-paste.md index 17df27129e..3c8410db7c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/page-paste.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/page-paste.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[pagePaste](page-paste.md) - -# pagePaste - - -public [pagePaste](page-paste.md)() - -Pastes a page from the DataExplorer - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# pagePaste + + +public [pagePaste](page-paste.md)() + +Pastes a page from the DataExplorer + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/remove-from-comparison-list.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/remove-from-comparison-list.md index 8c5051849d..d1f31433a7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/remove-from-comparison-list.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/remove-from-comparison-list.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[removeFromComparisonList](remove-from-comparison-list.md) - -# removeFromComparisonList - - -public [removeFromComparisonList](remove-from-comparison-list.md)(runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -remove a run from the design comparison list - -#### Parameters - - - -| | | -|---|---| -| runID | run ID (zero based) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# removeFromComparisonList + + +public [removeFromComparisonList](remove-from-comparison-list.md)(runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +remove a run from the design comparison list + +#### Parameters + + + +| | | +|---|---| +| runID | run ID (zero based) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/remove-page.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/remove-page.md index a4586cb63f..081442376b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/remove-page.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/remove-page.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[removePage](remove-page.md) - -# removePage - - -public [removePage](remove-page.md)(page: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -remove a page from the DataExplorer - -#### Parameters - - - -| | | -|---|---| -| page | the item in the DataExplorer to remove (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# removePage + + +public [removePage](remove-page.md)(page: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +remove a page from the DataExplorer + +#### Parameters + + + +| | | +|---|---| +| page | the item in the DataExplorer to remove (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/select-page.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/select-page.md index 1c097209a5..fd9b278518 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/select-page.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/select-page.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[selectPage](select-page.md) - -# selectPage - - -public [selectPage](select-page.md)(page: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -selects a certain page in the DataExplorer - -#### Parameters - - - -| | | -|---|---| -| page | the page to be selected (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# selectPage + + +public [selectPage](select-page.md)(page: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +selects a certain page in the DataExplorer + +#### Parameters + + + +| | | +|---|---| +| page | the page to be selected (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-associated-model-file-u-u-i-d.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-associated-model-file-u-u-i-d.md index da1be6d5bd..6e496fddfe 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-associated-model-file-u-u-i-d.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-associated-model-file-u-u-i-d.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[setAssociatedModelFileUUID](set-associated-model-file-u-u-i-d.md) - -# setAssociatedModelFileUUID - - -public [setAssociatedModelFileUUID](set-associated-model-file-u-u-i-d.md)(fileUUID: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the AssociatedModelFileUUID - -#### Parameters - - - -| | | -|---|---| -| fileUUID | string containing the fileUUID | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setAssociatedModelFileUUID + + +public [setAssociatedModelFileUUID](set-associated-model-file-u-u-i-d.md)(fileUUID: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the AssociatedModelFileUUID + +#### Parameters + + + +| | | +|---|---| +| fileUUID | string containing the fileUUID | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-associated-model-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-associated-model-file.md index 7bfc6d3f6e..11c3b4363c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-associated-model-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-associated-model-file.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[setAssociatedModelFile](set-associated-model-file.md) - -# setAssociatedModelFile - - -public [setAssociatedModelFile](set-associated-model-file.md)(filename: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the AssociatedModelFile - -#### Parameters - - - -| | | -|---|---| -| filename | string containing the filename to set | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setAssociatedModelFile + + +public [setAssociatedModelFile](set-associated-model-file.md)(filename: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the AssociatedModelFile + +#### Parameters + + + +| | | +|---|---| +| filename | string containing the filename to set | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-author.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-author.md index 838bdc2f19..773899f5be 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-author.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-author.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[setAuthor](set-author.md) - -# setAuthor - - -public [setAuthor](set-author.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the author - -#### Parameters - - - -| | | -|---|---| -| name | the name of the author to set | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setAuthor + + +public [setAuthor](set-author.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the author + +#### Parameters + + + +| | | +|---|---| +| name | the name of the author to set | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-creation-date.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-creation-date.md index 95d7633c61..6643027627 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-creation-date.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-creation-date.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[setCreationDate](set-creation-date.md) - -# setCreationDate - - -public [setCreationDate](set-creation-date.md)(creationDate: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the creation date - -#### Parameters - - - -| | | -|---|---| -| creationDate | the new creation date | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setCreationDate + + +public [setCreationDate](set-creation-date.md)(creationDate: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the creation date + +#### Parameters + + + +| | | +|---|---| +| creationDate | the new creation date | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-description.md index a9007f871b..db77458511 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-description.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[setDescription](set-description.md) - -# setDescription - - -public [setDescription](set-description.md)(desc: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the description - -#### Parameters - - - -| | | -|---|---| -| desc | a string carrying the description to set | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDescription + + +public [setDescription](set-description.md)(desc: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the description + +#### Parameters + + + +| | | +|---|---| +| desc | a string carrying the description to set | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-display-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-display-name.md index a77fea4cf6..e3cb486832 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-display-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-display-name.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[setDisplayName](set-display-name.md) - -# setDisplayName - - -public [setDisplayName](set-display-name.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the Displayname - -#### Parameters - - - -| | | -|---|---| -| name | a string carrying the display name to set | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDisplayName + + +public [setDisplayName](set-display-name.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the Displayname + +#### Parameters + + + +| | | +|---|---| +| name | a string carrying the display name to set | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-file-uri.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-file-uri.md index 4f1c62a620..448875bb1b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-file-uri.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-file-uri.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[setFileUri](set-file-uri.md) - -# setFileUri - - -public [setFileUri](set-file-uri.md)(fileUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Set the File URI loaded in this DataExplorer. This does not actually load the file, and is merely a container for data. - -#### Parameters - - - -| | | -|---|---| -| fileUri | the URI of the file loaded. | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if setting the URI fails | +# setFileUri + + +public [setFileUri](set-file-uri.md)(fileUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Set the File URI loaded in this DataExplorer. This does not actually load the file, and is merely a container for data. + +#### Parameters + + + +| | | +|---|---| +| fileUri | the URI of the file loaded. | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if setting the URI fails | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-geom-viewer-run-i-d.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-geom-viewer-run-i-d.md index 90df6187a6..d00d68fb7e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-geom-viewer-run-i-d.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-geom-viewer-run-i-d.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[setGeomViewerRunID](set-geom-viewer-run-i-d.md) - -# setGeomViewerRunID - - -public [setGeomViewerRunID](set-geom-viewer-run-i-d.md)(viewerID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -set runID for the design viewer. This call will update content of the viewer. - -#### Parameters - - - -| | | -|---|---| -| viewerID | unique ID of the view to update. negative to update all | -| runID | runID to be set | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setGeomViewerRunID + + +public [setGeomViewerRunID](set-geom-viewer-run-i-d.md)(viewerID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +set runID for the design viewer. This call will update content of the viewer. + +#### Parameters + + + +| | | +|---|---| +| viewerID | unique ID of the view to update. negative to update all | +| runID | runID to be set | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-trade-study-setup.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-trade-study-setup.md index c7f313895e..d317104f7e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-trade-study-setup.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-trade-study-setup.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[setTradeStudySetup](set-trade-study-setup.md) - -# setTradeStudySetup - - -public [setTradeStudySetup](set-trade-study-setup.md)(tsSetup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the TradeStudySetup - -#### Parameters - - - -| | | -|---|---| -| tsSetup | a string carrying the trade study setup to set | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setTradeStudySetup + + +public [setTradeStudySetup](set-trade-study-setup.md)(tsSetup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the TradeStudySetup + +#### Parameters + + + +| | | +|---|---| +| tsSetup | a string carrying the trade study setup to set | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-trade-study-type.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-trade-study-type.md index ebc269538d..b086cb17fb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-trade-study-type.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-trade-study-type.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[setTradeStudyType](set-trade-study-type.md) - -# setTradeStudyType - - -public [setTradeStudyType](set-trade-study-type.md)(tsType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the TradeStudyType - -#### Parameters - - - -| | | -|---|---| -| tsType | string carrying the trade study type to set | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setTradeStudyType + + +public [setTradeStudyType](set-trade-study-type.md)(tsType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the TradeStudyType + +#### Parameters + + + +| | | +|---|---| +| tsType | string carrying the trade study type to set | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/setup-plots-post.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/setup-plots-post.md index e278bbc329..d2463e181a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/setup-plots-post.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/setup-plots-post.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[setupPlotsPost](setup-plots-post.md) - -# setupPlotsPost - - -public [setupPlotsPost](setup-plots-post.md)() - -add plots when the trade study finished. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setupPlotsPost + + +public [setupPlotsPost](setup-plots-post.md)() + +add plots when the trade study finished. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/setup-plots-pre.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/setup-plots-pre.md index bb6171ab09..69049a18a3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/setup-plots-pre.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/setup-plots-pre.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[setupPlotsPre](setup-plots-pre.md) - -# setupPlotsPre - - -public [setupPlotsPre](setup-plots-pre.md)() - -add plots when Data Collector is created. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setupPlotsPre + + +public [setupPlotsPre](setup-plots-pre.md)() + +add plots when Data Collector is created. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/show-geom-tooltip.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/show-geom-tooltip.md index ae6773f434..94c891b88e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/show-geom-tooltip.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/show-geom-tooltip.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[showGeomTooltip](show-geom-tooltip.md) - -# showGeomTooltip - - -public [showGeomTooltip](show-geom-tooltip.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -add plots when the trade study finished. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# showGeomTooltip + + +public [showGeomTooltip](show-geom-tooltip.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +add plots when the trade study finished. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/show-geom-viewer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/show-geom-viewer.md index e90f81886d..7e2fe9f366 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/show-geom-viewer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/show-geom-viewer.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[showGeomViewer](show-geom-viewer.md) - -# showGeomViewer - - -public [showGeomViewer](show-geom-viewer.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -add plots when the trade study finished. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# showGeomViewer + + +public [showGeomViewer](show-geom-viewer.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +add plots when the trade study finished. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/show.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/show.md index 13dcd40515..e7112a5239 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/show.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/show.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[show](show.md) - -# show - - -public [show](show.md)() +# show + + +public [show](show.md)() diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/to-x-m-l-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/to-x-m-l-file.md index 2a87dfbe76..fa0c47a75e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/to-x-m-l-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/to-x-m-l-file.md @@ -1,42 +1,40 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[toXMLFile](to-x-m-l-file.md) - -# toXMLFile - - -public [toXMLFile](to-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -turns the given file into an XML file - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to turn into an XML file in format | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [toXMLFile](to-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), includeRunData: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -turns the given file into an XML file - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to turn into an XML file in format | -| includeRunData | whether or not to include run data into the XML | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toXMLFile + + +public [toXMLFile](to-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +turns the given file into an XML file + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to turn into an XML file in format | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [toXMLFile](to-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), includeRunData: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +turns the given file into an XML file + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to turn into an XML file in format | +| includeRunData | whether or not to include run data into the XML | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/to-x-m-l.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/to-x-m-l.md index 7656f689fd..749297f6d6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/to-x-m-l.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/to-x-m-l.md @@ -1,41 +1,39 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[toXML](to-x-m-l.md) - -# toXML - - -public [toXML](to-x-m-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -to XML - -#### Return - -string - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [toXML](to-x-m-l.md)(includeRunData: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -to XML - -#### Return - -string - -#### Parameters - - - -| | | -|---|---| -| includeRunData | whether or not to include run data into the XML | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toXML + + +public [toXML](to-x-m-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +to XML + +#### Return + +string + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [toXML](to-x-m-l.md)(includeRunData: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +to XML + +#### Return + +string + +#### Parameters + + + +| | | +|---|---| +| includeRunData | whether or not to include run data into the XML | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/update-comparison-view-hint.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/update-comparison-view-hint.md index 5630a11daf..561d9b63e6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/update-comparison-view-hint.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/update-comparison-view-hint.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[updateComparisonViewHint](update-comparison-view-hint.md) - -# updateComparisonViewHint - - -public [updateComparisonViewHint](update-comparison-view-hint.md)(restore: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -trigger updating the comparison view - -#### Parameters - - - -| | | -|---|---| -| restore | restore the comparison view if it was minimized | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# updateComparisonViewHint + + +public [updateComparisonViewHint](update-comparison-view-hint.md)(restore: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +trigger updating the comparison view + +#### Parameters + + + +| | | +|---|---| +| restore | restore the comparison view if it was minimized | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/update-geom-viewer-hint.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/update-geom-viewer-hint.md index ff85447881..9128744567 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/update-geom-viewer-hint.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/update-geom-viewer-hint.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[updateGeomViewerHint](update-geom-viewer-hint.md) - -# updateGeomViewerHint - - -public [updateGeomViewerHint](update-geom-viewer-hint.md)(viewerID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -trigger updating design viewers. - -#### Parameters - - - -| | | -|---|---| -| viewerID | unique ID of the view to update. negative to update all | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# updateGeomViewerHint + + +public [updateGeomViewerHint](update-geom-viewer-hint.md)(viewerID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +trigger updating design viewers. + +#### Parameters + + + +| | | +|---|---| +| viewerID | unique ID of the view to update. negative to update all | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/update-thumb-hint.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/update-thumb-hint.md index e29b1487c4..4627d0e5bd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/update-thumb-hint.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-explorer/update-thumb-hint.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataExplorer](index.md)/[updateThumbHint](update-thumb-hint.md) - -# updateThumbHint - - -public [updateThumbHint](update-thumb-hint.md)(item: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -updates a thumb hint - -#### Parameters - - - -| | | -|---|---| -| item | the id of the thumb hint (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# updateThumbHint + + +public [updateThumbHint](update-thumb-hint.md)(item: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +updates a thumb hint + +#### Parameters + + + +| | | +|---|---| +| item | the id of the thumb hint (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/-data-history-variable-metadata-struct.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/-data-history-variable-metadata-struct.md index ac3ebb67dc..af563170ca 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/-data-history-variable-metadata-struct.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/-data-history-variable-metadata-struct.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md)/[DataHistoryVariableMetadataStruct](-data-history-variable-metadata-struct.md) - -# DataHistoryVariableMetadataStruct - - -constructor() +# DataHistoryVariableMetadataStruct + + +constructor() diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/custom-metadata.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/custom-metadata.md index 0495af53d6..d30ff022d5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/custom-metadata.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/custom-metadata.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md)/[customMetadata](custom-metadata.md) - -# customMetadata - - -open var [customMetadata](custom-metadata.md): [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> - -Map of name/value pairs representing each piece of custom metadata +# customMetadata + + +open var [customMetadata](custom-metadata.md): [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> + +Map of name/value pairs representing each piece of custom metadata diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/enum-aliases.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/enum-aliases.md index 67050d6360..eb7607e705 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/enum-aliases.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/enum-aliases.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md)/[enumAliases](enum-aliases.md) - -# enumAliases - - -open var [enumAliases](enum-aliases.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -comma separated list of enumerated aliases of variable +# enumAliases + + +open var [enumAliases](enum-aliases.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +comma separated list of enumerated aliases of variable diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/enum-values.md index b92f0536b1..95d94c1588 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/enum-values.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md)/[enumValues](enum-values.md) - -# enumValues - - -open var [enumValues](enum-values.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -comma separated list of enumerated values of variable +# enumValues + + +open var [enumValues](enum-values.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +comma separated list of enumerated values of variable diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/equation.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/equation.md index 4bcd5397ba..2e01dba529 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/equation.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/equation.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md)/[equation](equation.md) - -# equation - - -open var [equation](equation.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -The equation of the variable +# equation + + +open var [equation](equation.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +The equation of the variable diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/file-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/file-name.md index cfb59672b1..235b67ad3e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/file-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/file-name.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md)/[fileName](file-name.md) - -# fileName - - -open var [fileName](file-name.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -The filename of a file variable +# fileName + + +open var [fileName](file-name.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +The filename of a file variable diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/format.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/format.md index 745ee5a77f..125a9e7103 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/format.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/format.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md)/[format](format.md) - -# format - - -open var [format](format.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -The format of the variable +# format + + +open var [format](format.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +The format of the variable diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/geom-script.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/geom-script.md index d3b1150cab..9d0c282701 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/geom-script.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/geom-script.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md)/[geomScript](geom-script.md) - -# geomScript - - -open var [geomScript](geom-script.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -The geomScript of the variable +# geomScript + + +open var [geomScript](geom-script.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +The geomScript of the variable diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/get-custom-metadata-names.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/get-custom-metadata-names.md index cb24932a4e..f4852bd227 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/get-custom-metadata-names.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/get-custom-metadata-names.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md)/[getCustomMetadataNames](get-custom-metadata-names.md) - -# getCustomMetadataNames - - -public [getCustomMetadataNames](get-custom-metadata-names.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> - -Gets an array of the names of the custom metadata fields. This function assists the JNI layer with getting custom metadata. - -#### Return - -An array of custom metadata field names +# getCustomMetadataNames + + +public [getCustomMetadataNames](get-custom-metadata-names.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> + +Gets an array of the names of the custom metadata fields. This function assists the JNI layer with getting custom metadata. + +#### Return + +An array of custom metadata field names diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/index.md index 075f418b0a..8a16abb767 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/index.md @@ -1,46 +1,44 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md) - -# DataHistoryVariableMetadataStruct - -public class [DataHistoryVariableMetadataStruct](index.md) - -This object is used to pass variable metadata to the addVariableStructs function for data history, which sets the results for a run. This class is referenced by the [DataHistoryVariableStruct](../-data-history-variable-struct/index.md) object. For more information see [addVariableStructs](../-data-history/add-variable-structs.md). - -#### See also - -| | -|---| -| [DataHistoryVariableStruct](../-data-history-variable-struct/index.md) | - -## Constructors - -| | | -|---|---| -| [DataHistoryVariableMetadataStruct](-data-history-variable-metadata-struct.md) | constructor() | - -## Properties - -| Name | Summary | -|---|---| -| [customMetadata](custom-metadata.md) | open var [customMetadata](custom-metadata.md): [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>
Map of name/value pairs representing each piece of custom metadata | -| [enumAliases](enum-aliases.md) | open var [enumAliases](enum-aliases.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
comma separated list of enumerated aliases of variable | -| [enumValues](enum-values.md) | open var [enumValues](enum-values.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
comma separated list of enumerated values of variable | -| [equation](equation.md) | open var [equation](equation.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
The equation of the variable | -| [fileName](file-name.md) | open var [fileName](file-name.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
The filename of a file variable | -| [format](format.md) | open var [format](format.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
The format of the variable | -| [geomScript](geom-script.md) | open var [geomScript](geom-script.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
The geomScript of the variable | -| [isBinary](is-binary.md) | open var [isBinary](is-binary.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
true if file variable is a binary file, false otherwise | -| [isDesignVar](is-design-var.md) | open var [isDesignVar](is-design-var.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
true if the variable is a design variable, false otherwise | -| [isInput](is-input.md) | open var [isInput](is-input.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
true if the variable is an input, false otherwise | -| [isNumeric](is-numeric.md) | open var [isNumeric](is-numeric.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
true if the variable is numeric, false otherwise | -| [lowerBound](lower-bound.md) | open var [lowerBound](lower-bound.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
The lower bound of the variable | -| [name](name.md) | open var [name](name.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
The name of the variable | -| [type](type.md) | open var [type](type.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
The type of the variable | -| [units](units.md) | open var [units](units.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
The units of the variable | -| [upperBound](upper-bound.md) | open var [upperBound](upper-bound.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
The upper bound of the variable | - -## Functions - -| Name | Summary | -|---|---| -| [getCustomMetadataNames](get-custom-metadata-names.md) | public [getCustomMetadataNames](get-custom-metadata-names.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>
Gets an array of the names of the custom metadata fields. | +# DataHistoryVariableMetadataStruct + +public class [DataHistoryVariableMetadataStruct](index.md) + +This object is used to pass variable metadata to the addVariableStructs function for data history, which sets the results for a run. This class is referenced by the [DataHistoryVariableStruct](../-data-history-variable-struct/index.md) object. For more information see [addVariableStructs](../-data-history/add-variable-structs.md). + +#### See also + +| | +|---| +| [DataHistoryVariableStruct](../-data-history-variable-struct/index.md) | + +## Constructors + +| | | +|---|---| +| [DataHistoryVariableMetadataStruct](-data-history-variable-metadata-struct.md) | constructor() | + +## Properties + +| Name | Summary | +|---|---| +| [customMetadata](custom-metadata.md) | open var [customMetadata](custom-metadata.md): [Map](https://docs.oracle.com/javase/8/docs/api/java/util/Map.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>
Map of name/value pairs representing each piece of custom metadata | +| [enumAliases](enum-aliases.md) | open var [enumAliases](enum-aliases.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
comma separated list of enumerated aliases of variable | +| [enumValues](enum-values.md) | open var [enumValues](enum-values.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
comma separated list of enumerated values of variable | +| [equation](equation.md) | open var [equation](equation.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
The equation of the variable | +| [fileName](file-name.md) | open var [fileName](file-name.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
The filename of a file variable | +| [format](format.md) | open var [format](format.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
The format of the variable | +| [geomScript](geom-script.md) | open var [geomScript](geom-script.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
The geomScript of the variable | +| [isBinary](is-binary.md) | open var [isBinary](is-binary.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
true if file variable is a binary file, false otherwise | +| [isDesignVar](is-design-var.md) | open var [isDesignVar](is-design-var.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
true if the variable is a design variable, false otherwise | +| [isInput](is-input.md) | open var [isInput](is-input.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
true if the variable is an input, false otherwise | +| [isNumeric](is-numeric.md) | open var [isNumeric](is-numeric.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
true if the variable is numeric, false otherwise | +| [lowerBound](lower-bound.md) | open var [lowerBound](lower-bound.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
The lower bound of the variable | +| [name](name.md) | open var [name](name.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
The name of the variable | +| [type](type.md) | open var [type](type.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
The type of the variable | +| [units](units.md) | open var [units](units.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
The units of the variable | +| [upperBound](upper-bound.md) | open var [upperBound](upper-bound.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
The upper bound of the variable | + +## Functions + +| Name | Summary | +|---|---| +| [getCustomMetadataNames](get-custom-metadata-names.md) | public [getCustomMetadataNames](get-custom-metadata-names.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>
Gets an array of the names of the custom metadata fields. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-binary.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-binary.md index c1a0843735..7f0a1c7df3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-binary.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-binary.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md)/[isBinary](is-binary.md) - -# isBinary - - -open var [isBinary](is-binary.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -true if file variable is a binary file, false otherwise +# isBinary + + +open var [isBinary](is-binary.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +true if file variable is a binary file, false otherwise diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-design-var.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-design-var.md index 069fb88923..843778963c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-design-var.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-design-var.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md)/[isDesignVar](is-design-var.md) - -# isDesignVar - - -open var [isDesignVar](is-design-var.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -true if the variable is a design variable, false otherwise +# isDesignVar + + +open var [isDesignVar](is-design-var.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +true if the variable is a design variable, false otherwise diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-input.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-input.md index 6c91e1c82e..eec256bd0a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-input.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-input.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md)/[isInput](is-input.md) - -# isInput - - -open var [isInput](is-input.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -true if the variable is an input, false otherwise +# isInput + + +open var [isInput](is-input.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +true if the variable is an input, false otherwise diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-numeric.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-numeric.md index 9651ccf228..9dec233e23 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-numeric.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-numeric.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md)/[isNumeric](is-numeric.md) - -# isNumeric - - -open var [isNumeric](is-numeric.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -true if the variable is numeric, false otherwise +# isNumeric + + +open var [isNumeric](is-numeric.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +true if the variable is numeric, false otherwise diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/lower-bound.md index fe4bb3d9cf..d9df29cce6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/lower-bound.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md)/[lowerBound](lower-bound.md) - -# lowerBound - - -open var [lowerBound](lower-bound.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -The lower bound of the variable +# lowerBound + + +open var [lowerBound](lower-bound.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +The lower bound of the variable diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/name.md index 1cfaa09ca3..f29386823d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/name.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md)/[name](name.md) - -# name - - -open var [name](name.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -The name of the variable +# name + + +open var [name](name.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +The name of the variable diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/type.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/type.md index 6e4780f15a..f3bffcd542 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/type.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/type.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md)/[type](type.md) - -# type - - -open var [type](type.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -The type of the variable +# type + + +open var [type](type.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +The type of the variable diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/units.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/units.md index c98cb618ae..d68d73b985 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/units.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/units.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md)/[units](units.md) - -# units - - -open var [units](units.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -The units of the variable +# units + + +open var [units](units.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +The units of the variable diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/upper-bound.md index cda47de230..21278488fd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/upper-bound.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableMetadataStruct](index.md)/[upperBound](upper-bound.md) - -# upperBound - - -open var [upperBound](upper-bound.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -The upper bound of the variable +# upperBound + + +open var [upperBound](upper-bound.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +The upper bound of the variable diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/--index--.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/--index--.md index 8740de4415..09e3db5a9f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/--index--.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/--index--.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableStruct](index.md)/[index](--index--.md) - -# index - - -open var [index](--index--.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -Either a 0 based index to the Variable, or the name of a Variable. +# index + + +open var [index](--index--.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Either a 0 based index to the Variable, or the name of a Variable. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/-data-history-variable-struct.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/-data-history-variable-struct.md index f10e00f8fe..d07eb5d2f1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/-data-history-variable-struct.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/-data-history-variable-struct.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableStruct](index.md)/[DataHistoryVariableStruct](-data-history-variable-struct.md) - -# DataHistoryVariableStruct - - -constructor() +# DataHistoryVariableStruct + + +constructor() diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/index.md index 415be80992..319034c191 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/index.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableStruct](index.md) - -# DataHistoryVariableStruct - - -public class [DataHistoryVariableStruct](index.md) - -This object is used to pass a variable's data and metadata to the addVariableStructs function for data history, which sets the results for a run. For more information see [addVariableStructs](../-data-history/add-variable-structs.md). - -## Constructors - -| | | -|---|---| -| [DataHistoryVariableStruct](-data-history-variable-struct.md) | constructor() | - -## Properties - -| Name | Summary | -|---|---| -| [index](--index--.md) | open var [index](--index--.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Either a 0 based index to the Variable, or the name of a Variable. | -| [isModified](is-modified.md) | open var [isModified](is-modified.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Whether this value's modified flag is set. | -| [isValid](is-valid.md) | open var [isValid](is-valid.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Whether this value is valid. | -| [metadata](metadata.md) | open var [metadata](metadata.md): [DataHistoryVariableMetadataStruct](../-data-history-variable-metadata-struct/index.md)
The metadata for the Variable | -| [varValue](var-value.md) | open var [varValue](var-value.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
The value of the Variable. | +# DataHistoryVariableStruct + + +public class [DataHistoryVariableStruct](index.md) + +This object is used to pass a variable's data and metadata to the addVariableStructs function for data history, which sets the results for a run. For more information see [addVariableStructs](../-data-history/add-variable-structs.md). + +## Constructors + +| | | +|---|---| +| [DataHistoryVariableStruct](-data-history-variable-struct.md) | constructor() | + +## Properties + +| Name | Summary | +|---|---| +| [index](--index--.md) | open var [index](--index--.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Either a 0 based index to the Variable, or the name of a Variable. | +| [isModified](is-modified.md) | open var [isModified](is-modified.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Whether this value's modified flag is set. | +| [isValid](is-valid.md) | open var [isValid](is-valid.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Whether this value is valid. | +| [metadata](metadata.md) | open var [metadata](metadata.md): [DataHistoryVariableMetadataStruct](../-data-history-variable-metadata-struct/index.md)
The metadata for the Variable | +| [varValue](var-value.md) | open var [varValue](var-value.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
The value of the Variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/is-modified.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/is-modified.md index b2563d5021..80ce85d0de 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/is-modified.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/is-modified.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableStruct](index.md)/[isModified](is-modified.md) - -# isModified - - -open var [isModified](is-modified.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Whether this value's modified flag is set. +# isModified + + +open var [isModified](is-modified.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Whether this value's modified flag is set. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/is-valid.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/is-valid.md index e37c2e2968..01cfc89ef4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/is-valid.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/is-valid.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableStruct](index.md)/[isValid](is-valid.md) - -# isValid - - -open var [isValid](is-valid.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Whether this value is valid. +# isValid + + +open var [isValid](is-valid.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Whether this value is valid. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/metadata.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/metadata.md index 5a5e37951e..4f3adda082 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/metadata.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/metadata.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableStruct](index.md)/[metadata](metadata.md) - -# metadata - - -open var [metadata](metadata.md): [DataHistoryVariableMetadataStruct](../-data-history-variable-metadata-struct/index.md) - -The metadata for the Variable +# metadata + + +open var [metadata](metadata.md): [DataHistoryVariableMetadataStruct](../-data-history-variable-metadata-struct/index.md) + +The metadata for the Variable diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/var-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/var-value.md index 2a89766763..20c4dd585d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/var-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/var-value.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistoryVariableStruct](index.md)/[varValue](var-value.md) - -# varValue - - -open var [varValue](var-value.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -The value of the Variable. +# varValue + + +open var [varValue](var-value.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +The value of the Variable. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/-data-history.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/-data-history.md index 0891e7c61d..9a7c072a73 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/-data-history.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/-data-history.md @@ -1,21 +1,19 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[DataHistory](-data-history.md) - -# DataHistory - - -constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -Connects this Java object to the specified session of ModelCenter - -#### Parameters - - - -| | | -|---|---| -| pstrm | A pointer to the COM interface. This constructor will add a COM reference. The reference will be removed when this object is finalized (or closed) | - - -constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Internal use only +# DataHistory + + +constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +Connects this Java object to the specified session of ModelCenter + +#### Parameters + + + +| | | +|---|---| +| pstrm | A pointer to the COM interface. This constructor will add a COM reference. The reference will be removed when this object is finalized (or closed) | + + +constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Internal use only diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/add-variable-structs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/add-variable-structs.md index 6f1b6a37d8..e4ca8b5e3d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/add-variable-structs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/add-variable-structs.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[addVariableStructs](add-variable-structs.md) - -# addVariableStructs - - -public [addVariableStructs](add-variable-structs.md)(dhVarStructs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DataHistoryVariableStruct](../-data-history-variable-struct/index.md)>, run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -Sets the results for a run. This method will add variables to the DataHistory if they are not already present. File variables are not supported. - -#### Parameters - - - -| | | -|---|---| -| dhVarStructs | Array of DataHistoryVariableStructs to add | -| run | The 0 based index to the run to set. | +# addVariableStructs + + +public [addVariableStructs](add-variable-structs.md)(dhVarStructs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DataHistoryVariableStruct](../-data-history-variable-struct/index.md)>, run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +Sets the results for a run. This method will add variables to the DataHistory if they are not already present. File variables are not supported. + +#### Parameters + + + +| | | +|---|---| +| dhVarStructs | Array of DataHistoryVariableStructs to add | +| run | The 0 based index to the run to set. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/add-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/add-variable.md index 41b21927e1..0757c85bf5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/add-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/add-variable.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[addVariable](add-variable.md) - -# addVariable - - -public [addVariable](add-variable.md)(var: [DHVariable](../-d-h-variable/index.md)) - -adds variable var to DataHistory - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addVariable + + +public [addVariable](add-variable.md)(var: [DHVariable](../-d-h-variable/index.md)) + +adds variable var to DataHistory + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/create-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/create-variable.md index 8d237fc070..048eb7b7c0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/create-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/create-variable.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[createVariable](create-variable.md) - -# createVariable - - -public [createVariable](create-variable.md)(): [DHVariable](../-d-h-variable/index.md) - -creates a variable - -#### Return - -Object - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# createVariable + + +public [createVariable](create-variable.md)(): [DHVariable](../-d-h-variable/index.md) + +creates a variable + +#### Return + +Object + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/delete-run.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/delete-run.md index 20f534dd5c..8b3f2331e3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/delete-run.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/delete-run.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[deleteRun](delete-run.md) - -# deleteRun - - -public [deleteRun](delete-run.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -deletes a run - -#### Parameters - - - -| | | -|---|---| -| run | the run to delete (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# deleteRun + + +public [deleteRun](delete-run.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +deletes a run + +#### Parameters + + + +| | | +|---|---| +| run | the run to delete (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/delete-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/delete-variable.md index 976ff0d6e1..005fba4186 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/delete-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/delete-variable.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[deleteVariable](delete-variable.md) - -# deleteVariable - - -public [deleteVariable](delete-variable.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -public [deleteVariable](delete-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -deletes a variable at the given index - -#### Parameters - - - -| | | -|---|---| -| index | the index in the array of the variable to delete (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# deleteVariable + + +public [deleteVariable](delete-variable.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +public [deleteVariable](delete-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +deletes a variable at the given index + +#### Parameters + + + +| | | +|---|---| +| index | the index in the array of the variable to delete (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/end-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/end-runs.md index af1fab2c04..1ddedd6418 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/end-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/end-runs.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[endRuns](end-runs.md) - -# endRuns - - -public [endRuns](end-runs.md)() - -ends the runs - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# endRuns + + +public [endRuns](end-runs.md)() + +ends the runs + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/from-x-m-l-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/from-x-m-l-file.md index 917eb65b1f..4dc39f7aaa 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/from-x-m-l-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/from-x-m-l-file.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[fromXMLFile](from-x-m-l-file.md) - -# fromXMLFile - - -public [fromXMLFile](from-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), root: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -from XML file - -#### Parameters - - - -| | | -|---|---| -| fileName | the name of the XML file (String) | -| root | (was [optional] Variant) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# fromXMLFile + + +public [fromXMLFile](from-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), root: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +from XML file + +#### Parameters + + + +| | | +|---|---| +| fileName | the name of the XML file (String) | +| root | (was [optional] Variant) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/from-x-m-l.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/from-x-m-l.md index 763abe7373..b6b169baa8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/from-x-m-l.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/from-x-m-l.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[fromXML](from-x-m-l.md) - -# fromXML - - -public [fromXML](from-x-m-l.md)(xmlStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), root: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -from XML - -#### Parameters - - - -| | | -|---|---| -| xmlStr | XML string | -| root | (was [optional] Variant) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# fromXML + + +public [fromXML](from-x-m-l.md)(xmlStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), root: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +from XML + +#### Parameters + + + +| | | +|---|---| +| xmlStr | XML string | +| root | (was [optional] Variant) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-job-connector.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-job-connector.md index 9f7c2f08b6..eee3e95c36 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-job-connector.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-job-connector.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getCenterLinkJobConnector](get-center-link-job-connector.md) - -# getCenterLinkJobConnector - - -public [getCenterLinkJobConnector](get-center-link-job-connector.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -CenterLink is not supported by this version of ModelCenter. This method will always throw a ModelCenterException. - -#### Return - -Does not return. Method always throws an exception. - -#### Deprecated - -CenterLink is not supported by this version of ModelCenter. - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | Exception stating CenterLink is not supported. | +# getCenterLinkJobConnector + + +public [getCenterLinkJobConnector](get-center-link-job-connector.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +CenterLink is not supported by this version of ModelCenter. This method will always throw a ModelCenterException. + +#### Return + +Does not return. Method always throws an exception. + +#### Deprecated + +CenterLink is not supported by this version of ModelCenter. + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | Exception stating CenterLink is not supported. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-queue.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-queue.md index 533bc0de0f..c2b7c71123 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-queue.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-queue.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getCenterLinkQueue](get-center-link-queue.md) - -# getCenterLinkQueue - - -public [getCenterLinkQueue](get-center-link-queue.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -CenterLink is not supported by this version of ModelCenter. This method will always throw a ModelCenterException. - -#### Return - -Does not return. Method always throws an exception. - -#### Deprecated - -CenterLink is not supported by this version of ModelCenter. - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | Exception stating CenterLink is not supported. | +# getCenterLinkQueue + + +public [getCenterLinkQueue](get-center-link-queue.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +CenterLink is not supported by this version of ModelCenter. This method will always throw a ModelCenterException. + +#### Return + +Does not return. Method always throws an exception. + +#### Deprecated + +CenterLink is not supported by this version of ModelCenter. + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | Exception stating CenterLink is not supported. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-run-matrix-i-d.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-run-matrix-i-d.md index 5e9ceb66d6..a3a801980a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-run-matrix-i-d.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-run-matrix-i-d.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getCenterLinkRunMatrixID](get-center-link-run-matrix-i-d.md) - -# getCenterLinkRunMatrixID - - -public [getCenterLinkRunMatrixID](get-center-link-run-matrix-i-d.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -CenterLink is not supported by this version of ModelCenter. This method will always throw a ModelCenterException. - -#### Return - -Does not return. Method always throws an exception. - -#### Deprecated - -CenterLink is not supported by this version of ModelCenter. - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | Exception stating CenterLink is not supported. | +# getCenterLinkRunMatrixID + + +public [getCenterLinkRunMatrixID](get-center-link-run-matrix-i-d.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +CenterLink is not supported by this version of ModelCenter. This method will always throw a ModelCenterException. + +#### Return + +Does not return. Method always throws an exception. + +#### Deprecated + +CenterLink is not supported by this version of ModelCenter. + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | Exception stating CenterLink is not supported. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-server.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-server.md index 321947aaf7..720a3b7d0c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-server.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-server.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getCenterLinkServer](get-center-link-server.md) - -# getCenterLinkServer - - -public [getCenterLinkServer](get-center-link-server.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -CenterLink is not supported by this version of ModelCenter. This method will always throw a ModelCenterException. - -#### Return - -Does not return. Method always throws an exception. - -#### Deprecated - -CenterLink is not supported by this version of ModelCenter. - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | Exception stating CenterLink is not supported. | +# getCenterLinkServer + + +public [getCenterLinkServer](get-center-link-server.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +CenterLink is not supported by this version of ModelCenter. This method will always throw a ModelCenterException. + +#### Return + +Does not return. Method always throws an exception. + +#### Deprecated + +CenterLink is not supported by this version of ModelCenter. + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | Exception stating CenterLink is not supported. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-completed-run-data.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-completed-run-data.md index 2ee101aafd..9b24322d4d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-completed-run-data.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-completed-run-data.md @@ -1,28 +1,26 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getCompletedRunData](get-completed-run-data.md) - -# getCompletedRunData - - -public [getCompletedRunData](get-completed-run-data.md)(startSequenceNumber: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), maxLength: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), allVariables: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [CompletedRunData](../-completed-run-data/index.md) - -Gets information about the completed run data, including the runIDs, error IDs, error messages, and variable values. - -#### Return - -A [com.phoenix_int.ModelCenter.CompletedRunData](../-completed-run-data/index.md) object, which contains information about the completed runs. - -#### Parameters - - - -| | | -|---|---| -| startSequenceNumber | index in the completed-run list to begin fetching from. Specify 0 to fetch from the beginning of the list. | -| maxLength | maximum number of completed runs to fetch. Specify -1 to fetch all available runs. | -| allVariables | flag if true will result in run data returned for all variables else only design variable data will be returned | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if something goes wrong when attempting to get the completed run data. | +# getCompletedRunData + + +public [getCompletedRunData](get-completed-run-data.md)(startSequenceNumber: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), maxLength: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), allVariables: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [CompletedRunData](../-completed-run-data/index.md) + +Gets information about the completed run data, including the runIDs, error IDs, error messages, and variable values. + +#### Return + +A [com.phoenix_int.ModelCenter.CompletedRunData](../-completed-run-data/index.md) object, which contains information about the completed runs. + +#### Parameters + + + +| | | +|---|---| +| startSequenceNumber | index in the completed-run list to begin fetching from. Specify 0 to fetch from the beginning of the list. | +| maxLength | maximum number of completed runs to fetch. Specify -1 to fetch all available runs. | +| allVariables | flag if true will result in run data returned for all variables else only design variable data will be returned | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if something goes wrong when attempting to get the completed run data. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-data-explorer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-data-explorer.md index b5381f7674..28f19af78c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-data-explorer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-data-explorer.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getDataExplorer](get-data-explorer.md) - -# getDataExplorer - - -public [getDataExplorer](get-data-explorer.md)(): [DataExplorer](../-data-explorer/index.md) - -gets the DataExplorer --was IDispatch in COM - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDataExplorer + + +public [getDataExplorer](get-data-explorer.md)(): [DataExplorer](../-data-explorer/index.md) + +gets the DataExplorer --was IDispatch in COM + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-data-history-to-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-data-history-to-model.md index c6278d598f..cd27dcf9ce 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-data-history-to-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-data-history-to-model.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getDataHistoryToModel](get-data-history-to-model.md) - -# getDataHistoryToModel - - -public [getDataHistoryToModel](get-data-history-to-model.md)(): [IDataHistoryToModel](../-i-data-history-to-model/index.md) - -Gets the dataHistoryToModel. NOTE: not implemented! Will throw an exception. We don't allow the user to retrieve this. If we did, we'd need a wrapper class around the IDataHistoryToModel COM object. But the only time this object is of interest is when we're installing our own custom object to replace the default one, in which case that COM object is just wrapping a Java object we've created here. That would cause a sort of weird circular dependency and I'd prefer to avoid even trying it until we're absolutely sure we need it. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDataHistoryToModel + + +public [getDataHistoryToModel](get-data-history-to-model.md)(): [IDataHistoryToModel](../-i-data-history-to-model/index.md) + +Gets the dataHistoryToModel. NOTE: not implemented! Will throw an exception. We don't allow the user to retrieve this. If we did, we'd need a wrapper class around the IDataHistoryToModel COM object. But the only time this object is of interest is when we're installing our own custom object to replace the default one, in which case that COM object is just wrapping a Java object we've created here. That would cause a sort of weird circular dependency and I'd prefer to avoid even trying it until we're absolutely sure we need it. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-error-i-d.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-error-i-d.md index ee872bb500..448369748f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-error-i-d.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-error-i-d.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getErrorID](get-error-i-d.md) - -# getErrorID - - -public [getErrorID](get-error-i-d.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -returns the ID of the Error that occured in the DataHistory - -#### Return - -long - -#### Parameters - - - -| | | -|---|---| -| run | the index of the run (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getErrorID + + +public [getErrorID](get-error-i-d.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +returns the ID of the Error that occured in the DataHistory + +#### Return + +long + +#### Parameters + + + +| | | +|---|---| +| run | the index of the run (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-error-message.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-error-message.md index 6dec4b9a2a..a40d27cc23 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-error-message.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-error-message.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getErrorMessage](get-error-message.md) - -# getErrorMessage - - -public [getErrorMessage](get-error-message.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -returns a string containing the error message for a given run - -#### Return - -String - -#### Parameters - - - -| | | -|---|---| -| run | the index of the run (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getErrorMessage + + +public [getErrorMessage](get-error-message.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +returns a string containing the error message for a given run + +#### Return + +String + +#### Parameters + + + +| | | +|---|---| +| run | the index of the run (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-formatted-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-formatted-value.md index 80340bc26f..80d5f6f93e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-formatted-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-formatted-value.md @@ -1,51 +1,49 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getFormattedValue](get-formatted-value.md) - -# getFormattedValue - - -public [getFormattedValue](get-formatted-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets a value at the given index for a given run - -#### Return - -String - -#### Parameters - - - -| | | -|---|---| -| index | the index of the value to get | -| run | the run of the variable to get (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getFormattedValue](get-formatted-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets a value at the given index for a given run - -#### Return - -String - -#### Parameters - - - -| | | -|---|---| -| index | the index of the value to get (0-based index) | -| run | the run of the variable to get (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getFormattedValue + + +public [getFormattedValue](get-formatted-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets a value at the given index for a given run + +#### Return + +String + +#### Parameters + + + +| | | +|---|---| +| index | the index of the value to get | +| run | the run of the variable to get (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getFormattedValue](get-formatted-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets a value at the given index for a given run + +#### Return + +String + +#### Parameters + + + +| | | +|---|---| +| index | the index of the value to get (0-based index) | +| run | the run of the variable to get (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-highlighted-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-highlighted-runs.md index fa08b987f1..c369a63c1f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-highlighted-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-highlighted-runs.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getHighlightedRuns](get-highlighted-runs.md) - -# getHighlightedRuns - - -public [getHighlightedRuns](get-highlighted-runs.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)> - -Retrieve the set of currently highlighted run indices - -#### Return - -the set of currently highlighted run indices as an array of longs - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if something goes wrong getting the highlighted runs | +# getHighlightedRuns + + +public [getHighlightedRuns](get-highlighted-runs.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)> + +Retrieve the set of currently highlighted run indices + +#### Return + +the set of currently highlighted run indices as an array of longs + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if something goes wrong getting the highlighted runs | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-custom-vars.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-custom-vars.md index acde825cc8..130ef2d914 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-custom-vars.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-custom-vars.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getNumCustomVars](get-num-custom-vars.md) - -# getNumCustomVars - - -public [getNumCustomVars](get-num-custom-vars.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the number of custom variables - -#### Return - -long - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumCustomVars + + +public [getNumCustomVars](get-num-custom-vars.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the number of custom variables + +#### Return + +long + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-design-variables.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-design-variables.md index 91e82ad97a..06691c8972 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-design-variables.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-design-variables.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getNumDesignVariables](get-num-design-variables.md) - -# getNumDesignVariables - - -public [getNumDesignVariables](get-num-design-variables.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the number of design variables - -#### Return - -long - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumDesignVariables + + +public [getNumDesignVariables](get-num-design-variables.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the number of design variables + +#### Return + +long + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-expected-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-expected-runs.md index 87c8c8c971..bc11ef8c9c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-expected-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-expected-runs.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getNumExpectedRuns](get-num-expected-runs.md) - -# getNumExpectedRuns - - -public [getNumExpectedRuns](get-num-expected-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the number of expected runs - -#### Return - -long - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumExpectedRuns + + +public [getNumExpectedRuns](get-num-expected-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the number of expected runs + +#### Return + +long + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-failed-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-failed-runs.md index 1b27e30766..bde7edb71c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-failed-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-failed-runs.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getNumFailedRuns](get-num-failed-runs.md) - -# getNumFailedRuns - - -public [getNumFailedRuns](get-num-failed-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the number of failed runs - -#### Return - -long - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumFailedRuns + + +public [getNumFailedRuns](get-num-failed-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the number of failed runs + +#### Return + +long + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-non-empty-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-non-empty-runs.md index 0d6c433777..4695e39160 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-non-empty-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-non-empty-runs.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getNumNonEmptyRuns](get-num-non-empty-runs.md) - -# getNumNonEmptyRuns - - -public [getNumNonEmptyRuns](get-num-non-empty-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -check to see if the menu item is enabled (t/f) - -#### Return - -long - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumNonEmptyRuns + + +public [getNumNonEmptyRuns](get-num-non-empty-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +check to see if the menu item is enabled (t/f) + +#### Return + +long + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-runs.md index 58a41272b7..7f07e25668 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-runs.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getNumRuns](get-num-runs.md) - -# getNumRuns - - -public [getNumRuns](get-num-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the number of runs for the DataHistory - -#### Return - -long - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumRuns + + +public [getNumRuns](get-num-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the number of runs for the DataHistory + +#### Return + +long + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-variables.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-variables.md index ee3a1ae401..52ac32ef28 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-variables.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-variables.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getNumVariables](get-num-variables.md) - -# getNumVariables - - -public [getNumVariables](get-num-variables.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the number for variables - -#### Return - -long - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumVariables + + +public [getNumVariables](get-num-variables.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the number for variables + +#### Return + +long + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-run-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-run-name.md index cfe7fedbcd..424bdfe90a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-run-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-run-name.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getRunName](get-run-name.md) - -# getRunName - - -public [getRunName](get-run-name.md)(runNum: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the name of the given run in the DataHistory - -#### Return - -String - -#### Parameters - - - -| | | -|---|---| -| runNum | the number of the run to get the name of (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getRunName + + +public [getRunName](get-run-name.md)(runNum: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the name of the given run in the DataHistory + +#### Return + +String + +#### Parameters + + + +| | | +|---|---| +| runNum | the number of the run to get the name of (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-setting-run.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-setting-run.md index 61ffcfb0c1..19f6108695 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-setting-run.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-setting-run.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getSettingRun](get-setting-run.md) - -# getSettingRun - - -public [getSettingRun](get-setting-run.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the Setting Run - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getSettingRun + + +public [getSettingRun](get-setting-run.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the Setting Run + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-count-from.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-count-from.md index c15400dba3..9ba938da46 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-count-from.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-count-from.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getSuggestedCountFrom](get-suggested-count-from.md) - -# getSuggestedCountFrom - - -public [getSuggestedCountFrom](get-suggested-count-from.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the Suggested Count - -#### Return - -long - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getSuggestedCountFrom + + +public [getSuggestedCountFrom](get-suggested-count-from.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the Suggested Count + +#### Return + +long + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-dependent-vars.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-dependent-vars.md index 2dfac8a3f4..a6e1ba6d51 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-dependent-vars.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-dependent-vars.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getSuggestedDependentVars](get-suggested-dependent-vars.md) - -# getSuggestedDependentVars - - -public [getSuggestedDependentVars](get-suggested-dependent-vars.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -gets the Suggested Dependent Variables() - -#### Return - -Object - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getSuggestedDependentVars + + +public [getSuggestedDependentVars](get-suggested-dependent-vars.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +gets the Suggested Dependent Variables() + +#### Return + +Object + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-independant-var.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-independant-var.md index 4c7a19c5fd..4875208175 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-independant-var.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-independant-var.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getSuggestedIndependantVar](get-suggested-independant-var.md) - -# getSuggestedIndependantVar - - -public [getSuggestedIndependantVar](get-suggested-independant-var.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the Suggested Independent Variable - -#### Return - -String - -#### Deprecated - -(spelling) - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getSuggestedIndependantVar + + +public [getSuggestedIndependantVar](get-suggested-independant-var.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the Suggested Independent Variable + +#### Return + +String + +#### Deprecated + +(spelling) + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-independent-var.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-independent-var.md index 8c3ab53c83..f010e91163 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-independent-var.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-independent-var.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getSuggestedIndependentVar](get-suggested-independent-var.md) - -# getSuggestedIndependentVar - - -public [getSuggestedIndependentVar](get-suggested-independent-var.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the Suggested Independent Variable - -#### Return - -String - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getSuggestedIndependentVar + + +public [getSuggestedIndependentVar](get-suggested-independent-var.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the Suggested Independent Variable + +#### Return + +String + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-unique-i-d.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-unique-i-d.md index f69700253f..698e0e9053 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-unique-i-d.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-unique-i-d.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getUniqueID](get-unique-i-d.md) - -# getUniqueID - - -public [getUniqueID](get-unique-i-d.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the unique ID of the DataHistory - -#### Return - -long - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getUniqueID + + +public [getUniqueID](get-unique-i-d.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the unique ID of the DataHistory + +#### Return + +long + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-value.md index 9a5c12f8e3..434b960fe7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-value.md @@ -1,51 +1,49 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getValue](get-value.md) - -# getValue - - -public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -gets the value - -#### Return - -Object - -#### Parameters - - - -| | | -|---|---| -| index | the name of the variable to fetch the value of | -| run | the run of the run to fetch (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -gets the value - -#### Return - -Object - -#### Parameters - - - -| | | -|---|---| -| index | the index of the variable to fetch the value of (0-based index) | -| run | the run of the run to fetch (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValue + + +public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +gets the value + +#### Return + +Object + +#### Parameters + + + +| | | +|---|---| +| index | the name of the variable to fetch the value of | +| run | the run of the run to fetch (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +gets the value + +#### Return + +Object + +#### Parameters + + + +| | | +|---|---| +| index | the index of the variable to fetch the value of (0-based index) | +| run | the run of the run to fetch (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-variable-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-variable-values.md index 529b01578c..f32052c8f8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-variable-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-variable-values.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getVariableValues](get-variable-values.md) - -# getVariableValues - - -public [getVariableValues](get-variable-values.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> - -gets values of a variable for all runs - -#### Return - -Object - -#### Parameters - - - -| | | -|---|---| -| index | the name of the variable to fetch the value of | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getVariableValues](get-variable-values.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> - -gets values of a variable for all runs - -#### Return - -Object - -#### Parameters - - - -| | | -|---|---| -| index | the index of the variable to fetch the value of (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getVariableValues + + +public [getVariableValues](get-variable-values.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> + +gets values of a variable for all runs + +#### Return + +Object + +#### Parameters + + + +| | | +|---|---| +| index | the name of the variable to fetch the value of | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getVariableValues](get-variable-values.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> + +gets values of a variable for all runs + +#### Return + +Object + +#### Parameters + + + +| | | +|---|---| +| index | the index of the variable to fetch the value of (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-variable.md index 8e92bf0df9..906eb2f821 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/get-variable.md @@ -1,45 +1,43 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[getVariable](get-variable.md) - -# getVariable - - -public [getVariable](get-variable.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md) - -gets a variable - -#### Parameters - - - -| | | -|---|---| -| index | the index of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [DHVariable](../-d-h-variable/index.md) - -gets a variable - -#### Return - -Object - -#### Parameters - - - -| | | -|---|---| -| index | the index of the variable (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getVariable + + +public [getVariable](get-variable.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md) + +gets a variable + +#### Parameters + + + +| | | +|---|---| +| index | the index of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [DHVariable](../-d-h-variable/index.md) + +gets a variable + +#### Return + +Object + +#### Parameters + + + +| | | +|---|---| +| index | the index of the variable (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/highlight.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/highlight.md index e80a6878fd..b56d78aa28 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/highlight.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/highlight.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[highlight](highlight.md) - -# highlight - - -public [highlight](highlight.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), highlight: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), handleEvent: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -highlight or unhighlight a run - -#### Parameters - - - -| | | -|---|---| -| run | run ID (0-based index) | -| highlight | true to highlight, false to remove highlight | -| handleEvent | handle highlight event in the listener | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# highlight + + +public [highlight](highlight.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), highlight: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), handleEvent: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +highlight or unhighlight a run + +#### Parameters + + + +| | | +|---|---| +| run | run ID (0-based index) | +| highlight | true to highlight, false to remove highlight | +| handleEvent | handle highlight event in the listener | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/index.md index e8dacb6275..f5355b0b13 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/index.md @@ -1,85 +1,83 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md) - -# DataHistory - - -public class [DataHistory](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -This is the wrapper class that handles the native COM calls to a Data History. The class is used by Java plug-ins to ModelCenter. - -## Constructors - -| | | -|---|---| -| [DataHistory](-data-history.md) | constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Connects this Java object to the specified session of ModelCenter
constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Internal use only | - -## Functions - -| Name | Summary | -|---|---| -| [addVariable](add-variable.md) | public [addVariable](add-variable.md)(var: [DHVariable](../-d-h-variable/index.md))
adds variable var to DataHistory | -| [addVariableStructs](add-variable-structs.md) | public [addVariableStructs](add-variable-structs.md)(dhVarStructs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DataHistoryVariableStruct](../-data-history-variable-struct/index.md)>, run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Sets the results for a run. | -| [createVariable](create-variable.md) | public [createVariable](create-variable.md)(): [DHVariable](../-d-h-variable/index.md)
creates a variable | -| [deleteRun](delete-run.md) | public [deleteRun](delete-run.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
deletes a run | -| [deleteVariable](delete-variable.md) | public [deleteVariable](delete-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
public [deleteVariable](delete-variable.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
deletes a variable at the given index | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [endRuns](end-runs.md) | public [endRuns](end-runs.md)()
ends the runs | -| [fromXML](from-x-m-l.md) | public [fromXML](from-x-m-l.md)(xmlStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), root: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
from XML | -| [fromXMLFile](from-x-m-l-file.md) | public [fromXMLFile](from-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), root: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
from XML file | -| [getCenterLinkJobConnector](get-center-link-job-connector.md) | public [getCenterLinkJobConnector](get-center-link-job-connector.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
CenterLink is not supported by this version of ModelCenter. | -| [getCenterLinkQueue](get-center-link-queue.md) | public [getCenterLinkQueue](get-center-link-queue.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
CenterLink is not supported by this version of ModelCenter. | -| [getCenterLinkRunMatrixID](get-center-link-run-matrix-i-d.md) | public [getCenterLinkRunMatrixID](get-center-link-run-matrix-i-d.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
CenterLink is not supported by this version of ModelCenter. | -| [getCenterLinkServer](get-center-link-server.md) | public [getCenterLinkServer](get-center-link-server.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
CenterLink is not supported by this version of ModelCenter. | -| [getCompletedRunData](get-completed-run-data.md) | public [getCompletedRunData](get-completed-run-data.md)(startSequenceNumber: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), maxLength: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), allVariables: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [CompletedRunData](../-completed-run-data/index.md)
Gets information about the completed run data, including the runIDs, error IDs, error messages, and variable values. | -| [getDataExplorer](get-data-explorer.md) | public [getDataExplorer](get-data-explorer.md)(): [DataExplorer](../-data-explorer/index.md)
gets the DataExplorer --was IDispatch in COM | -| [getDataHistoryToModel](get-data-history-to-model.md) | public [getDataHistoryToModel](get-data-history-to-model.md)(): [IDataHistoryToModel](../-i-data-history-to-model/index.md)
Gets the dataHistoryToModel. | -| [getErrorID](get-error-i-d.md) | public [getErrorID](get-error-i-d.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
returns the ID of the Error that occured in the DataHistory | -| [getErrorMessage](get-error-message.md) | public [getErrorMessage](get-error-message.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
returns a string containing the error message for a given run | -| [getFormattedValue](get-formatted-value.md) | public [getFormattedValue](get-formatted-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFormattedValue](get-formatted-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets a value at the given index for a given run | -| [getHighlightedRuns](get-highlighted-runs.md) | public [getHighlightedRuns](get-highlighted-runs.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)>
Retrieve the set of currently highlighted run indices | -| [getNumCustomVars](get-num-custom-vars.md) | public [getNumCustomVars](get-num-custom-vars.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of custom variables | -| [getNumDesignVariables](get-num-design-variables.md) | public [getNumDesignVariables](get-num-design-variables.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of design variables | -| [getNumExpectedRuns](get-num-expected-runs.md) | public [getNumExpectedRuns](get-num-expected-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of expected runs | -| [getNumFailedRuns](get-num-failed-runs.md) | public [getNumFailedRuns](get-num-failed-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of failed runs | -| [getNumNonEmptyRuns](get-num-non-empty-runs.md) | public [getNumNonEmptyRuns](get-num-non-empty-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
check to see if the menu item is enabled (t/f) | -| [getNumRuns](get-num-runs.md) | public [getNumRuns](get-num-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of runs for the DataHistory | -| [getNumVariables](get-num-variables.md) | public [getNumVariables](get-num-variables.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number for variables | -| [getRunName](get-run-name.md) | public [getRunName](get-run-name.md)(runNum: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the given run in the DataHistory | -| [getSettingRun](get-setting-run.md) | public [getSettingRun](get-setting-run.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the Setting Run | -| [getSuggestedCountFrom](get-suggested-count-from.md) | public [getSuggestedCountFrom](get-suggested-count-from.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the Suggested Count | -| [getSuggestedDependentVars](get-suggested-dependent-vars.md) | public [getSuggestedDependentVars](get-suggested-dependent-vars.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
gets the Suggested Dependent Variables() | -| [getSuggestedIndependantVar](get-suggested-independant-var.md) | public [getSuggestedIndependantVar](get-suggested-independant-var.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the Suggested Independent Variable | -| [getSuggestedIndependentVar](get-suggested-independent-var.md) | public [getSuggestedIndependentVar](get-suggested-independent-var.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the Suggested Independent Variable | -| [getUniqueID](get-unique-i-d.md) | public [getUniqueID](get-unique-i-d.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the unique ID of the DataHistory | -| [getValue](get-value.md) | public [getValue](get-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
gets the value | -| [getVariable](get-variable.md) | public [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [DHVariable](../-d-h-variable/index.md)
public [getVariable](get-variable.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md)
gets a variable | -| [getVariableValues](get-variable-values.md) | public [getVariableValues](get-variable-values.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
public [getVariableValues](get-variable-values.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
gets values of a variable for all runs | -| [highlight](highlight.md) | public [highlight](highlight.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), highlight: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), handleEvent: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
highlight or unhighlight a run | -| [insertRun](insert-run.md) | public [insertRun](insert-run.md)(insertBefore: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
inserts a new run before a given index | -| [isHighlighted](is-highlighted.md) | public [isHighlighted](is-highlighted.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
check highlight state | -| [isModified](is-modified.md) | public [isModified](is-modified.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [isModified](is-modified.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks to see if the given object is midified | -| [isRunning](is-running.md) | public [isRunning](is-running.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
looks to see if the DataHistory is running | -| [isValid](is-valid.md) | public [isValid](is-valid.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [isValid](is-valid.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks for valididty of an object given an index and run | -| [newInstance](new-instance.md) | public [newInstance](new-instance.md)(): [DataHistory](index.md)
creates a new DataCollector object (that is connected to the same ModelCenter session) that is not currently attached to any thread. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setDataHistoryToModel](set-data-history-to-model.md) | public [setDataHistoryToModel](set-data-history-to-model.md)(dhtm: [IDataHistoryToModel](../-i-data-history-to-model/index.md))
Sets the Data History to Model object. | -| [setError](set-error.md) | public [setError](set-error.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), errorID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), message: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets an error for the given run, ID and message | -| [setFormattedResult](set-formatted-result.md) | public [setFormattedResult](set-formatted-result.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
public [setFormattedResult](set-formatted-result.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets a formatted result | -| [setHighlightedRuns](set-highlighted-runs.md) | public [setHighlightedRuns](set-highlighted-runs.md)(selectedRunIndices: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)>)
Specify the set of currently highlighted run indices. | -| [setNumExpectedRuns](set-num-expected-runs.md) | public [setNumExpectedRuns](set-num-expected-runs.md)(numRuns: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the number of expected runs | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setResult](set-result.md) | public [setResult](set-result.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
public [setResult](set-result.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the Result | -| [setRunName](set-run-name.md) | public [setRunName](set-run-name.md)(runNum: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the run name for a given run number | -| [setRunValues](set-run-values.md) | public [setRunValues](set-run-values.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets all values of a run as a single chunk. | -| [setSettingRun](set-setting-run.md) | public [setSettingRun](set-setting-run.md)(running: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the Setting Run | -| [setSuggestedCountFrom](set-suggested-count-from.md) | public [setSuggestedCountFrom](set-suggested-count-from.md)(count: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the Suggested Count | -| [setSuggestedDependentVars](set-suggested-dependent-vars.md) | public [setSuggestedDependentVars](set-suggested-dependent-vars.md)(var: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
sets the Suggested Dependent Varianble | -| [setSuggestedIndependantVar](set-suggested-independant-var.md) | public [setSuggestedIndependantVar](set-suggested-independant-var.md)(var: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Suggested Independent Variable | -| [setSuggestedIndependentVar](set-suggested-independent-var.md) | public [setSuggestedIndependentVar](set-suggested-independent-var.md)(var: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Suggested Independent Variable | -| [setVariableValues](set-variable-values.md) | public [setVariableValues](set-variable-values.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
public [setVariableValues](set-variable-values.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets all values of a variable as a chunk | -| [startRuns](start-runs.md) | public [startRuns](start-runs.md)()
starts the runs | -| [toCSV](to-c-s-v.md) | public [toCSV](to-c-s-v.md)(variablesInRows: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), includeFailed: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
to CSV | -| [toCSVFile](to-c-s-v-file.md) | public [toCSVFile](to-c-s-v-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), variablesInRows: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), includeFailed: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
to CSV File | -| [toXML](to-x-m-l.md) | public [toXML](to-x-m-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [toXML](to-x-m-l.md)(includeRunData: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
to XML | -| [toXMLFile](to-x-m-l-file.md) | public [toXMLFile](to-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [toXMLFile](to-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), includeRunData: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
save data history data as an XML file | +# DataHistory + + +public class [DataHistory](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +This is the wrapper class that handles the native COM calls to a Data History. The class is used by Java plug-ins to ModelCenter. + +## Constructors + +| | | +|---|---| +| [DataHistory](-data-history.md) | constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Connects this Java object to the specified session of ModelCenter
constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Internal use only | + +## Functions + +| Name | Summary | +|---|---| +| [addVariable](add-variable.md) | public [addVariable](add-variable.md)(var: [DHVariable](../-d-h-variable/index.md))
adds variable var to DataHistory | +| [addVariableStructs](add-variable-structs.md) | public [addVariableStructs](add-variable-structs.md)(dhVarStructs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DataHistoryVariableStruct](../-data-history-variable-struct/index.md)>, run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Sets the results for a run. | +| [createVariable](create-variable.md) | public [createVariable](create-variable.md)(): [DHVariable](../-d-h-variable/index.md)
creates a variable | +| [deleteRun](delete-run.md) | public [deleteRun](delete-run.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
deletes a run | +| [deleteVariable](delete-variable.md) | public [deleteVariable](delete-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
public [deleteVariable](delete-variable.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
deletes a variable at the given index | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [endRuns](end-runs.md) | public [endRuns](end-runs.md)()
ends the runs | +| [fromXML](from-x-m-l.md) | public [fromXML](from-x-m-l.md)(xmlStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), root: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
from XML | +| [fromXMLFile](from-x-m-l-file.md) | public [fromXMLFile](from-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), root: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
from XML file | +| [getCenterLinkJobConnector](get-center-link-job-connector.md) | public [getCenterLinkJobConnector](get-center-link-job-connector.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
CenterLink is not supported by this version of ModelCenter. | +| [getCenterLinkQueue](get-center-link-queue.md) | public [getCenterLinkQueue](get-center-link-queue.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
CenterLink is not supported by this version of ModelCenter. | +| [getCenterLinkRunMatrixID](get-center-link-run-matrix-i-d.md) | public [getCenterLinkRunMatrixID](get-center-link-run-matrix-i-d.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
CenterLink is not supported by this version of ModelCenter. | +| [getCenterLinkServer](get-center-link-server.md) | public [getCenterLinkServer](get-center-link-server.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
CenterLink is not supported by this version of ModelCenter. | +| [getCompletedRunData](get-completed-run-data.md) | public [getCompletedRunData](get-completed-run-data.md)(startSequenceNumber: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), maxLength: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), allVariables: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [CompletedRunData](../-completed-run-data/index.md)
Gets information about the completed run data, including the runIDs, error IDs, error messages, and variable values. | +| [getDataExplorer](get-data-explorer.md) | public [getDataExplorer](get-data-explorer.md)(): [DataExplorer](../-data-explorer/index.md)
gets the DataExplorer --was IDispatch in COM | +| [getDataHistoryToModel](get-data-history-to-model.md) | public [getDataHistoryToModel](get-data-history-to-model.md)(): [IDataHistoryToModel](../-i-data-history-to-model/index.md)
Gets the dataHistoryToModel. | +| [getErrorID](get-error-i-d.md) | public [getErrorID](get-error-i-d.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
returns the ID of the Error that occured in the DataHistory | +| [getErrorMessage](get-error-message.md) | public [getErrorMessage](get-error-message.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
returns a string containing the error message for a given run | +| [getFormattedValue](get-formatted-value.md) | public [getFormattedValue](get-formatted-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFormattedValue](get-formatted-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets a value at the given index for a given run | +| [getHighlightedRuns](get-highlighted-runs.md) | public [getHighlightedRuns](get-highlighted-runs.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)>
Retrieve the set of currently highlighted run indices | +| [getNumCustomVars](get-num-custom-vars.md) | public [getNumCustomVars](get-num-custom-vars.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of custom variables | +| [getNumDesignVariables](get-num-design-variables.md) | public [getNumDesignVariables](get-num-design-variables.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of design variables | +| [getNumExpectedRuns](get-num-expected-runs.md) | public [getNumExpectedRuns](get-num-expected-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of expected runs | +| [getNumFailedRuns](get-num-failed-runs.md) | public [getNumFailedRuns](get-num-failed-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of failed runs | +| [getNumNonEmptyRuns](get-num-non-empty-runs.md) | public [getNumNonEmptyRuns](get-num-non-empty-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
check to see if the menu item is enabled (t/f) | +| [getNumRuns](get-num-runs.md) | public [getNumRuns](get-num-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of runs for the DataHistory | +| [getNumVariables](get-num-variables.md) | public [getNumVariables](get-num-variables.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number for variables | +| [getRunName](get-run-name.md) | public [getRunName](get-run-name.md)(runNum: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the given run in the DataHistory | +| [getSettingRun](get-setting-run.md) | public [getSettingRun](get-setting-run.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the Setting Run | +| [getSuggestedCountFrom](get-suggested-count-from.md) | public [getSuggestedCountFrom](get-suggested-count-from.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the Suggested Count | +| [getSuggestedDependentVars](get-suggested-dependent-vars.md) | public [getSuggestedDependentVars](get-suggested-dependent-vars.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
gets the Suggested Dependent Variables() | +| [getSuggestedIndependantVar](get-suggested-independant-var.md) | public [getSuggestedIndependantVar](get-suggested-independant-var.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the Suggested Independent Variable | +| [getSuggestedIndependentVar](get-suggested-independent-var.md) | public [getSuggestedIndependentVar](get-suggested-independent-var.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the Suggested Independent Variable | +| [getUniqueID](get-unique-i-d.md) | public [getUniqueID](get-unique-i-d.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the unique ID of the DataHistory | +| [getValue](get-value.md) | public [getValue](get-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
gets the value | +| [getVariable](get-variable.md) | public [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [DHVariable](../-d-h-variable/index.md)
public [getVariable](get-variable.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md)
gets a variable | +| [getVariableValues](get-variable-values.md) | public [getVariableValues](get-variable-values.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
public [getVariableValues](get-variable-values.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
gets values of a variable for all runs | +| [highlight](highlight.md) | public [highlight](highlight.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), highlight: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), handleEvent: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
highlight or unhighlight a run | +| [insertRun](insert-run.md) | public [insertRun](insert-run.md)(insertBefore: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
inserts a new run before a given index | +| [isHighlighted](is-highlighted.md) | public [isHighlighted](is-highlighted.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
check highlight state | +| [isModified](is-modified.md) | public [isModified](is-modified.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [isModified](is-modified.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks to see if the given object is midified | +| [isRunning](is-running.md) | public [isRunning](is-running.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
looks to see if the DataHistory is running | +| [isValid](is-valid.md) | public [isValid](is-valid.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
public [isValid](is-valid.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks for valididty of an object given an index and run | +| [newInstance](new-instance.md) | public [newInstance](new-instance.md)(): [DataHistory](index.md)
creates a new DataCollector object (that is connected to the same ModelCenter session) that is not currently attached to any thread. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setDataHistoryToModel](set-data-history-to-model.md) | public [setDataHistoryToModel](set-data-history-to-model.md)(dhtm: [IDataHistoryToModel](../-i-data-history-to-model/index.md))
Sets the Data History to Model object. | +| [setError](set-error.md) | public [setError](set-error.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), errorID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), message: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets an error for the given run, ID and message | +| [setFormattedResult](set-formatted-result.md) | public [setFormattedResult](set-formatted-result.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
public [setFormattedResult](set-formatted-result.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets a formatted result | +| [setHighlightedRuns](set-highlighted-runs.md) | public [setHighlightedRuns](set-highlighted-runs.md)(selectedRunIndices: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)>)
Specify the set of currently highlighted run indices. | +| [setNumExpectedRuns](set-num-expected-runs.md) | public [setNumExpectedRuns](set-num-expected-runs.md)(numRuns: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the number of expected runs | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setResult](set-result.md) | public [setResult](set-result.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
public [setResult](set-result.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the Result | +| [setRunName](set-run-name.md) | public [setRunName](set-run-name.md)(runNum: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the run name for a given run number | +| [setRunValues](set-run-values.md) | public [setRunValues](set-run-values.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets all values of a run as a single chunk. | +| [setSettingRun](set-setting-run.md) | public [setSettingRun](set-setting-run.md)(running: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the Setting Run | +| [setSuggestedCountFrom](set-suggested-count-from.md) | public [setSuggestedCountFrom](set-suggested-count-from.md)(count: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the Suggested Count | +| [setSuggestedDependentVars](set-suggested-dependent-vars.md) | public [setSuggestedDependentVars](set-suggested-dependent-vars.md)(var: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
sets the Suggested Dependent Varianble | +| [setSuggestedIndependantVar](set-suggested-independant-var.md) | public [setSuggestedIndependantVar](set-suggested-independant-var.md)(var: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Suggested Independent Variable | +| [setSuggestedIndependentVar](set-suggested-independent-var.md) | public [setSuggestedIndependentVar](set-suggested-independent-var.md)(var: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the Suggested Independent Variable | +| [setVariableValues](set-variable-values.md) | public [setVariableValues](set-variable-values.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
public [setVariableValues](set-variable-values.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets all values of a variable as a chunk | +| [startRuns](start-runs.md) | public [startRuns](start-runs.md)()
starts the runs | +| [toCSV](to-c-s-v.md) | public [toCSV](to-c-s-v.md)(variablesInRows: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), includeFailed: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
to CSV | +| [toCSVFile](to-c-s-v-file.md) | public [toCSVFile](to-c-s-v-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), variablesInRows: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), includeFailed: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
to CSV File | +| [toXML](to-x-m-l.md) | public [toXML](to-x-m-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [toXML](to-x-m-l.md)(includeRunData: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
to XML | +| [toXMLFile](to-x-m-l-file.md) | public [toXMLFile](to-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [toXMLFile](to-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), includeRunData: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
save data history data as an XML file | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/insert-run.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/insert-run.md index bd47bed966..2bd0952954 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/insert-run.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/insert-run.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[insertRun](insert-run.md) - -# insertRun - - -public [insertRun](insert-run.md)(insertBefore: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -inserts a new run before a given index - -#### Parameters - - - -| | | -|---|---| -| insertBefore | the index to insert the new run before (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# insertRun + + +public [insertRun](insert-run.md)(insertBefore: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +inserts a new run before a given index + +#### Parameters + + + +| | | +|---|---| +| insertBefore | the index to insert the new run before (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/is-highlighted.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/is-highlighted.md index 9225053f6f..d8fb0c5885 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/is-highlighted.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/is-highlighted.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[isHighlighted](is-highlighted.md) - -# isHighlighted - - -public [isHighlighted](is-highlighted.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -check highlight state - -#### Return - -true if highlighted, false otherwise - -#### Parameters - - - -| | | -|---|---| -| run | run ID (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isHighlighted + + +public [isHighlighted](is-highlighted.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +check highlight state + +#### Return + +true if highlighted, false otherwise + +#### Parameters + + + +| | | +|---|---| +| run | run ID (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/is-modified.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/is-modified.md index def86c57fc..e27bc07946 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/is-modified.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/is-modified.md @@ -1,29 +1,27 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[isModified](is-modified.md) - -# isModified - - -public [isModified](is-modified.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -public [isModified](is-modified.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -checks to see if the given object is midified - -#### Return - -true or false - -#### Parameters - - - -| | | -|---|---| -| index | the name of the variable to check | -| run | the run of the run to check (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isModified + + +public [isModified](is-modified.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +public [isModified](is-modified.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +checks to see if the given object is midified + +#### Return + +true or false + +#### Parameters + + + +| | | +|---|---| +| index | the name of the variable to check | +| run | the run of the run to check (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/is-running.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/is-running.md index 768c1ff1d4..acaa22001a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/is-running.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/is-running.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[isRunning](is-running.md) - -# isRunning - - -public [isRunning](is-running.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -looks to see if the DataHistory is running - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isRunning + + +public [isRunning](is-running.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +looks to see if the DataHistory is running + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/is-valid.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/is-valid.md index fb94d4de98..dd5f3c577f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/is-valid.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/is-valid.md @@ -1,51 +1,49 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[isValid](is-valid.md) - -# isValid - - -public [isValid](is-valid.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -checks for valididty of an object given an index and run - -#### Return - -true or false - -#### Parameters - - - -| | | -|---|---| -| index | the name of the variable to check | -| run | the run of the run to check (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [isValid](is-valid.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -checks for valididty of an object given an index and run - -#### Return - -true or false - -#### Parameters - - - -| | | -|---|---| -| index | the index of the variable to check (0-based index) | -| run | the run of the run to check (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isValid + + +public [isValid](is-valid.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +checks for valididty of an object given an index and run + +#### Return + +true or false + +#### Parameters + + + +| | | +|---|---| +| index | the name of the variable to check | +| run | the run of the run to check (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [isValid](is-valid.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +checks for valididty of an object given an index and run + +#### Return + +true or false + +#### Parameters + + + +| | | +|---|---| +| index | the index of the variable to check (0-based index) | +| run | the run of the run to check (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/new-instance.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/new-instance.md index 5cec88790c..f6718baaa8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/new-instance.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/new-instance.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[newInstance](new-instance.md) - -# newInstance - - -public [newInstance](new-instance.md)(): [DataHistory](index.md) - -creates a new DataCollector object (that is connected to the same ModelCenter session) that is not currently attached to any thread. Use this method if you need to call DataCollector from multiple threads. The spawning thread should call this function for each thread that needs to call DataCollector. The new instance should be passed to the spawned thread and used there. - -#### Return - -a DataCollector instance that is not attached to any thread - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# newInstance + + +public [newInstance](new-instance.md)(): [DataHistory](index.md) + +creates a new DataCollector object (that is connected to the same ModelCenter session) that is not currently attached to any thread. Use this method if you need to call DataCollector from multiple threads. The spawning thread should call this function for each thread that needs to call DataCollector. The new instance should be passed to the spawned thread and used there. + +#### Return + +a DataCollector instance that is not attached to any thread + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-data-history-to-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-data-history-to-model.md index 9a8c70f5ac..abcf2a12bb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-data-history-to-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-data-history-to-model.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[setDataHistoryToModel](set-data-history-to-model.md) - -# setDataHistoryToModel - - -public [setDataHistoryToModel](set-data-history-to-model.md)(dhtm: [IDataHistoryToModel](../-i-data-history-to-model/index.md)) - -Sets the Data History to Model object. See IDataHistoryToModel for more information. +# setDataHistoryToModel + + +public [setDataHistoryToModel](set-data-history-to-model.md)(dhtm: [IDataHistoryToModel](../-i-data-history-to-model/index.md)) + +Sets the Data History to Model object. See IDataHistoryToModel for more information. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-error.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-error.md index ea625e6b2d..6a709e6549 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-error.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-error.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[setError](set-error.md) - -# setError - - -public [setError](set-error.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), errorID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), message: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets an error for the given run, ID and message - -#### Parameters - - - -| | | -|---|---| -| run | the run of the DataHistory to set the error for (0-based index) | -| errorID | the ID of the error to set | -| message | the message given for the error | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setError + + +public [setError](set-error.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), errorID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), message: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets an error for the given run, ID and message + +#### Parameters + + + +| | | +|---|---| +| run | the run of the DataHistory to set the error for (0-based index) | +| errorID | the ID of the error to set | +| message | the message given for the error | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-formatted-result.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-formatted-result.md index c4ae4f46ce..b80875a2d4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-formatted-result.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-formatted-result.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[setFormattedResult](set-formatted-result.md) - -# setFormattedResult - - -public [setFormattedResult](set-formatted-result.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets a formatted result - -#### Parameters - - - -| | -|---| -| index | -| run | (0-based index) | -| value | -| valid | -| modified | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setFormattedResult](set-formatted-result.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets a formatted result - -#### Parameters - - - -| | | -|---|---| -| index | (0-based index) | -| run | (0-based index) | -| value | -| valid | -| modified | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setFormattedResult + + +public [setFormattedResult](set-formatted-result.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets a formatted result + +#### Parameters + + + +| | +|---| +| index | +| run | (0-based index) | +| value | +| valid | +| modified | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setFormattedResult](set-formatted-result.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets a formatted result + +#### Parameters + + + +| | | +|---|---| +| index | (0-based index) | +| run | (0-based index) | +| value | +| valid | +| modified | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-highlighted-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-highlighted-runs.md index 42d91418d9..2920e87f51 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-highlighted-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-highlighted-runs.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[setHighlightedRuns](set-highlighted-runs.md) - -# setHighlightedRuns - - -public [setHighlightedRuns](set-highlighted-runs.md)(selectedRunIndices: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)>) - -Specify the set of currently highlighted run indices. Note: This will overwrite the existing highlighted runs. - -#### Parameters - - - -| | | -|---|---| -| selectedRunIndices | the set of run indices to highlight, specified by either a single integer, numeric string, array of integers, or array of numeric strings. Specifying an empty or null value will remove all highlighted run indices. | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if something goes wrong setting the highlighted runs | +# setHighlightedRuns + + +public [setHighlightedRuns](set-highlighted-runs.md)(selectedRunIndices: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)>) + +Specify the set of currently highlighted run indices. Note: This will overwrite the existing highlighted runs. + +#### Parameters + + + +| | | +|---|---| +| selectedRunIndices | the set of run indices to highlight, specified by either a single integer, numeric string, array of integers, or array of numeric strings. Specifying an empty or null value will remove all highlighted run indices. | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if something goes wrong setting the highlighted runs | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-num-expected-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-num-expected-runs.md index 0c6faa3e65..cec20015b4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-num-expected-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-num-expected-runs.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[setNumExpectedRuns](set-num-expected-runs.md) - -# setNumExpectedRuns - - -public [setNumExpectedRuns](set-num-expected-runs.md)(numRuns: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the number of expected runs - -#### Parameters - - - -| | | -|---|---| -| numRuns | the number of expected runs to set | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setNumExpectedRuns + + +public [setNumExpectedRuns](set-num-expected-runs.md)(numRuns: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the number of expected runs + +#### Parameters + + + +| | | +|---|---| +| numRuns | the number of expected runs to set | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-result.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-result.md index b874c8ee48..5ef8de1586 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-result.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-result.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[setResult](set-result.md) - -# setResult - - -public [setResult](set-result.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets the Result - -#### Parameters - - - -| | -|---| -| index | -| run | (0-based index) | -| value | -| valid | -| modified | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setResult](set-result.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets the Result - -#### Parameters - - - -| | | -|---|---| -| index | (0-based index) | -| run | (0-based index) | -| value | -| valid | -| modified | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setResult + + +public [setResult](set-result.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets the Result + +#### Parameters + + + +| | +|---| +| index | +| run | (0-based index) | +| value | +| valid | +| modified | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setResult](set-result.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets the Result + +#### Parameters + + + +| | | +|---|---| +| index | (0-based index) | +| run | (0-based index) | +| value | +| valid | +| modified | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-run-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-run-name.md index fb9accbe45..86437bb832 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-run-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-run-name.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[setRunName](set-run-name.md) - -# setRunName - - -public [setRunName](set-run-name.md)(runNum: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the run name for a given run number - -#### Parameters - - - -| | | -|---|---| -| runNum | the number of the run to set the name for (0-based index) | -| name | the name to give the given run | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setRunName + + +public [setRunName](set-run-name.md)(runNum: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the run name for a given run number + +#### Parameters + + + +| | | +|---|---| +| runNum | the number of the run to set the name for (0-based index) | +| name | the name to give the given run | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-run-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-run-values.md index 025c829f2e..10eb7c6557 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-run-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-run-values.md @@ -1,25 +1,23 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[setRunValues](set-run-values.md) - -# setRunValues - - -public [setRunValues](set-run-values.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets all values of a run as a single chunk. - -#### Parameters - - - -| | | -|---|---| -| run | the run id | -| values | values to set | -| valid | validity flag of the value | -| modified | modify flag of the value | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setRunValues + + +public [setRunValues](set-run-values.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets all values of a run as a single chunk. + +#### Parameters + + + +| | | +|---|---| +| run | the run id | +| values | values to set | +| valid | validity flag of the value | +| modified | modify flag of the value | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-setting-run.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-setting-run.md index 045e1d93fb..c1138d3015 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-setting-run.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-setting-run.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[setSettingRun](set-setting-run.md) - -# setSettingRun - - -public [setSettingRun](set-setting-run.md)(running: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets the Setting Run - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setSettingRun + + +public [setSettingRun](set-setting-run.md)(running: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets the Setting Run + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-count-from.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-count-from.md index bc37c57c09..032c652708 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-count-from.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-count-from.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[setSuggestedCountFrom](set-suggested-count-from.md) - -# setSuggestedCountFrom - - -public [setSuggestedCountFrom](set-suggested-count-from.md)(count: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the Suggested Count - -#### Parameters - - - -| | -|---| -| count | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setSuggestedCountFrom + + +public [setSuggestedCountFrom](set-suggested-count-from.md)(count: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the Suggested Count + +#### Parameters + + + +| | +|---| +| count | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-dependent-vars.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-dependent-vars.md index d062221607..4452601900 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-dependent-vars.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-dependent-vars.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[setSuggestedDependentVars](set-suggested-dependent-vars.md) - -# setSuggestedDependentVars - - -public [setSuggestedDependentVars](set-suggested-dependent-vars.md)(var: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)) - -sets the Suggested Dependent Varianble - -#### Parameters - - - -| | | -|---|---| -| var | the dependant variable to set | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setSuggestedDependentVars + + +public [setSuggestedDependentVars](set-suggested-dependent-vars.md)(var: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)) + +sets the Suggested Dependent Varianble + +#### Parameters + + + +| | | +|---|---| +| var | the dependant variable to set | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-independant-var.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-independant-var.md index 4a469189c9..b79e2cbb33 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-independant-var.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-independant-var.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[setSuggestedIndependantVar](set-suggested-independant-var.md) - -# setSuggestedIndependantVar - - -public [setSuggestedIndependantVar](set-suggested-independant-var.md)(var: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the Suggested Independent Variable - -#### Deprecated - -(spelling) - -#### Parameters - - - -| | | -|---|---| -| var | the independant variable to set | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setSuggestedIndependantVar + + +public [setSuggestedIndependantVar](set-suggested-independant-var.md)(var: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the Suggested Independent Variable + +#### Deprecated + +(spelling) + +#### Parameters + + + +| | | +|---|---| +| var | the independant variable to set | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-independent-var.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-independent-var.md index a8c3d83d59..dec81f5531 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-independent-var.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-independent-var.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[setSuggestedIndependentVar](set-suggested-independent-var.md) - -# setSuggestedIndependentVar - - -public [setSuggestedIndependentVar](set-suggested-independent-var.md)(var: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the Suggested Independent Variable - -#### Parameters - - - -| | | -|---|---| -| var | the independent variable to set | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setSuggestedIndependentVar + + +public [setSuggestedIndependentVar](set-suggested-independent-var.md)(var: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the Suggested Independent Variable + +#### Parameters + + + +| | | +|---|---| +| var | the independent variable to set | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-variable-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-variable-values.md index ac531fcbe4..7bdc9f3c6f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-variable-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/set-variable-values.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[setVariableValues](set-variable-values.md) - -# setVariableValues - - -public [setVariableValues](set-variable-values.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets all values of a variable as a chunk - -#### Parameters - - - -| | | -|---|---| -| index | variable name or index | -| run | starting run id | -| values | values to set | -| valid | validity flag of the value | -| modified | modify flag of the value | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setVariableValues](set-variable-values.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets all values of a variable as a chunk - -#### Parameters - - - -| | | -|---|---| -| index | (0-based index) | -| run | starting run id | -| values | values to set | -| valid | validity flag of the value | -| modified | modify flag of the value | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setVariableValues + + +public [setVariableValues](set-variable-values.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets all values of a variable as a chunk + +#### Parameters + + + +| | | +|---|---| +| index | variable name or index | +| run | starting run id | +| values | values to set | +| valid | validity flag of the value | +| modified | modify flag of the value | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setVariableValues](set-variable-values.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), modified: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets all values of a variable as a chunk + +#### Parameters + + + +| | | +|---|---| +| index | (0-based index) | +| run | starting run id | +| values | values to set | +| valid | validity flag of the value | +| modified | modify flag of the value | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/start-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/start-runs.md index db1c187bbc..d3aef8b228 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/start-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/start-runs.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[startRuns](start-runs.md) - -# startRuns - - -public [startRuns](start-runs.md)() - -starts the runs - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# startRuns + + +public [startRuns](start-runs.md)() + +starts the runs + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/to-c-s-v-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/to-c-s-v-file.md index ba63c19e50..3fdf6e091c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/to-c-s-v-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/to-c-s-v-file.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[toCSVFile](to-c-s-v-file.md) - -# toCSVFile - - -public [toCSVFile](to-c-s-v-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), variablesInRows: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), includeFailed: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -to CSV File - -#### Parameters - - - -| | -|---| -| fileName | -| variablesInRows | (was [optional] Variant) | -| includeFailed | (was [optional] Variant) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toCSVFile + + +public [toCSVFile](to-c-s-v-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), variablesInRows: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), includeFailed: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +to CSV File + +#### Parameters + + + +| | +|---| +| fileName | +| variablesInRows | (was [optional] Variant) | +| includeFailed | (was [optional] Variant) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/to-c-s-v.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/to-c-s-v.md index 2624e26970..68eda7175c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/to-c-s-v.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/to-c-s-v.md @@ -1,27 +1,25 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[toCSV](to-c-s-v.md) - -# toCSV - - -public [toCSV](to-c-s-v.md)(variablesInRows: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), includeFailed: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -to CSV - -#### Return - -String - -#### Parameters - - - -| | | -|---|---| -| variablesInRows | (was [optional] Variant) | -| includeFailed | (was [optional] Variant) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toCSV + + +public [toCSV](to-c-s-v.md)(variablesInRows: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), includeFailed: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +to CSV + +#### Return + +String + +#### Parameters + + + +| | | +|---|---| +| variablesInRows | (was [optional] Variant) | +| includeFailed | (was [optional] Variant) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/to-x-m-l-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/to-x-m-l-file.md index cf26a41f24..d01725b8b6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/to-x-m-l-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/to-x-m-l-file.md @@ -1,42 +1,40 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[toXMLFile](to-x-m-l-file.md) - -# toXMLFile - - -public [toXMLFile](to-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -save data history data as an XML file - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to turn into an XML file in String format | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [toXMLFile](to-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), includeRunData: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -save data history data as an XML file - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to turn into an XML file in String format | -| includeRunData | whether or not to include run data into the XML | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toXMLFile + + +public [toXMLFile](to-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +save data history data as an XML file + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to turn into an XML file in String format | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [toXMLFile](to-x-m-l-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), includeRunData: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +save data history data as an XML file + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to turn into an XML file in String format | +| includeRunData | whether or not to include run data into the XML | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/to-x-m-l.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/to-x-m-l.md index 53a58cca66..0ff09e08c5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/to-x-m-l.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-history/to-x-m-l.md @@ -1,41 +1,39 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataHistory](index.md)/[toXML](to-x-m-l.md) - -# toXML - - -public [toXML](to-x-m-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -to XML - -#### Return - -String - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [toXML](to-x-m-l.md)(includeRunData: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -to XML - -#### Return - -String - -#### Parameters - - - -| | | -|---|---| -| includeRunData | whether or not to include run data into the XML | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toXML + + +public [toXML](to-x-m-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +to XML + +#### Return + +String + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [toXML](to-x-m-l.md)(includeRunData: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +to XML + +#### Return + +String + +#### Parameters + + + +| | | +|---|---| +| includeRunData | whether or not to include run data into the XML | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/add-item.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/add-item.md index e9462fcd3c..83418a2d85 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/add-item.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/add-item.md @@ -1,21 +1,19 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[addItem](add-item.md) - -# addItem - - -public [addItem](add-item.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), link: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -*************************************************************************** adds a new entry to the monitor with the given name and link - -#### Return - -returns -1 if the linking failed and the entry was not added or the index of the entry if it was successfully added and linked - -#### Parameters - - - -| | | -|---|---| -| name | the name of the entry | -| link | the full name of the item to which the entry will be linked | +# addItem + + +public [addItem](add-item.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), link: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +*************************************************************************** adds a new entry to the monitor with the given name and link + +#### Return + +returns -1 if the linking failed and the entry was not added or the index of the entry if it was successfully added and linked + +#### Parameters + + + +| | | +|---|---| +| name | the name of the entry | +| link | the full name of the item to which the entry will be linked | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/add-unlinked-item.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/add-unlinked-item.md index 2f080ffe7d..d1d35e1756 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/add-unlinked-item.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/add-unlinked-item.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[addUnlinkedItem](add-unlinked-item.md) - -# addUnlinkedItem - - -public [addUnlinkedItem](add-unlinked-item.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -*************************************************************************** adds a new entry to the monitor with the given name, but without any link - -#### Return - -the index of the entry that's been added - -#### Parameters - - - -| | | -|---|---| -| name | the name of the entry | +# addUnlinkedItem + + +public [addUnlinkedItem](add-unlinked-item.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +*************************************************************************** adds a new entry to the monitor with the given name, but without any link + +#### Return + +the index of the entry that's been added + +#### Parameters + + + +| | | +|---|---| +| name | the name of the entry | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-auto-delete.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-auto-delete.md index 36e75ea785..19e958f401 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-auto-delete.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-auto-delete.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[getAutoDelete](get-auto-delete.md) - -# getAutoDelete - - -public [getAutoDelete](get-auto-delete.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -*************************************************************************** indicates if units should be displayed - -#### Return - -true or false +# getAutoDelete + + +public [getAutoDelete](get-auto-delete.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +*************************************************************************** indicates if units should be displayed + +#### Return + +true or false diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-col-width.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-col-width.md index 2220537252..05396f4610 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-col-width.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-col-width.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[getColWidth](get-col-width.md) - -# getColWidth - - -public [getColWidth](get-col-width.md)(col: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -*************************************************************************** gets the width of a column - -#### Parameters - - - -| | | -|---|---| -| col | the index of the column whose width is being retrieved (0-based index) | +# getColWidth + + +public [getColWidth](get-col-width.md)(col: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +*************************************************************************** gets the width of a column + +#### Parameters + + + +| | | +|---|---| +| col | the index of the column whose width is being retrieved (0-based index) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-display-full-names.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-display-full-names.md index b8b9fed861..317e38f9c3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-display-full-names.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-display-full-names.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[getDisplayFullNames](get-display-full-names.md) - -# getDisplayFullNames - - -public [getDisplayFullNames](get-display-full-names.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -*************************************************************************** indicates if full variables names should be displayed (vs short names) - -#### Return - -true or false +# getDisplayFullNames + + +public [getDisplayFullNames](get-display-full-names.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +*************************************************************************** indicates if full variables names should be displayed (vs short names) + +#### Return + +true or false diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-display-units.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-display-units.md index 8bf8087ee8..e267940bdc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-display-units.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-display-units.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[getDisplayUnits](get-display-units.md) - -# getDisplayUnits - - -public [getDisplayUnits](get-display-units.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -*************************************************************************** indicates if units should be displayed - -#### Return - -true or false +# getDisplayUnits + + +public [getDisplayUnits](get-display-units.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +*************************************************************************** indicates if units should be displayed + +#### Return + +true or false diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-height.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-height.md index 5c7b1bee61..92d648d31e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-height.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-height.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[getHeight](get-height.md) - -# getHeight - - -public [getHeight](get-height.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) +# getHeight + + +public [getHeight](get-height.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-link.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-link.md index 1eca85e0a1..a18c11e70a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-link.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-link.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[getLink](get-link.md) - -# getLink - - -public [getLink](get-link.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -*************************************************************************** retrieves the full name of an entry's link - -#### Return - -a string containing the full name of the item to which the entry is linked - -#### Parameters - - - -| | | -|---|---| -| row | the index of the entry to check (0-based index) | +# getLink + + +public [getLink](get-link.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +*************************************************************************** retrieves the full name of an entry's link + +#### Return + +a string containing the full name of the item to which the entry is linked + +#### Parameters + + + +| | | +|---|---| +| row | the index of the entry to check (0-based index) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-name.md index cffe5f4fdd..44ef096973 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-name.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[getName](get-name.md) - -# getName - - -public [getName](get-name.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -*************************************************************************** retrieves the name of the given entry - -#### Return - -name the new name of the entry - -#### Parameters - - - -| | | -|---|---| -| row | the index of the entry to retrieve (0-based index) | +# getName + + +public [getName](get-name.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +*************************************************************************** retrieves the name of the given entry + +#### Return + +name the new name of the entry + +#### Parameters + + + +| | | +|---|---| +| row | the index of the entry to retrieve (0-based index) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-title.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-title.md index 773884031a..98a58537ee 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-title.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-title.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[getTitle](get-title.md) - -# getTitle - - -public [getTitle](get-title.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) +# getTitle + + +public [getTitle](get-title.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-width.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-width.md index 7f0082069f..55129e7730 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-width.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-width.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[getWidth](get-width.md) - -# getWidth - - -public [getWidth](get-width.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) +# getWidth + + +public [getWidth](get-width.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-x.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-x.md index ef005896c3..acddd05b37 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-x.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-x.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[getX](get-x.md) - -# getX - - -public [getX](get-x.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) +# getX + + +public [getX](get-x.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-y.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-y.md index 7702f09396..6c2813114b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-y.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-y.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[getY](get-y.md) - -# getY - - -public [getY](get-y.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) +# getY + + +public [getY](get-y.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/index.md index 237ee07a1e..151db1e38f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/index.md @@ -1,41 +1,39 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md) - -# DataMonitor - - -public class [DataMonitor](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -## Functions - -| Name | Summary | -|---|---| -| [addItem](add-item.md) | public [addItem](add-item.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), link: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
*************************************************************************** adds a new entry to the monitor with the given name and link | -| [addUnlinkedItem](add-unlinked-item.md) | public [addUnlinkedItem](add-unlinked-item.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
*************************************************************************** adds a new entry to the monitor with the given name, but without any link | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [getAutoDelete](get-auto-delete.md) | public [getAutoDelete](get-auto-delete.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
*************************************************************************** indicates if units should be displayed | -| [getColWidth](get-col-width.md) | public [getColWidth](get-col-width.md)(col: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
*************************************************************************** gets the width of a column | -| [getDisplayFullNames](get-display-full-names.md) | public [getDisplayFullNames](get-display-full-names.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
*************************************************************************** indicates if full variables names should be displayed (vs short names) | -| [getDisplayUnits](get-display-units.md) | public [getDisplayUnits](get-display-units.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
*************************************************************************** indicates if units should be displayed | -| [getHeight](get-height.md) | public [getHeight](get-height.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | -| [getLink](get-link.md) | public [getLink](get-link.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
*************************************************************************** retrieves the full name of an entry's link | -| [getName](get-name.md) | public [getName](get-name.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
*************************************************************************** retrieves the name of the given entry | -| [getTitle](get-title.md) | public [getTitle](get-title.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | -| [getWidth](get-width.md) | public [getWidth](get-width.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | -| [getX](get-x.md) | public [getX](get-x.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | -| [getY](get-y.md) | public [getY](get-y.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | -| [isRenamed](is-renamed.md) | public [isRenamed](is-renamed.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
*************************************************************************** checks whether a given entry has been renamed/aliased | -| [isValid](is-valid.md) | public [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [removeItem](remove-item.md) | public [removeItem](remove-item.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
*************************************************************************** removes the given item from the monitor | -| [removeLink](remove-link.md) | public [removeLink](remove-link.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
*************************************************************************** removes the link of the entry at the given position | -| [setAutoDelete](set-auto-delete.md) | public [setAutoDelete](set-auto-delete.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
*************************************************************************** causes the grid to automatically remove monitored data items | -| [setColWidth](set-col-width.md) | public [setColWidth](set-col-width.md)(col: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), width: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
*************************************************************************** sets the width of a column | -| [setDisplayFullNames](set-display-full-names.md) | public [setDisplayFullNames](set-display-full-names.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
*************************************************************************** causes the grid to display full or short variable names | -| [setDisplayUnits](set-display-units.md) | public [setDisplayUnits](set-display-units.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
*************************************************************************** causes the grid to display units or not display units | -| [setLink](set-link.md) | public [setLink](set-link.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), link: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
*************************************************************************** assigns a link to an entry | -| [setLocation](set-location.md) | public [setLocation](set-location.md)(x: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), y: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) | -| [setName](set-name.md) | public [setName](set-name.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
*************************************************************************** sets the name of the given entry | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setSize](set-size.md) | public [setSize](set-size.md)(width: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), height: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) | -| [setTitle](set-title.md) | public [setTitle](set-title.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) | +# DataMonitor + + +public class [DataMonitor](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +## Functions + +| Name | Summary | +|---|---| +| [addItem](add-item.md) | public [addItem](add-item.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), link: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
*************************************************************************** adds a new entry to the monitor with the given name and link | +| [addUnlinkedItem](add-unlinked-item.md) | public [addUnlinkedItem](add-unlinked-item.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
*************************************************************************** adds a new entry to the monitor with the given name, but without any link | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [getAutoDelete](get-auto-delete.md) | public [getAutoDelete](get-auto-delete.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
*************************************************************************** indicates if units should be displayed | +| [getColWidth](get-col-width.md) | public [getColWidth](get-col-width.md)(col: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
*************************************************************************** gets the width of a column | +| [getDisplayFullNames](get-display-full-names.md) | public [getDisplayFullNames](get-display-full-names.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
*************************************************************************** indicates if full variables names should be displayed (vs short names) | +| [getDisplayUnits](get-display-units.md) | public [getDisplayUnits](get-display-units.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
*************************************************************************** indicates if units should be displayed | +| [getHeight](get-height.md) | public [getHeight](get-height.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [getLink](get-link.md) | public [getLink](get-link.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
*************************************************************************** retrieves the full name of an entry's link | +| [getName](get-name.md) | public [getName](get-name.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
*************************************************************************** retrieves the name of the given entry | +| [getTitle](get-title.md) | public [getTitle](get-title.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | +| [getWidth](get-width.md) | public [getWidth](get-width.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [getX](get-x.md) | public [getX](get-x.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [getY](get-y.md) | public [getY](get-y.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [isRenamed](is-renamed.md) | public [isRenamed](is-renamed.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
*************************************************************************** checks whether a given entry has been renamed/aliased | +| [isValid](is-valid.md) | public [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [removeItem](remove-item.md) | public [removeItem](remove-item.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
*************************************************************************** removes the given item from the monitor | +| [removeLink](remove-link.md) | public [removeLink](remove-link.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
*************************************************************************** removes the link of the entry at the given position | +| [setAutoDelete](set-auto-delete.md) | public [setAutoDelete](set-auto-delete.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
*************************************************************************** causes the grid to automatically remove monitored data items | +| [setColWidth](set-col-width.md) | public [setColWidth](set-col-width.md)(col: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), width: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
*************************************************************************** sets the width of a column | +| [setDisplayFullNames](set-display-full-names.md) | public [setDisplayFullNames](set-display-full-names.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
*************************************************************************** causes the grid to display full or short variable names | +| [setDisplayUnits](set-display-units.md) | public [setDisplayUnits](set-display-units.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
*************************************************************************** causes the grid to display units or not display units | +| [setLink](set-link.md) | public [setLink](set-link.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), link: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
*************************************************************************** assigns a link to an entry | +| [setLocation](set-location.md) | public [setLocation](set-location.md)(x: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), y: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) | +| [setName](set-name.md) | public [setName](set-name.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
*************************************************************************** sets the name of the given entry | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setSize](set-size.md) | public [setSize](set-size.md)(width: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), height: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) | +| [setTitle](set-title.md) | public [setTitle](set-title.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/is-renamed.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/is-renamed.md index 865a03dd51..5109cdabfc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/is-renamed.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/is-renamed.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[isRenamed](is-renamed.md) - -# isRenamed - - -public [isRenamed](is-renamed.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -*************************************************************************** checks whether a given entry has been renamed/aliased - -#### Return - -whether the given entry has an alias - -#### Parameters - - - -| | | -|---|---| -| row | the index of the entry to check (0-based index) | +# isRenamed + + +public [isRenamed](is-renamed.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +*************************************************************************** checks whether a given entry has been renamed/aliased + +#### Return + +whether the given entry has an alias + +#### Parameters + + + +| | | +|---|---| +| row | the index of the entry to check (0-based index) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/is-valid.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/is-valid.md index 478958aaf2..f51d03377f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/is-valid.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/is-valid.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[isValid](is-valid.md) - -# isValid - - -public [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) +# isValid + + +public [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/remove-item.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/remove-item.md index c001bd1325..f3103054c7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/remove-item.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/remove-item.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[removeItem](remove-item.md) - -# removeItem - - -public [removeItem](remove-item.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -*************************************************************************** removes the given item from the monitor - -#### Parameters - - - -| | | -|---|---| -| row | the index of the entry (0-based index) | +# removeItem + + +public [removeItem](remove-item.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +*************************************************************************** removes the given item from the monitor + +#### Parameters + + + +| | | +|---|---| +| row | the index of the entry (0-based index) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/remove-link.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/remove-link.md index 965ae18848..3ac537b49a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/remove-link.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/remove-link.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[removeLink](remove-link.md) - -# removeLink - - -public [removeLink](remove-link.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -*************************************************************************** removes the link of the entry at the given position - -#### Parameters - - - -| | | -|---|---| -| row | the index of the given entry whose link is to be removed (0-based index) | +# removeLink + + +public [removeLink](remove-link.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +*************************************************************************** removes the link of the entry at the given position + +#### Parameters + + + +| | | +|---|---| +| row | the index of the given entry whose link is to be removed (0-based index) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-auto-delete.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-auto-delete.md index 696b8d9523..c46fecacdf 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-auto-delete.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-auto-delete.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[setAutoDelete](set-auto-delete.md) - -# setAutoDelete - - -public [setAutoDelete](set-auto-delete.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -*************************************************************************** causes the grid to automatically remove monitored data items - -#### Parameters - - - -| | | -|---|---| -| flag | true to auto delete | +# setAutoDelete + + +public [setAutoDelete](set-auto-delete.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +*************************************************************************** causes the grid to automatically remove monitored data items + +#### Parameters + + + +| | | +|---|---| +| flag | true to auto delete | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-col-width.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-col-width.md index 1a096390f4..ca4b5bbe72 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-col-width.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-col-width.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[setColWidth](set-col-width.md) - -# setColWidth - - -public [setColWidth](set-col-width.md)(col: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), width: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -*************************************************************************** sets the width of a column - -#### Parameters - - - -| | | -|---|---| -| col | the index of the column whose width is being set (0-based index) | -| width | the new width of the column | +# setColWidth + + +public [setColWidth](set-col-width.md)(col: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), width: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +*************************************************************************** sets the width of a column + +#### Parameters + + + +| | | +|---|---| +| col | the index of the column whose width is being set (0-based index) | +| width | the new width of the column | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-display-full-names.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-display-full-names.md index 5906e46285..503ae6925a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-display-full-names.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-display-full-names.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[setDisplayFullNames](set-display-full-names.md) - -# setDisplayFullNames - - -public [setDisplayFullNames](set-display-full-names.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -*************************************************************************** causes the grid to display full or short variable names - -#### Parameters - - - -| | | -|---|---| -| flag | true to display full names | +# setDisplayFullNames + + +public [setDisplayFullNames](set-display-full-names.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +*************************************************************************** causes the grid to display full or short variable names + +#### Parameters + + + +| | | +|---|---| +| flag | true to display full names | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-display-units.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-display-units.md index c8d2c8c3f8..0bb3391aa0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-display-units.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-display-units.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[setDisplayUnits](set-display-units.md) - -# setDisplayUnits - - -public [setDisplayUnits](set-display-units.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -*************************************************************************** causes the grid to display units or not display units - -#### Parameters - - - -| | | -|---|---| -| flag | true to display units | +# setDisplayUnits + + +public [setDisplayUnits](set-display-units.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +*************************************************************************** causes the grid to display units or not display units + +#### Parameters + + + +| | | +|---|---| +| flag | true to display units | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-link.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-link.md index 5493accb0a..54978134ec 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-link.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-link.md @@ -1,21 +1,19 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[setLink](set-link.md) - -# setLink - - -public [setLink](set-link.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), link: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -*************************************************************************** assigns a link to an entry - -#### Return - -whether the link was successfully added - -#### Parameters - - - -| | | -|---|---| -| row | the index of the entry to check (0-based index) | -| link | the full name of the item to which the entry will be linked | +# setLink + + +public [setLink](set-link.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), link: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +*************************************************************************** assigns a link to an entry + +#### Return + +whether the link was successfully added + +#### Parameters + + + +| | | +|---|---| +| row | the index of the entry to check (0-based index) | +| link | the full name of the item to which the entry will be linked | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-location.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-location.md index 74df48ae5a..4b08b7e88e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-location.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-location.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[setLocation](set-location.md) - -# setLocation - - -public [setLocation](set-location.md)(x: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), y: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) +# setLocation + + +public [setLocation](set-location.md)(x: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), y: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-name.md index c8cbb83714..e3435c2275 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-name.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[setName](set-name.md) - -# setName - - -public [setName](set-name.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -*************************************************************************** sets the name of the given entry - -#### Parameters - - - -| | | -|---|---| -| row | the index of the entry to change (0-based index) | -| name | the new name of the entry | +# setName + + +public [setName](set-name.md)(row: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +*************************************************************************** sets the name of the given entry + +#### Parameters + + + +| | | +|---|---| +| row | the index of the entry to change (0-based index) | +| name | the new name of the entry | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-size.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-size.md index 28fb289cc6..ddf4f022b4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-size.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-size.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[setSize](set-size.md) - -# setSize - - -public [setSize](set-size.md)(width: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), height: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) +# setSize + + +public [setSize](set-size.md)(width: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), height: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-title.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-title.md index cc3fabd29d..d2c5d19b3a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-title.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-title.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DataMonitor](index.md)/[setTitle](set-title.md) - -# setTitle - - -public [setTitle](set-title.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) +# setTitle + + +public [setTitle](set-title.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/clear-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/clear-lower-bound.md index 16a2485e5a..eec4e15997 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/clear-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/clear-lower-bound.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[clearLowerBound](clear-lower-bound.md) - -# clearLowerBound - - -public [clearLowerBound](clear-lower-bound.md)() - -clears the lower bound - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# clearLowerBound + + +public [clearLowerBound](clear-lower-bound.md)() + +clears the lower bound + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/clear-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/clear-upper-bound.md index 6ee83d4506..58a34514ce 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/clear-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/clear-upper-bound.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[clearUpperBound](clear-upper-bound.md) - -# clearUpperBound - - -public [clearUpperBound](clear-upper-bound.md)() - -clears the upper bound - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# clearUpperBound + + +public [clearUpperBound](clear-upper-bound.md)() + +clears the upper bound + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/from-formatted-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/from-formatted-string.md index ebb585bd4f..2fcc649cad 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/from-formatted-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/from-formatted-string.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[fromFormattedString](from-formatted-string.md) - -# fromFormattedString - - -public [fromFormattedString](from-formatted-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value for the variable from a formatted string - -#### Parameters - - - -| | | -|---|---| -| value | the formatted value | -| index | the array element to set (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# fromFormattedString + + +public [fromFormattedString](from-formatted-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value for the variable from a formatted string + +#### Parameters + + + +| | | +|---|---| +| value | the formatted value | +| index | the array element to set (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-description.md index d50123481d..f0c010045f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-description.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[getDescription](get-description.md) - -# getDescription - - -public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the description for the variable - -#### Return - -the description of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDescription + + +public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the description for the variable + +#### Return + +the description of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-enum-aliases.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-enum-aliases.md index eb4197ff7b..2c0d029f18 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-enum-aliases.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-enum-aliases.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[getEnumAliases](get-enum-aliases.md) - -# getEnumAliases - - -public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the enumerated aliases for the variable - -#### Return - -a comma separated list of enumerated aliases - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEnumAliases + + +public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the enumerated aliases for the variable + +#### Return + +a comma separated list of enumerated aliases + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-enum-values.md index 15bc456d9d..f3b1305238 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-enum-values.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[getEnumValues](get-enum-values.md) - -# getEnumValues - - -public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the enumerated values for the variable - -#### Return - -a comma separated list of enumerated values - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEnumValues + + +public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the enumerated values for the variable + +#### Return + +a comma separated list of enumerated values + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-format.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-format.md index 3752fc02ef..195bcb2135 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-format.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-format.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[getFormat](get-format.md) - -# getFormat - - -public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the format for the variable - -#### Return - -the format of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getFormat + + +public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the format for the variable + +#### Return + +the format of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-lower-bound.md index e1efd0a2dc..1a29bbd668 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-lower-bound.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[getLowerBound](get-lower-bound.md) - -# getLowerBound - - -public [getLowerBound](get-lower-bound.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the lower bound for the variable - -#### Return - -the lower bound of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getLowerBound + + +public [getLowerBound](get-lower-bound.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the lower bound for the variable + +#### Return + +the lower bound of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-units.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-units.md index 937d07ab5f..0befe9e2da 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-units.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-units.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[getUnits](get-units.md) - -# getUnits - - -public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the units for the variable - -#### Return - -the units of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getUnits + + +public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the units for the variable + +#### Return + +the units of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-upper-bound.md index 0802055385..06ca850753 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-upper-bound.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[getUpperBound](get-upper-bound.md) - -# getUpperBound - - -public [getUpperBound](get-upper-bound.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the upper bound for the variable - -#### Return - -the upper bound of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getUpperBound + + +public [getUpperBound](get-upper-bound.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the upper bound for the variable + +#### Return + +the upper bound of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md index ae733d4342..60be3d9719 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md @@ -1,301 +1,299 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[getValueAbsolute](get-value-absolute.md) - -# getValueAbsolute - - -public [getValueAbsolute](get-value-absolute.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| index | index in string form, i.e. [1][2][3] | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location without validatating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | -| d10 | index in the 10th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValueAbsolute + + +public [getValueAbsolute](get-value-absolute.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| index | index in string form, i.e. [1][2][3] | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location without validatating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | +| d10 | index in the 10th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md index 04cc1ca59c..53694a078f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md @@ -1,301 +1,299 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[getValue](get-value.md) - -# getValue - - -public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| index | index in string form, i.e. [1][2][3] | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | -| d10 | index in the 10th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValue + + +public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| index | index in string form, i.e. [1][2][3] | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | +| d10 | index in the 10th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/has-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/has-lower-bound.md index 2a424fbd13..8b9d0bb2ea 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/has-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/has-lower-bound.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[hasLowerBound](has-lower-bound.md) - -# hasLowerBound - - -public [hasLowerBound](has-lower-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -indicates whether a lower bound exists or not - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# hasLowerBound + + +public [hasLowerBound](has-lower-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +indicates whether a lower bound exists or not + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/has-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/has-upper-bound.md index 31ff03e9de..2e270b28d8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/has-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/has-upper-bound.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[hasUpperBound](has-upper-bound.md) - -# hasUpperBound - - -public [hasUpperBound](has-upper-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -indicates whether an upper bound exists or not - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# hasUpperBound + + +public [hasUpperBound](has-upper-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +indicates whether an upper bound exists or not + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/index.md index 07a5a216cb..f2e0597c2d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/index.md @@ -1,78 +1,76 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md) - -# DoubleArray - - -public class [DoubleArray](index.md) : [Array](../-array/index.md) - -An array type class for ModelCenter - -#### Author - -Woyak, 10/2001 - -## Functions - -| Name | Summary | -|---|---| -| [clearLowerBound](clear-lower-bound.md) | public [clearLowerBound](clear-lower-bound.md)()
clears the lower bound | -| [clearUpperBound](clear-upper-bound.md) | public [clearUpperBound](clear-upper-bound.md)()
clears the upper bound | -| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromFormattedString](from-formatted-string.md) | public [fromFormattedString](from-formatted-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value for the variable from a formatted string | -| [fromString](../-array/from-string.md) | public [fromString](../-array/from-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value for the variable from a string
public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | -| [getAutoSize](../-array/get-auto-size.md) | public [getAutoSize](../-array/get-auto-size.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the autoSize flag. | -| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | -| [getDimensions](../-array/get-dimensions.md) | public [getDimensions](../-array/get-dimensions.md)(): [Variant](../-variant/index.md)
gets the dimensions of an array | -| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | -| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | -| [getEnumAliases](get-enum-aliases.md) | public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated aliases for the variable | -| [getEnumValues](get-enum-values.md) | public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated values for the variable | -| [getFormat](get-format.md) | public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the format for the variable | -| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | -| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | -| [getLength](../-array/get-length.md) | public [getLength](../-array/get-length.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getLength](../-array/get-length.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | -| [getLowerBound](get-lower-bound.md) | public [getLowerBound](get-lower-bound.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the lower bound for the variable | -| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | -| [getNumDimensions](../-array/get-num-dimensions.md) | public [getNumDimensions](../-array/get-num-dimensions.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of dimensions | -| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | -| [getSize](../-array/get-size.md) | public [getSize](../-array/get-size.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getSize](../-array/get-size.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | -| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | -| [getUnits](get-units.md) | public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the units for the variable | -| [getUpperBound](get-upper-bound.md) | public [getUpperBound](get-upper-bound.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the upper bound for the variable | -| [getValue](get-value.md) | public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the value of the variable at a specific location | -| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the value of the variable at a specific location without validatating. | -| [hasLowerBound](has-lower-bound.md) | public [hasLowerBound](has-lower-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates whether a lower bound exists or not | -| [hasUpperBound](has-upper-bound.md) | public [hasUpperBound](has-upper-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates whether an upper bound exists or not | -| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | -| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | -| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | -| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | -| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | -| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setAutoSize](../-array/set-auto-size.md) | public [setAutoSize](../-array/set-auto-size.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the autoSize flag. | -| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | -| [setDimensions](../-array/set-dimensions.md) | public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the dimensions of the array | -| [setEnumAliases](set-enum-aliases.md) | public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated aliases for the variable. | -| [setEnumValues](set-enum-values.md) | public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated values for the variable | -| [setFormat](set-format.md) | public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the format for the variable | -| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | -| [setLength](../-array/set-length.md) | public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | -| [setLowerBound](set-lower-bound.md) | public [setLowerBound](set-lower-bound.md)(bound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
sets the lower bound for the variable | -| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | -| [setNumDimensions](../-array/set-num-dimensions.md) | public [setNumDimensions](../-array/set-num-dimensions.md)(num: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the number of dimensions | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setSize](../-array/set-size.md) | public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | -| [setUnits](set-units.md) | public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the units for the variable | -| [setUpperBound](set-upper-bound.md) | public [setUpperBound](set-upper-bound.md)(bound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
sets the upper bound for the variable | -| [setValue](set-value.md) | public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value of the variable at a specific location | -| [toFormattedString](to-formatted-string.md) | public [toFormattedString](to-formatted-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a formatted string representation. | -| [toFormattedStringAbsolute](to-formatted-string-absolute.md) | public [toFormattedStringAbsolute](to-formatted-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a formatted string representation. | -| [toString](../-array/to-string.md) | public [toString](../-array/to-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [toStringAbsolute](../-array/to-string-absolute.md) | public [toStringAbsolute](../-array/to-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | +# DoubleArray + + +public class [DoubleArray](index.md) : [Array](../-array/index.md) + +An array type class for ModelCenter + +#### Author + +Woyak, 10/2001 + +## Functions + +| Name | Summary | +|---|---| +| [clearLowerBound](clear-lower-bound.md) | public [clearLowerBound](clear-lower-bound.md)()
clears the lower bound | +| [clearUpperBound](clear-upper-bound.md) | public [clearUpperBound](clear-upper-bound.md)()
clears the upper bound | +| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromFormattedString](from-formatted-string.md) | public [fromFormattedString](from-formatted-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value for the variable from a formatted string | +| [fromString](../-array/from-string.md) | public [fromString](../-array/from-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value for the variable from a string
public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | +| [getAutoSize](../-array/get-auto-size.md) | public [getAutoSize](../-array/get-auto-size.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the autoSize flag. | +| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | +| [getDimensions](../-array/get-dimensions.md) | public [getDimensions](../-array/get-dimensions.md)(): [Variant](../-variant/index.md)
gets the dimensions of an array | +| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | +| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | +| [getEnumAliases](get-enum-aliases.md) | public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated aliases for the variable | +| [getEnumValues](get-enum-values.md) | public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated values for the variable | +| [getFormat](get-format.md) | public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the format for the variable | +| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | +| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | +| [getLength](../-array/get-length.md) | public [getLength](../-array/get-length.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getLength](../-array/get-length.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | +| [getLowerBound](get-lower-bound.md) | public [getLowerBound](get-lower-bound.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the lower bound for the variable | +| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | +| [getNumDimensions](../-array/get-num-dimensions.md) | public [getNumDimensions](../-array/get-num-dimensions.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of dimensions | +| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | +| [getSize](../-array/get-size.md) | public [getSize](../-array/get-size.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getSize](../-array/get-size.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | +| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | +| [getUnits](get-units.md) | public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the units for the variable | +| [getUpperBound](get-upper-bound.md) | public [getUpperBound](get-upper-bound.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the upper bound for the variable | +| [getValue](get-value.md) | public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the value of the variable at a specific location | +| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the value of the variable at a specific location without validatating. | +| [hasLowerBound](has-lower-bound.md) | public [hasLowerBound](has-lower-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates whether a lower bound exists or not | +| [hasUpperBound](has-upper-bound.md) | public [hasUpperBound](has-upper-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates whether an upper bound exists or not | +| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | +| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | +| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | +| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | +| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | +| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setAutoSize](../-array/set-auto-size.md) | public [setAutoSize](../-array/set-auto-size.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the autoSize flag. | +| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | +| [setDimensions](../-array/set-dimensions.md) | public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the dimensions of the array | +| [setEnumAliases](set-enum-aliases.md) | public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated aliases for the variable. | +| [setEnumValues](set-enum-values.md) | public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated values for the variable | +| [setFormat](set-format.md) | public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the format for the variable | +| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | +| [setLength](../-array/set-length.md) | public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | +| [setLowerBound](set-lower-bound.md) | public [setLowerBound](set-lower-bound.md)(bound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
sets the lower bound for the variable | +| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | +| [setNumDimensions](../-array/set-num-dimensions.md) | public [setNumDimensions](../-array/set-num-dimensions.md)(num: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the number of dimensions | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setSize](../-array/set-size.md) | public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | +| [setUnits](set-units.md) | public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the units for the variable | +| [setUpperBound](set-upper-bound.md) | public [setUpperBound](set-upper-bound.md)(bound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
sets the upper bound for the variable | +| [setValue](set-value.md) | public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value of the variable at a specific location | +| [toFormattedString](to-formatted-string.md) | public [toFormattedString](to-formatted-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a formatted string representation. | +| [toFormattedStringAbsolute](to-formatted-string-absolute.md) | public [toFormattedStringAbsolute](to-formatted-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a formatted string representation. | +| [toString](../-array/to-string.md) | public [toString](../-array/to-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [toStringAbsolute](../-array/to-string-absolute.md) | public [toStringAbsolute](../-array/to-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-description.md index f4704cf02c..0147b158ab 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-description.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[setDescription](set-description.md) - -# setDescription - - -public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the description for the variable - -#### Parameters - - - -| | | -|---|---| -| description | the description of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDescription + + +public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the description for the variable + +#### Parameters + + + +| | | +|---|---| +| description | the description of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-enum-aliases.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-enum-aliases.md index 6c17cc4f50..6539bf2c47 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-enum-aliases.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-enum-aliases.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[setEnumAliases](set-enum-aliases.md) - -# setEnumAliases - - -public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the enumerated aliases for the variable. If specified, the enumerated aliases are alias values for enumerated values. For example, if the enumerated values are set to "1,2,3", and the enumerated aliases are set to "one,two,three", then calling fromString( "three" ) will result in the value being set to 3. - -#### Parameters - - - -| | | -|---|---| -| enumAliases | a comma separated list of enumerated aliases | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setEnumAliases + + +public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the enumerated aliases for the variable. If specified, the enumerated aliases are alias values for enumerated values. For example, if the enumerated values are set to "1,2,3", and the enumerated aliases are set to "one,two,three", then calling fromString( "three" ) will result in the value being set to 3. + +#### Parameters + + + +| | | +|---|---| +| enumAliases | a comma separated list of enumerated aliases | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-enum-values.md index 03f0a6b68d..cd284612b6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-enum-values.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[setEnumValues](set-enum-values.md) - -# setEnumValues - - -public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the enumerated values for the variable - -#### Parameters - - - -| | | -|---|---| -| enumValues | a comma separated list of values | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setEnumValues + + +public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the enumerated values for the variable + +#### Parameters + + + +| | | +|---|---| +| enumValues | a comma separated list of values | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-format.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-format.md index bb098816fb..0cd6f3cda5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-format.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-format.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[setFormat](set-format.md) - -# setFormat - - -public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the format for the variable - -#### Parameters - - - -| | | -|---|---| -| format | the format of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setFormat + + +public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the format for the variable + +#### Parameters + + + +| | | +|---|---| +| format | the format of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-lower-bound.md index ca186590d2..f5adcf49e1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-lower-bound.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[setLowerBound](set-lower-bound.md) - -# setLowerBound - - -public [setLowerBound](set-lower-bound.md)(bound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) - -sets the lower bound for the variable - -#### Parameters - - - -| | | -|---|---| -| bound | the lower bound for the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setLowerBound + + +public [setLowerBound](set-lower-bound.md)(bound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) + +sets the lower bound for the variable + +#### Parameters + + + +| | | +|---|---| +| bound | the lower bound for the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-units.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-units.md index d51cb634cb..7a54f80014 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-units.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-units.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[setUnits](set-units.md) - -# setUnits - - -public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the units for the variable - -#### Parameters - - - -| | | -|---|---| -| units | the units of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setUnits + + +public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the units for the variable + +#### Parameters + + + +| | | +|---|---| +| units | the units of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-upper-bound.md index cfc31075ca..d2cba5a805 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-upper-bound.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[setUpperBound](set-upper-bound.md) - -# setUpperBound - - -public [setUpperBound](set-upper-bound.md)(bound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) - -sets the upper bound for the variable - -#### Parameters - - - -| | | -|---|---| -| bound | the upper bound of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setUpperBound + + +public [setUpperBound](set-upper-bound.md)(bound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) + +sets the upper bound for the variable + +#### Parameters + + + +| | | +|---|---| +| bound | the upper bound of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md index 4116f07351..84c4329e73 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md @@ -1,268 +1,266 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[setValue](set-value.md) - -# setValue - - -public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| index | index in string form, i.e. [1][2][3] | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | -| d10 | index in the 10th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setValue + + +public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| index | index in string form, i.e. [1][2][3] | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | +| d10 | index in the 10th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/to-formatted-string-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/to-formatted-string-absolute.md index fe61ad5ce7..4d967fea42 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/to-formatted-string-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/to-formatted-string-absolute.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[toFormattedStringAbsolute](to-formatted-string-absolute.md) - -# toFormattedStringAbsolute - - -public [toFormattedStringAbsolute](to-formatted-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -converts the variable value to a formatted string representation. If the variable is not currently valid, it is NOT validated. - -#### Return - -the string value of the formatted variable - -#### Parameters - - - -| | | -|---|---| -| index | the array element to get (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toFormattedStringAbsolute + + +public [toFormattedStringAbsolute](to-formatted-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +converts the variable value to a formatted string representation. If the variable is not currently valid, it is NOT validated. + +#### Return + +the string value of the formatted variable + +#### Parameters + + + +| | | +|---|---| +| index | the array element to get (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/to-formatted-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/to-formatted-string.md index 113be2cb31..3c8ed092a6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/to-formatted-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-array/to-formatted-string.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleArray](index.md)/[toFormattedString](to-formatted-string.md) - -# toFormattedString - - -public [toFormattedString](to-formatted-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -converts the variable value to a formatted string representation. If the variable is not currently valid, it is first validated. - -#### Return - -the string value of the formatted variable - -#### Parameters - - - -| | | -|---|---| -| index | the array element to get (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toFormattedString + + +public [toFormattedString](to-formatted-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +converts the variable value to a formatted string representation. If the variable is not currently valid, it is first validated. + +#### Return + +the string value of the formatted variable + +#### Parameters + + + +| | | +|---|---| +| index | the array element to get (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/clear-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/clear-lower-bound.md index dea7cf2504..eec4e15997 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/clear-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/clear-lower-bound.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[clearLowerBound](clear-lower-bound.md) - -# clearLowerBound - - -public [clearLowerBound](clear-lower-bound.md)() - -clears the lower bound - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# clearLowerBound + + +public [clearLowerBound](clear-lower-bound.md)() + +clears the lower bound + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/clear-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/clear-upper-bound.md index df3a07b8d2..58a34514ce 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/clear-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/clear-upper-bound.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[clearUpperBound](clear-upper-bound.md) - -# clearUpperBound - - -public [clearUpperBound](clear-upper-bound.md)() - -clears the upper bound - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# clearUpperBound + + +public [clearUpperBound](clear-upper-bound.md)() + +clears the upper bound + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/from-formatted-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/from-formatted-string.md index d99040205a..6720e8f0ed 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/from-formatted-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/from-formatted-string.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[fromFormattedString](from-formatted-string.md) - -# fromFormattedString - - -public [fromFormattedString](from-formatted-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the value for the variable from a formatted string - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# fromFormattedString + + +public [fromFormattedString](from-formatted-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the value for the variable from a formatted string + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-description.md index 1d01e97b27..f0c010045f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-description.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[getDescription](get-description.md) - -# getDescription - - -public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the description for the variable - -#### Return - -the description of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDescription + + +public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the description for the variable + +#### Return + +the description of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-enum-aliases.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-enum-aliases.md index ffde773675..2c0d029f18 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-enum-aliases.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-enum-aliases.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[getEnumAliases](get-enum-aliases.md) - -# getEnumAliases - - -public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the enumerated aliases for the variable - -#### Return - -a comma separated list of enumerated aliases - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEnumAliases + + +public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the enumerated aliases for the variable + +#### Return + +a comma separated list of enumerated aliases + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-enum-values.md index 8bd9b644b0..f3b1305238 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-enum-values.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[getEnumValues](get-enum-values.md) - -# getEnumValues - - -public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the enumerated values for the variable - -#### Return - -a comma separated list of enumerated values - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEnumValues + + +public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the enumerated values for the variable + +#### Return + +a comma separated list of enumerated values + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-format.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-format.md index 4119930d32..195bcb2135 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-format.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-format.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[getFormat](get-format.md) - -# getFormat - - -public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the format for the variable - -#### Return - -the format of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getFormat + + +public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the format for the variable + +#### Return + +the format of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-lower-bound.md index 3e8dbce8ba..1a29bbd668 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-lower-bound.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[getLowerBound](get-lower-bound.md) - -# getLowerBound - - -public [getLowerBound](get-lower-bound.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the lower bound for the variable - -#### Return - -the lower bound of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getLowerBound + + +public [getLowerBound](get-lower-bound.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the lower bound for the variable + +#### Return + +the lower bound of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-units.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-units.md index a9ee5ef260..0befe9e2da 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-units.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-units.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[getUnits](get-units.md) - -# getUnits - - -public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the units for the variable - -#### Return - -the units of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getUnits + + +public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the units for the variable + +#### Return + +the units of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-upper-bound.md index 0df788f6ef..06ca850753 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-upper-bound.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[getUpperBound](get-upper-bound.md) - -# getUpperBound - - -public [getUpperBound](get-upper-bound.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the upper bound for the variable - -#### Return - -the upper bound of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getUpperBound + + +public [getUpperBound](get-upper-bound.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the upper bound for the variable + +#### Return + +the upper bound of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-value-absolute.md index 1fae1ba0ff..9a4fca3ca8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-value-absolute.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[getValueAbsolute](get-value-absolute.md) - -# getValueAbsolute - - -public [getValueAbsolute](get-value-absolute.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable without validating it - -#### Return - -the value of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValueAbsolute + + +public [getValueAbsolute](get-value-absolute.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable without validating it + +#### Return + +the value of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-value.md index c9e4c24c50..9300800608 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-value.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[getValue](get-value.md) - -# getValue - - -public [getValue](get-value.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the variable - -#### Return - -the value of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValue + + +public [getValue](get-value.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the variable + +#### Return + +the value of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/has-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/has-lower-bound.md index 4682faf2cd..8b9d0bb2ea 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/has-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/has-lower-bound.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[hasLowerBound](has-lower-bound.md) - -# hasLowerBound - - -public [hasLowerBound](has-lower-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -indicates whether a lower bound exists or not - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# hasLowerBound + + +public [hasLowerBound](has-lower-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +indicates whether a lower bound exists or not + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/has-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/has-upper-bound.md index 53e7a0b720..2e270b28d8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/has-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/has-upper-bound.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[hasUpperBound](has-upper-bound.md) - -# hasUpperBound - - -public [hasUpperBound](has-upper-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -indicates whether an upper bound exists or not - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# hasUpperBound + + +public [hasUpperBound](has-upper-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +indicates whether an upper bound exists or not + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/index.md index 0357e1714d..b0d21cbde2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/index.md @@ -1,68 +1,66 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md) - -# DoubleVariable - - -public class [DoubleVariable](index.md) : [Variable](../-variable/index.md) - -A variable type class for ModelCenter - -#### Author - -Woyak, 10/2001 - -## Functions - -| Name | Summary | -|---|---| -| [clearLowerBound](clear-lower-bound.md) | public [clearLowerBound](clear-lower-bound.md)()
clears the lower bound | -| [clearUpperBound](clear-upper-bound.md) | public [clearUpperBound](clear-upper-bound.md)()
clears the upper bound | -| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromFormattedString](from-formatted-string.md) | public [fromFormattedString](from-formatted-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value for the variable from a formatted string | -| [fromString](../-variable/from-string.md) | public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | -| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | -| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | -| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | -| [getEnumAliases](get-enum-aliases.md) | public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated aliases for the variable | -| [getEnumValues](get-enum-values.md) | public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated values for the variable | -| [getFormat](get-format.md) | public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the format for the variable | -| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | -| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | -| [getLowerBound](get-lower-bound.md) | public [getLowerBound](get-lower-bound.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the lower bound for the variable | -| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | -| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | -| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | -| [getUnits](get-units.md) | public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the units for the variable | -| [getUpperBound](get-upper-bound.md) | public [getUpperBound](get-upper-bound.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the upper bound for the variable | -| [getValue](get-value.md) | public [getValue](get-value.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the value of the variable | -| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the value of the variable without validating it | -| [hasLowerBound](has-lower-bound.md) | public [hasLowerBound](has-lower-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates whether a lower bound exists or not | -| [hasUpperBound](has-upper-bound.md) | public [hasUpperBound](has-upper-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates whether an upper bound exists or not | -| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | -| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | -| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | -| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | -| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | -| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | -| [setEnumAliases](set-enum-aliases.md) | public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated aliases for the variable. | -| [setEnumValues](set-enum-values.md) | public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated values for the variable | -| [setFormat](set-format.md) | public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the format for the variable | -| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | -| [setLowerBound](set-lower-bound.md) | public [setLowerBound](set-lower-bound.md)(bound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
sets the lower bound for the variable | -| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setUnits](set-units.md) | public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the units for the variable | -| [setUpperBound](set-upper-bound.md) | public [setUpperBound](set-upper-bound.md)(bound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
sets the upper bound for the variable | -| [setValue](set-value.md) | public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
sets the value of the variable | -| [toFormattedString](to-formatted-string.md) | public [toFormattedString](to-formatted-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a formatted string representation. | -| [toFormattedStringAbsolute](to-formatted-string-absolute.md) | public [toFormattedStringAbsolute](to-formatted-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a formatted string representation. | -| [toString](../-variable/to-string.md) | public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [toStringAbsolute](../-variable/to-string-absolute.md) | public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | +# DoubleVariable + + +public class [DoubleVariable](index.md) : [Variable](../-variable/index.md) + +A variable type class for ModelCenter + +#### Author + +Woyak, 10/2001 + +## Functions + +| Name | Summary | +|---|---| +| [clearLowerBound](clear-lower-bound.md) | public [clearLowerBound](clear-lower-bound.md)()
clears the lower bound | +| [clearUpperBound](clear-upper-bound.md) | public [clearUpperBound](clear-upper-bound.md)()
clears the upper bound | +| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromFormattedString](from-formatted-string.md) | public [fromFormattedString](from-formatted-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value for the variable from a formatted string | +| [fromString](../-variable/from-string.md) | public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | +| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | +| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | +| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | +| [getEnumAliases](get-enum-aliases.md) | public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated aliases for the variable | +| [getEnumValues](get-enum-values.md) | public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated values for the variable | +| [getFormat](get-format.md) | public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the format for the variable | +| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | +| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | +| [getLowerBound](get-lower-bound.md) | public [getLowerBound](get-lower-bound.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the lower bound for the variable | +| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | +| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | +| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | +| [getUnits](get-units.md) | public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the units for the variable | +| [getUpperBound](get-upper-bound.md) | public [getUpperBound](get-upper-bound.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the upper bound for the variable | +| [getValue](get-value.md) | public [getValue](get-value.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the value of the variable | +| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the value of the variable without validating it | +| [hasLowerBound](has-lower-bound.md) | public [hasLowerBound](has-lower-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates whether a lower bound exists or not | +| [hasUpperBound](has-upper-bound.md) | public [hasUpperBound](has-upper-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates whether an upper bound exists or not | +| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | +| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | +| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | +| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | +| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | +| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | +| [setEnumAliases](set-enum-aliases.md) | public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated aliases for the variable. | +| [setEnumValues](set-enum-values.md) | public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated values for the variable | +| [setFormat](set-format.md) | public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the format for the variable | +| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | +| [setLowerBound](set-lower-bound.md) | public [setLowerBound](set-lower-bound.md)(bound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
sets the lower bound for the variable | +| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setUnits](set-units.md) | public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the units for the variable | +| [setUpperBound](set-upper-bound.md) | public [setUpperBound](set-upper-bound.md)(bound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
sets the upper bound for the variable | +| [setValue](set-value.md) | public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
sets the value of the variable | +| [toFormattedString](to-formatted-string.md) | public [toFormattedString](to-formatted-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a formatted string representation. | +| [toFormattedStringAbsolute](to-formatted-string-absolute.md) | public [toFormattedStringAbsolute](to-formatted-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a formatted string representation. | +| [toString](../-variable/to-string.md) | public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [toStringAbsolute](../-variable/to-string-absolute.md) | public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-description.md index 6315fe225f..0147b158ab 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-description.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[setDescription](set-description.md) - -# setDescription - - -public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the description for the variable - -#### Parameters - - - -| | | -|---|---| -| description | the description of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDescription + + +public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the description for the variable + +#### Parameters + + + +| | | +|---|---| +| description | the description of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-enum-aliases.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-enum-aliases.md index 0f02cc2f72..6539bf2c47 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-enum-aliases.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-enum-aliases.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[setEnumAliases](set-enum-aliases.md) - -# setEnumAliases - - -public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the enumerated aliases for the variable. If specified, the enumerated aliases are alias values for enumerated values. For example, if the enumerated values are set to "1,2,3", and the enumerated aliases are set to "one,two,three", then calling fromString( "three" ) will result in the value being set to 3. - -#### Parameters - - - -| | | -|---|---| -| enumAliases | a comma separated list of enumerated aliases | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setEnumAliases + + +public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the enumerated aliases for the variable. If specified, the enumerated aliases are alias values for enumerated values. For example, if the enumerated values are set to "1,2,3", and the enumerated aliases are set to "one,two,three", then calling fromString( "three" ) will result in the value being set to 3. + +#### Parameters + + + +| | | +|---|---| +| enumAliases | a comma separated list of enumerated aliases | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-enum-values.md index 415221d8fc..cd284612b6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-enum-values.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[setEnumValues](set-enum-values.md) - -# setEnumValues - - -public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the enumerated values for the variable - -#### Parameters - - - -| | | -|---|---| -| enumValues | a comma separated list of values | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setEnumValues + + +public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the enumerated values for the variable + +#### Parameters + + + +| | | +|---|---| +| enumValues | a comma separated list of values | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-format.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-format.md index e9a9cb87b9..0cd6f3cda5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-format.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-format.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[setFormat](set-format.md) - -# setFormat - - -public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the format for the variable - -#### Parameters - - - -| | | -|---|---| -| format | the format of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setFormat + + +public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the format for the variable + +#### Parameters + + + +| | | +|---|---| +| format | the format of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-lower-bound.md index d224ca932f..f5adcf49e1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-lower-bound.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[setLowerBound](set-lower-bound.md) - -# setLowerBound - - -public [setLowerBound](set-lower-bound.md)(bound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) - -sets the lower bound for the variable - -#### Parameters - - - -| | | -|---|---| -| bound | the lower bound for the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setLowerBound + + +public [setLowerBound](set-lower-bound.md)(bound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) + +sets the lower bound for the variable + +#### Parameters + + + +| | | +|---|---| +| bound | the lower bound for the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-units.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-units.md index 23c02fa5e3..7a54f80014 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-units.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-units.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[setUnits](set-units.md) - -# setUnits - - -public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the units for the variable - -#### Parameters - - - -| | | -|---|---| -| units | the units of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setUnits + + +public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the units for the variable + +#### Parameters + + + +| | | +|---|---| +| units | the units of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-upper-bound.md index 07feed6c78..d2cba5a805 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-upper-bound.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[setUpperBound](set-upper-bound.md) - -# setUpperBound - - -public [setUpperBound](set-upper-bound.md)(bound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) - -sets the upper bound for the variable - -#### Parameters - - - -| | | -|---|---| -| bound | the upper bound of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setUpperBound + + +public [setUpperBound](set-upper-bound.md)(bound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) + +sets the upper bound for the variable + +#### Parameters + + + +| | | +|---|---| +| bound | the upper bound of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-value.md index b3b1a571e9..ee1a627091 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-value.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[setValue](set-value.md) - -# setValue - - -public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) - -sets the value of the variable - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setValue + + +public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) + +sets the value of the variable + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/to-formatted-string-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/to-formatted-string-absolute.md index 91f65d9dc5..3fd5739b79 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/to-formatted-string-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/to-formatted-string-absolute.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[toFormattedStringAbsolute](to-formatted-string-absolute.md) - -# toFormattedStringAbsolute - - -public [toFormattedStringAbsolute](to-formatted-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -converts the variable value to a formatted string representation. If the variable is not currently valid, it is NOT validated. - -#### Return - -the formatted string value of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toFormattedStringAbsolute + + +public [toFormattedStringAbsolute](to-formatted-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +converts the variable value to a formatted string representation. If the variable is not currently valid, it is NOT validated. + +#### Return + +the formatted string value of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/to-formatted-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/to-formatted-string.md index 21c30033d3..b182641b22 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/to-formatted-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-double-variable/to-formatted-string.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[DoubleVariable](index.md)/[toFormattedString](to-formatted-string.md) - -# toFormattedString - - -public [toFormattedString](to-formatted-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -converts the variable value to a formatted string representation. If the variable is not currently valid, it is first validated. - -#### Return - -the formatted string value of the variable - -#### Throws - -| | | -|---|---| -| [RuntimeException](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html) | thrown if an error occurs while trying to validate or retrieve the value of the variable. Note that this is a run time exception because Object.toString() cannot be overridden to throw an exception. | +# toFormattedString + + +public [toFormattedString](to-formatted-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +converts the variable value to a formatted string representation. If the variable is not currently valid, it is first validated. + +#### Return + +the formatted string value of the variable + +#### Throws + +| | | +|---|---| +| [RuntimeException](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html) | thrown if an error occurs while trying to validate or retrieve the value of the variable. Note that this is a run time exception because Object.toString() cannot be overridden to throw an exception. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-feature/checkin.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-feature/checkin.md index 7d8d9ff539..c956a6f8eb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-feature/checkin.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-feature/checkin.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Feature](index.md)/[checkin](checkin.md) - -# checkin - - -public [checkin](checkin.md)() - -caused the feature to be checked in - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# checkin + + +public [checkin](checkin.md)() + +caused the feature to be checked in + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-feature/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-feature/index.md index 941896c4a0..3a517297e8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-feature/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-feature/index.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Feature](index.md) - -# Feature - - -public class [Feature](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -This is the wrapper class that handles the native COM calls to PHXFeature. The class is used by Java plug-ins to ModelCenter. - -#### Author - -Mullins, 7-02 - -## Functions - -| Name | Summary | -|---|---| -| [checkin](checkin.md) | public [checkin](checkin.md)()
caused the feature to be checked in | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +# Feature + + +public class [Feature](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +This is the wrapper class that handles the native COM calls to PHXFeature. The class is used by Java plug-ins to ModelCenter. + +#### Author + +Mullins, 7-02 + +## Functions + +| Name | Summary | +|---|---| +| [checkin](checkin.md) | public [checkin](checkin.md)()
caused the feature to be checked in | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md index 8501762d05..54b705da13 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md @@ -1,81 +1,79 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileArray](index.md)/[fromFile](from-file.md) - -# fromFile - - -public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -reads data from a file - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to load | -| index | index in string form, i.e. [1][2][3] | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -reads data from a file - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to load | -| d1 | index in the 1st dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -reads data from a file - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to load | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) +# fromFile + + +public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +reads data from a file + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to load | +| index | index in string form, i.e. [1][2][3] | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +reads data from a file + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to load | +| d1 | index in the 1st dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +reads data from a file + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to load | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/get-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/get-description.md index f61323345e..3d60ea45e1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/get-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/get-description.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileArray](index.md)/[getDescription](get-description.md) - -# getDescription - - -public [getDescription](get-description.md)(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the description text for the file array - -#### Return - -the array description text, e.g. "this is an array of Excel files" - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDescription + + +public [getDescription](get-description.md)(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the description text for the file array + +#### Return + +the array description text, e.g. "this is an array of Excel files" + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md index e36d71dd62..b9b3e504e5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md @@ -1,90 +1,88 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileArray](index.md)/[getFileExtension](get-file-extension.md) - -# getFileExtension - - -public [getFileExtension](get-file-extension.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the extension used for the file (used to associate the file with an application). - -#### Return - -the file extension, e.g. ".xls" - -#### Parameters - - - -| | | -|---|---| -| index | index in string form, i.e. [1][2][3] | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the extension used for the file (used to associate the file with an application). - -#### Return - -the file extension, e.g. ".xls" - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the extension used for the file (used to associate the file with an application). - -#### Return - -the file extension, e.g. ".xls" - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) +# getFileExtension + + +public [getFileExtension](get-file-extension.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the extension used for the file (used to associate the file with an application). + +#### Return + +the file extension, e.g. ".xls" + +#### Parameters + + + +| | | +|---|---| +| index | index in string form, i.e. [1][2][3] | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the extension used for the file (used to associate the file with an application). + +#### Return + +the file extension, e.g. ".xls" + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the extension used for the file (used to associate the file with an application). + +#### Return + +the file extension, e.g. ".xls" + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/get-is-binary.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/get-is-binary.md index ad36e8a07c..cee26ca2fd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/get-is-binary.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/get-is-binary.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileArray](index.md)/[getIsBinary](get-is-binary.md) - -# getIsBinary - - -public [getIsBinary](get-is-binary.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets a flag indicating if the file contents are binary - -#### Return - -true if the file contents are binary - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getIsBinary + + +public [getIsBinary](get-is-binary.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets a flag indicating if the file contents are binary + +#### Return + +true if the file contents are binary + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/get-save-with-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/get-save-with-model.md index 817156c2fa..69152b3f49 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/get-save-with-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/get-save-with-model.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileArray](index.md)/[getSaveWithModel](get-save-with-model.md) - -# getSaveWithModel - - -public [getSaveWithModel](get-save-with-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Gets a flag indicating that the value of the file array should be saved with the model. The flag only applies if the file array is an output. - -#### Return - -true if the saveWithModel flag is true - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getSaveWithModel + + +public [getSaveWithModel](get-save-with-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Gets a flag indicating that the value of the file array should be saved with the model. The flag only applies if the file array is an output. + +#### Return + +true if the saveWithModel flag is true + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/index.md index 23939a6c35..26c4fee377 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/index.md @@ -1,65 +1,63 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileArray](index.md) - -# FileArray - - -public class [FileArray](index.md) : [Array](../-array/index.md) - -A variable type class for ModelCenter - -#### Author - -jdaley, 7/2010 - -## Functions - -| Name | Summary | -|---|---| -| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromFile](from-file.md) | public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
reads data from a file
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) | -| [fromString](../-array/from-string.md) | public [fromString](../-array/from-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value for the variable from a string
public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | -| [getAutoSize](../-array/get-auto-size.md) | public [getAutoSize](../-array/get-auto-size.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the autoSize flag. | -| [getDescription](get-description.md) | public [getDescription](get-description.md)(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description text for the file array | -| [getDimensions](../-array/get-dimensions.md) | public [getDimensions](../-array/get-dimensions.md)(): [Variant](../-variant/index.md)
gets the dimensions of an array | -| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | -| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | -| [getFileExtension](get-file-extension.md) | public [getFileExtension](get-file-extension.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the extension used for the file (used to associate the file with an application).
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | -| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | -| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | -| [getIsBinary](get-is-binary.md) | public [getIsBinary](get-is-binary.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets a flag indicating if the file contents are binary | -| [getLength](../-array/get-length.md) | public [getLength](../-array/get-length.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getLength](../-array/get-length.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | -| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | -| [getNumDimensions](../-array/get-num-dimensions.md) | public [getNumDimensions](../-array/get-num-dimensions.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of dimensions | -| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | -| [getSaveWithModel](get-save-with-model.md) | public [getSaveWithModel](get-save-with-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets a flag indicating that the value of the file array should be saved with the model. | -| [getSize](../-array/get-size.md) | public [getSize](../-array/get-size.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getSize](../-array/get-size.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | -| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | -| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | -| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | -| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | -| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | -| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | -| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setAutoSize](../-array/set-auto-size.md) | public [setAutoSize](../-array/set-auto-size.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the autoSize flag. | -| [setDescription](set-description.md) | public [setDescription](set-description.md)(desc: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description text for the file array | -| [setDimensions](../-array/set-dimensions.md) | public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the dimensions of the array | -| [setFileExtension](set-file-extension.md) | public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the desired file extension for the file
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) | -| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | -| [setIsBinary](set-is-binary.md) | public [setIsBinary](set-is-binary.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets a flag indicating that this variable contains binary data | -| [setLength](../-array/set-length.md) | public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | -| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | -| [setNumDimensions](../-array/set-num-dimensions.md) | public [setNumDimensions](../-array/set-num-dimensions.md)(num: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the number of dimensions | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setSaveWithModel](set-save-with-model.md) | public [setSaveWithModel](set-save-with-model.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets a flag indicating that the value of the file array should be saved with the model. | -| [setSize](../-array/set-size.md) | public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | -| [toFile](to-file.md) | public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
writes out contents to a file
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) | -| [toFileAbsolute](to-file-absolute.md) | public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
writes out contents to a file without validating the variable
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) | -| [toString](../-array/to-string.md) | public [toString](../-array/to-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [toStringAbsolute](../-array/to-string-absolute.md) | public [toStringAbsolute](../-array/to-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | +# FileArray + + +public class [FileArray](index.md) : [Array](../-array/index.md) + +A variable type class for ModelCenter + +#### Author + +jdaley, 7/2010 + +## Functions + +| Name | Summary | +|---|---| +| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromFile](from-file.md) | public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
reads data from a file
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) | +| [fromString](../-array/from-string.md) | public [fromString](../-array/from-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value for the variable from a string
public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | +| [getAutoSize](../-array/get-auto-size.md) | public [getAutoSize](../-array/get-auto-size.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the autoSize flag. | +| [getDescription](get-description.md) | public [getDescription](get-description.md)(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description text for the file array | +| [getDimensions](../-array/get-dimensions.md) | public [getDimensions](../-array/get-dimensions.md)(): [Variant](../-variant/index.md)
gets the dimensions of an array | +| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | +| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | +| [getFileExtension](get-file-extension.md) | public [getFileExtension](get-file-extension.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the extension used for the file (used to associate the file with an application).
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getFileExtension](get-file-extension.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | +| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | +| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | +| [getIsBinary](get-is-binary.md) | public [getIsBinary](get-is-binary.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets a flag indicating if the file contents are binary | +| [getLength](../-array/get-length.md) | public [getLength](../-array/get-length.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getLength](../-array/get-length.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | +| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | +| [getNumDimensions](../-array/get-num-dimensions.md) | public [getNumDimensions](../-array/get-num-dimensions.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of dimensions | +| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | +| [getSaveWithModel](get-save-with-model.md) | public [getSaveWithModel](get-save-with-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets a flag indicating that the value of the file array should be saved with the model. | +| [getSize](../-array/get-size.md) | public [getSize](../-array/get-size.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getSize](../-array/get-size.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | +| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | +| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | +| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | +| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | +| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | +| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | +| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setAutoSize](../-array/set-auto-size.md) | public [setAutoSize](../-array/set-auto-size.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the autoSize flag. | +| [setDescription](set-description.md) | public [setDescription](set-description.md)(desc: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description text for the file array | +| [setDimensions](../-array/set-dimensions.md) | public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the dimensions of the array | +| [setFileExtension](set-file-extension.md) | public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the desired file extension for the file
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) | +| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | +| [setIsBinary](set-is-binary.md) | public [setIsBinary](set-is-binary.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets a flag indicating that this variable contains binary data | +| [setLength](../-array/set-length.md) | public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | +| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | +| [setNumDimensions](../-array/set-num-dimensions.md) | public [setNumDimensions](../-array/set-num-dimensions.md)(num: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the number of dimensions | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setSaveWithModel](set-save-with-model.md) | public [setSaveWithModel](set-save-with-model.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets a flag indicating that the value of the file array should be saved with the model. | +| [setSize](../-array/set-size.md) | public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | +| [toFile](to-file.md) | public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
writes out contents to a file
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) | +| [toFileAbsolute](to-file-absolute.md) | public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
writes out contents to a file without validating the variable
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) | +| [toString](../-array/to-string.md) | public [toString](../-array/to-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [toStringAbsolute](../-array/to-string-absolute.md) | public [toStringAbsolute](../-array/to-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/set-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/set-description.md index 76e2a13177..c5eedecb87 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/set-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/set-description.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileArray](index.md)/[setDescription](set-description.md) - -# setDescription - - -public [setDescription](set-description.md)(desc: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the description text for the file array - -#### Parameters - - - -| | | -|---|---| -| desc | the array description text, e.g. "this is an array of Excel files" | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDescription + + +public [setDescription](set-description.md)(desc: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the description text for the file array + +#### Parameters + + + +| | | +|---|---| +| desc | the array description text, e.g. "this is an array of Excel files" | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md index 2749f8409c..cab1920920 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md @@ -1,81 +1,79 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileArray](index.md)/[setFileExtension](set-file-extension.md) - -# setFileExtension - - -public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the desired file extension for the file - -#### Parameters - - - -| | | -|---|---| -| ext | the file extension, e.g. ".xls" | -| index | index in string form, i.e. [1][2][3] | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the desired file extension for the file - -#### Parameters - - - -| | | -|---|---| -| ext | the file extension, e.g. ".xls" | -| d1 | index in the 1st dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the desired file extension for the file - -#### Parameters - - - -| | | -|---|---| -| ext | the file extension, e.g. ".xls" | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) +# setFileExtension + + +public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the desired file extension for the file + +#### Parameters + + + +| | | +|---|---| +| ext | the file extension, e.g. ".xls" | +| index | index in string form, i.e. [1][2][3] | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the desired file extension for the file + +#### Parameters + + + +| | | +|---|---| +| ext | the file extension, e.g. ".xls" | +| d1 | index in the 1st dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the desired file extension for the file + +#### Parameters + + + +| | | +|---|---| +| ext | the file extension, e.g. ".xls" | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/set-is-binary.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/set-is-binary.md index f743f1b749..e57485f48a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/set-is-binary.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/set-is-binary.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileArray](index.md)/[setIsBinary](set-is-binary.md) - -# setIsBinary - - -public [setIsBinary](set-is-binary.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets a flag indicating that this variable contains binary data - -#### Parameters - - - -| | | -|---|---| -| flag | true if the contents are binary | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setIsBinary + + +public [setIsBinary](set-is-binary.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets a flag indicating that this variable contains binary data + +#### Parameters + + + +| | | +|---|---| +| flag | true if the contents are binary | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/set-save-with-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/set-save-with-model.md index eb01435427..343835e75b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/set-save-with-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/set-save-with-model.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileArray](index.md)/[setSaveWithModel](set-save-with-model.md) - -# setSaveWithModel - - -public [setSaveWithModel](set-save-with-model.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Sets a flag indicating that the value of the file array should be saved with the model. The flag only applies if the file array is an output. - -#### Parameters - - - -| | -|---| -| flag | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setSaveWithModel + + +public [setSaveWithModel](set-save-with-model.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Sets a flag indicating that the value of the file array should be saved with the model. The flag only applies if the file array is an output. + +#### Parameters + + + +| | +|---| +| flag | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md index 84390bc87c..b14a903ae8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md @@ -1,84 +1,82 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileArray](index.md)/[toFileAbsolute](to-file-absolute.md) - -# toFileAbsolute - - -public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -writes out contents to a file without validating the variable - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to write | -| encoding | file encoding to be used (ascii, utf-8, binary) | -| index | index in string form, i.e. [1][2][3] | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -writes out contents to a file without validating the variable - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to write | -| encoding | file encoding to be used (ascii, utf-8, binary) | -| d1 | index in the 1st dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -writes out contents to a file without validating the variable - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to write | -| encoding | file encoding to be used (ascii, utf-8, binary) | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) +# toFileAbsolute + + +public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +writes out contents to a file without validating the variable + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to write | +| encoding | file encoding to be used (ascii, utf-8, binary) | +| index | index in string form, i.e. [1][2][3] | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +writes out contents to a file without validating the variable + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to write | +| encoding | file encoding to be used (ascii, utf-8, binary) | +| d1 | index in the 1st dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +writes out contents to a file without validating the variable + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to write | +| encoding | file encoding to be used (ascii, utf-8, binary) | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md index ccae2f0b7b..e4ab8b921a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md @@ -1,84 +1,82 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileArray](index.md)/[toFile](to-file.md) - -# toFile - - -public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -writes out contents to a file - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to write | -| encoding | file encoding to be used (ascii, utf-8, binary) | -| index | index in string form, i.e. [1][2][3] | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -writes out contents to a file - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to write | -| encoding | file encoding to be used (ascii, utf-8, binary) | -| d1 | index in the 1st dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -writes out contents to a file - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to write | -| encoding | file encoding to be used (ascii, utf-8, binary) | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) +# toFile + + +public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +writes out contents to a file + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to write | +| encoding | file encoding to be used (ascii, utf-8, binary) | +| index | index in string form, i.e. [1][2][3] | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +writes out contents to a file + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to write | +| encoding | file encoding to be used (ascii, utf-8, binary) | +| d1 | index in the 1st dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +writes out contents to a file + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to write | +| encoding | file encoding to be used (ascii, utf-8, binary) | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-base-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-base-name.md index 1768d67c66..64ce896148 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-base-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-base-name.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileSystemInfo](index.md)/[getBaseName](get-base-name.md) - -# getBaseName - - -public [getBaseName](get-base-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Get the base filename, regardless of whether this is a version, file, or otherwise. This is the name of the file as it would appear on a local disk. For example, if this is readme.txt, version 2, this function will return "readme.txt". - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | on error | +# getBaseName + + +public [getBaseName](get-base-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Get the base filename, regardless of whether this is a version, file, or otherwise. This is the name of the file as it would appear on a local disk. For example, if this is readme.txt, version 2, this function will return "readme.txt". + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | on error | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-exists.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-exists.md index 0fd16de7cb..93123aa519 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-exists.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-exists.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileSystemInfo](index.md)/[getExists](get-exists.md) - -# getExists - - -public [getExists](get-exists.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Indicates whether the object exists. NOTE: other operations may fail or return default values if the object does not exist, so be sure to check this first if you have any doubt! - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | on error | +# getExists + + +public [getExists](get-exists.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Indicates whether the object exists. NOTE: other operations may fail or return default values if the object does not exist, so be sure to check this first if you have any doubt! + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | on error | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-is-valid.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-is-valid.md index 30f5046e89..900731df8a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-is-valid.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-is-valid.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileSystemInfo](index.md)/[getIsValid](get-is-valid.md) - -# getIsValid - - -public [getIsValid](get-is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Indicates whether the object is valid. - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | on error | +# getIsValid + + +public [getIsValid](get-is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Indicates whether the object is valid. + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | on error | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-is-writable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-is-writable.md index 18bd2d006c..456771c665 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-is-writable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-is-writable.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileSystemInfo](index.md)/[getIsWritable](get-is-writable.md) - -# getIsWritable - - -public [getIsWritable](get-is-writable.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Indicates whether the object is writable (true) or read-only (false). - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | on error | +# getIsWritable + + +public [getIsWritable](get-is-writable.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Indicates whether the object is writable (true) or read-only (false). + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | on error | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-url.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-url.md index 940f639f38..1740438882 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-url.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-url.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileSystemInfo](index.md)/[getUrl](get-url.md) - -# getUrl - - -public [getUrl](get-url.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Get the full URL of the object as a string. - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | on error | +# getUrl + + +public [getUrl](get-url.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Get the full URL of the object as a string. + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | on error | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/index.md index ee723e6e33..aa25b35b08 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-system-info/index.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileSystemInfo](index.md) - -# FileSystemInfo - - -public class [FileSystemInfo](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -This is the wrapper class that handles the native COM calls to a FileSystemInfo. The class is used by Java plug-ins to ModelCenter. - -## Functions - -| Name | Summary | -|---|---| -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [getBaseName](get-base-name.md) | public [getBaseName](get-base-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the base filename, regardless of whether this is a version, file, or otherwise. | -| [getExists](get-exists.md) | public [getExists](get-exists.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the object exists. | -| [getIsValid](get-is-valid.md) | public [getIsValid](get-is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the object is valid. | -| [getIsWritable](get-is-writable.md) | public [getIsWritable](get-is-writable.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the object is writable (true) or read-only (false). | -| [getUrl](get-url.md) | public [getUrl](get-url.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the full URL of the object as a string. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +# FileSystemInfo + + +public class [FileSystemInfo](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +This is the wrapper class that handles the native COM calls to a FileSystemInfo. The class is used by Java plug-ins to ModelCenter. + +## Functions + +| Name | Summary | +|---|---| +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [getBaseName](get-base-name.md) | public [getBaseName](get-base-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the base filename, regardless of whether this is a version, file, or otherwise. | +| [getExists](get-exists.md) | public [getExists](get-exists.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the object exists. | +| [getIsValid](get-is-valid.md) | public [getIsValid](get-is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the object is valid. | +| [getIsWritable](get-is-writable.md) | public [getIsWritable](get-is-writable.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the object is writable (true) or read-only (false). | +| [getUrl](get-url.md) | public [getUrl](get-url.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the full URL of the object as a string. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/from-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/from-file.md index c3b1ebce2f..4c1fd1745f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/from-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/from-file.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileVariable](index.md)/[fromFile](from-file.md) - -# fromFile - - -public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -reads data from a file (same as readFile()). - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to load | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# fromFile + + +public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +reads data from a file (same as readFile()). + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to load | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-description.md index 928b716926..1c679d8964 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-description.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileVariable](index.md)/[getDescription](get-description.md) - -# getDescription - - -public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the description text for the file - -#### Return - -the file description text, e.g. "this is an Excel File" - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDescription + + +public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the description text for the file + +#### Return + +the file description text, e.g. "this is an Excel File" + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-direct-transfer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-direct-transfer.md index 723d040e00..bfea7bc205 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-direct-transfer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-direct-transfer.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileVariable](index.md)/[getDirectTransfer](get-direct-transfer.md) - -# getDirectTransfer - - -public [getDirectTransfer](get-direct-transfer.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Gets the directTransfer flag. When true, if this file an input to an AnalysisServer component and if this file is linked to the output of another AnalysisServer component, then the file will be transfered directly between the two AnalysisServers. - -#### Return - -true if the directTransfer flag is true - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDirectTransfer + + +public [getDirectTransfer](get-direct-transfer.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Gets the directTransfer flag. When true, if this file an input to an AnalysisServer component and if this file is linked to the output of another AnalysisServer component, then the file will be transfered directly between the two AnalysisServers. + +#### Return + +true if the directTransfer flag is true + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-file-extension.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-file-extension.md index 62f9ba6146..8adc57b3ec 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-file-extension.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-file-extension.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileVariable](index.md)/[getFileExtension](get-file-extension.md) - -# getFileExtension - - -public [getFileExtension](get-file-extension.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the extension used for the file (used to associate the file with an application). - -#### Return - -the file extension, e.g. ".xls" - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getFileExtension + + +public [getFileExtension](get-file-extension.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the extension used for the file (used to associate the file with an application). + +#### Return + +the file extension, e.g. ".xls" + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-is-binary.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-is-binary.md index e045ebe5d3..cee26ca2fd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-is-binary.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-is-binary.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileVariable](index.md)/[getIsBinary](get-is-binary.md) - -# getIsBinary - - -public [getIsBinary](get-is-binary.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets a flag indicating if the file contents are binary - -#### Return - -true if the file contents are binary - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getIsBinary + + +public [getIsBinary](get-is-binary.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets a flag indicating if the file contents are binary + +#### Return + +true if the file contents are binary + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-save-with-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-save-with-model.md index 9cc41e36db..19c7b9ebe0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-save-with-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-save-with-model.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileVariable](index.md)/[getSaveWithModel](get-save-with-model.md) - -# getSaveWithModel - - -public [getSaveWithModel](get-save-with-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Gets a flag indicating that the value of the file should be saved with the model. The flag only applies to output files. - -#### Return - -true if the saveWithModel flag is true - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getSaveWithModel + + +public [getSaveWithModel](get-save-with-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Gets a flag indicating that the value of the file should be saved with the model. The flag only applies to output files. + +#### Return + +true if the saveWithModel flag is true + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/index.md index 450e93ad1f..b6b23eedb5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/index.md @@ -1,60 +1,58 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileVariable](index.md) - -# FileVariable - - -public class [FileVariable](index.md) : [Variable](../-variable/index.md) - -A variable type class for ModelCenter - -#### Author - -Woyak, 10/2001 - -## Functions - -| Name | Summary | -|---|---| -| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromFile](from-file.md) | public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
reads data from a file (same as readFile()). | -| [fromString](../-variable/from-string.md) | public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | -| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description text for the file | -| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | -| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | -| [getDirectTransfer](get-direct-transfer.md) | public [getDirectTransfer](get-direct-transfer.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets the directTransfer flag. | -| [getFileExtension](get-file-extension.md) | public [getFileExtension](get-file-extension.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the extension used for the file (used to associate the file with an application). | -| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | -| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | -| [getIsBinary](get-is-binary.md) | public [getIsBinary](get-is-binary.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets a flag indicating if the file contents are binary | -| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | -| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | -| [getSaveWithModel](get-save-with-model.md) | public [getSaveWithModel](get-save-with-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets a flag indicating that the value of the file should be saved with the model. | -| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | -| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | -| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | -| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | -| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | -| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | -| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | -| [readFile](read-file.md) | public [readFile](read-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
reads data from a file (same as fromFile()). | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setDescription](set-description.md) | public [setDescription](set-description.md)(desc: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description text for the file | -| [setDirectTransfer](set-direct-transfer.md) | public [setDirectTransfer](set-direct-transfer.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets the directTransfer flag. | -| [setFileExtension](set-file-extension.md) | public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the desired file extension for the file | -| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | -| [setIsBinary](set-is-binary.md) | public [setIsBinary](set-is-binary.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets a flag indicating that this variable contains binary data | -| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setSaveWithModel](set-save-with-model.md) | public [setSaveWithModel](set-save-with-model.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets a flag indicating that the value of the file should be saved with the model. | -| [toFile](to-file.md) | public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
writes out contents to a file (same as writeFile()). | -| [toFileAbsolute](to-file-absolute.md) | public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
writes out contents to a file without validating the variable (same as writeFile()).
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
writes out contents to a file without validating the variable. | -| [toString](../-variable/to-string.md) | public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [toStringAbsolute](../-variable/to-string-absolute.md) | public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | -| [writeFile](write-file.md) | public [writeFile](write-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
writes out contents to a file (same as toFile()). | -| [writeFileAbsolute](write-file-absolute.md) | public [writeFileAbsolute](write-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
writes out contents to a file without validating the variable (same as toFileAbsolute()). | +# FileVariable + + +public class [FileVariable](index.md) : [Variable](../-variable/index.md) + +A variable type class for ModelCenter + +#### Author + +Woyak, 10/2001 + +## Functions + +| Name | Summary | +|---|---| +| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromFile](from-file.md) | public [fromFile](from-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
reads data from a file (same as readFile()). | +| [fromString](../-variable/from-string.md) | public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | +| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description text for the file | +| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | +| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | +| [getDirectTransfer](get-direct-transfer.md) | public [getDirectTransfer](get-direct-transfer.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets the directTransfer flag. | +| [getFileExtension](get-file-extension.md) | public [getFileExtension](get-file-extension.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the extension used for the file (used to associate the file with an application). | +| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | +| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | +| [getIsBinary](get-is-binary.md) | public [getIsBinary](get-is-binary.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets a flag indicating if the file contents are binary | +| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | +| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | +| [getSaveWithModel](get-save-with-model.md) | public [getSaveWithModel](get-save-with-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets a flag indicating that the value of the file should be saved with the model. | +| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | +| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | +| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | +| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | +| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | +| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | +| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | +| [readFile](read-file.md) | public [readFile](read-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
reads data from a file (same as fromFile()). | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setDescription](set-description.md) | public [setDescription](set-description.md)(desc: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description text for the file | +| [setDirectTransfer](set-direct-transfer.md) | public [setDirectTransfer](set-direct-transfer.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets the directTransfer flag. | +| [setFileExtension](set-file-extension.md) | public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the desired file extension for the file | +| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | +| [setIsBinary](set-is-binary.md) | public [setIsBinary](set-is-binary.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets a flag indicating that this variable contains binary data | +| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setSaveWithModel](set-save-with-model.md) | public [setSaveWithModel](set-save-with-model.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets a flag indicating that the value of the file should be saved with the model. | +| [toFile](to-file.md) | public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
writes out contents to a file (same as writeFile()). | +| [toFileAbsolute](to-file-absolute.md) | public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
writes out contents to a file without validating the variable (same as writeFile()).
public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
writes out contents to a file without validating the variable. | +| [toString](../-variable/to-string.md) | public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [toStringAbsolute](../-variable/to-string-absolute.md) | public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | +| [writeFile](write-file.md) | public [writeFile](write-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
writes out contents to a file (same as toFile()). | +| [writeFileAbsolute](write-file-absolute.md) | public [writeFileAbsolute](write-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
writes out contents to a file without validating the variable (same as toFileAbsolute()). | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/read-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/read-file.md index cab5ac3a7c..a64ee9a15c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/read-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/read-file.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileVariable](index.md)/[readFile](read-file.md) - -# readFile - - -public [readFile](read-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -reads data from a file (same as fromFile()). - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to load | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# readFile + + +public [readFile](read-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +reads data from a file (same as fromFile()). + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to load | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-description.md index 6ceea303ba..77e978a4e1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-description.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileVariable](index.md)/[setDescription](set-description.md) - -# setDescription - - -public [setDescription](set-description.md)(desc: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the description text for the file - -#### Parameters - - - -| | | -|---|---| -| desc | the file description text, e.g. "this is an Excel File" | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDescription + + +public [setDescription](set-description.md)(desc: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the description text for the file + +#### Parameters + + + +| | | +|---|---| +| desc | the file description text, e.g. "this is an Excel File" | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-direct-transfer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-direct-transfer.md index 717357ca23..cb7e7dd0d2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-direct-transfer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-direct-transfer.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileVariable](index.md)/[setDirectTransfer](set-direct-transfer.md) - -# setDirectTransfer - - -public [setDirectTransfer](set-direct-transfer.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Sets the directTransfer flag. - -#### Parameters - - - -| | -|---| -| flag | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDirectTransfer + + +public [setDirectTransfer](set-direct-transfer.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Sets the directTransfer flag. + +#### Parameters + + + +| | +|---| +| flag | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-file-extension.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-file-extension.md index 31a206021d..9dc42c3637 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-file-extension.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-file-extension.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileVariable](index.md)/[setFileExtension](set-file-extension.md) - -# setFileExtension - - -public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the desired file extension for the file - -#### Parameters - - - -| | | -|---|---| -| ext | the file extension, e.g. ".xls" | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setFileExtension + + +public [setFileExtension](set-file-extension.md)(ext: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the desired file extension for the file + +#### Parameters + + + +| | | +|---|---| +| ext | the file extension, e.g. ".xls" | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-is-binary.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-is-binary.md index e3c7552afa..e57485f48a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-is-binary.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-is-binary.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileVariable](index.md)/[setIsBinary](set-is-binary.md) - -# setIsBinary - - -public [setIsBinary](set-is-binary.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets a flag indicating that this variable contains binary data - -#### Parameters - - - -| | | -|---|---| -| flag | true if the contents are binary | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setIsBinary + + +public [setIsBinary](set-is-binary.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets a flag indicating that this variable contains binary data + +#### Parameters + + + +| | | +|---|---| +| flag | true if the contents are binary | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-save-with-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-save-with-model.md index 54bd89c076..d33f921380 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-save-with-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-save-with-model.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileVariable](index.md)/[setSaveWithModel](set-save-with-model.md) - -# setSaveWithModel - - -public [setSaveWithModel](set-save-with-model.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Sets a flag indicating that the value of the file should be saved with the model. The flag only applies to output files. - -#### Parameters - - - -| | -|---| -| flag | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setSaveWithModel + + +public [setSaveWithModel](set-save-with-model.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Sets a flag indicating that the value of the file should be saved with the model. The flag only applies to output files. + +#### Parameters + + + +| | +|---| +| flag | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/to-file-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/to-file-absolute.md index ec82f99c27..ae54be356a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/to-file-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/to-file-absolute.md @@ -1,42 +1,40 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileVariable](index.md)/[toFileAbsolute](to-file-absolute.md) - -# toFileAbsolute - - -public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -writes out contents to a file without validating the variable (same as writeFile()). - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to write to | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -writes out contents to a file without validating the variable. Will throw an exception if binary encoding is used on a text file and vice-vera. (same as writeFile()). - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to write to | -| encoding | how to encode the file on disk | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toFileAbsolute + + +public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +writes out contents to a file without validating the variable (same as writeFile()). + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to write to | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [toFileAbsolute](to-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +writes out contents to a file without validating the variable. Will throw an exception if binary encoding is used on a text file and vice-vera. (same as writeFile()). + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to write to | +| encoding | how to encode the file on disk | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/to-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/to-file.md index c1f8a5a473..69acaaddb6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/to-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/to-file.md @@ -1,42 +1,40 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileVariable](index.md)/[toFile](to-file.md) - -# toFile - - -public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -writes out contents to a file (same as writeFile()). - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to write to | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -writes out contents to a file (same as writeFile()). Encoding can be ASCII, UTF-8, or binary. If encoding string is blank, will default to ASCII encoding for text files and binary encoding for binary files. Will throw an exception if binary encoding is used on a text file and vice-vera. - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to write to | -| encoding | how to encode the file on disk: 'ascii', 'utf-8', or 'binary'. | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toFile + + +public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +writes out contents to a file (same as writeFile()). + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to write to | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [toFile](to-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +writes out contents to a file (same as writeFile()). Encoding can be ASCII, UTF-8, or binary. If encoding string is blank, will default to ASCII encoding for text files and binary encoding for binary files. Will throw an exception if binary encoding is used on a text file and vice-vera. + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to write to | +| encoding | how to encode the file on disk: 'ascii', 'utf-8', or 'binary'. | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/write-file-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/write-file-absolute.md index 98a5f51ef5..57e0b420fe 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/write-file-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/write-file-absolute.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileVariable](index.md)/[writeFileAbsolute](write-file-absolute.md) - -# writeFileAbsolute - - -public [writeFileAbsolute](write-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -writes out contents to a file without validating the variable (same as toFileAbsolute()). - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to write to | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# writeFileAbsolute + + +public [writeFileAbsolute](write-file-absolute.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +writes out contents to a file without validating the variable (same as toFileAbsolute()). + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to write to | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/write-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/write-file.md index c3f92afaea..9d54f55a78 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/write-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-file-variable/write-file.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[FileVariable](index.md)/[writeFile](write-file.md) - -# writeFile - - -public [writeFile](write-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -writes out contents to a file (same as toFile()). - -#### Parameters - - - -| | | -|---|---| -| fileName | the file to write to | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# writeFile + + +public [writeFile](write-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +writes out contents to a file (same as toFile()). + +#### Parameters + + + +| | | +|---|---| +| fileName | the file to write to | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/double-to-editable-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/double-to-editable-string.md index 4da049b7e8..0d8e5cc534 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/double-to-editable-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/double-to-editable-string.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format](index.md)/[doubleToEditableString](double-to-editable-string.md) - -# doubleToEditableString - - -public [doubleToEditableString](double-to-editable-string.md)(val: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Converts a double to its formatted string representation but with full precision for editing - -#### Return - -the resultant string representation - -#### Parameters - - - -| | | -|---|---| -| val | the real to convert | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# doubleToEditableString + + +public [doubleToEditableString](double-to-editable-string.md)(val: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Converts a double to its formatted string representation but with full precision for editing + +#### Return + +the resultant string representation + +#### Parameters + + + +| | | +|---|---| +| val | the real to convert | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/double-to-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/double-to-string.md index 123ab1e2a0..61c8e01d31 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/double-to-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/double-to-string.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format](index.md)/[doubleToString](double-to-string.md) - -# doubleToString - - -public [doubleToString](double-to-string.md)(val: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Converts a double to its formatted string representation - -#### Return - -the resultant string representation - -#### Parameters - - - -| | | -|---|---| -| val | the real to convert | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# doubleToString + + +public [doubleToString](double-to-string.md)(val: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Converts a double to its formatted string representation + +#### Return + +the resultant string representation + +#### Parameters + + + +| | | +|---|---| +| val | the real to convert | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/get-format.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/get-format.md index 084b832310..1b9d77f6c4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/get-format.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/get-format.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format](index.md)/[getFormat](get-format.md) - -# getFormat - - -public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Return to format's string representation - -#### Return - -the format's string representation - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getFormat + + +public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Return to format's string representation + +#### Return + +the format's string representation + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/index.md index 8811834a9a..c664afb1ea 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/index.md @@ -1,30 +1,28 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format](index.md) - -# Format - - -public class [Format](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -This is the wrapper class for formatting - -#### Author - -Fraley, 1-2004 - -## Functions - -| Name | Summary | -|---|---| -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [doubleToEditableString](double-to-editable-string.md) | public [doubleToEditableString](double-to-editable-string.md)(val: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a double to its formatted string representation but with full precision for editing | -| [doubleToString](double-to-string.md) | public [doubleToString](double-to-string.md)(val: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a double to its formatted string representation | -| [getFormat](get-format.md) | public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Return to format's string representation | -| [longToEditableString](long-to-editable-string.md) | public [longToEditableString](long-to-editable-string.md)(val: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a long to its formatted string representation but with full precision for editing | -| [longToString](long-to-string.md) | public [longToString](long-to-string.md)(val: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a long to its formatted string representation | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setFormat](set-format.md) | public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the format string | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [stringToDouble](string-to-double.md) | public [stringToDouble](string-to-double.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Converts a string representing a number in the given format to a real number | -| [stringToLong](string-to-long.md) | public [stringToLong](string-to-long.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Converts a string representing a number in the given format to an integer number | -| [stringToString](string-to-string.md) | public [stringToString](string-to-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a string to its formatted string representation | +# Format + + +public class [Format](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +This is the wrapper class for formatting + +#### Author + +Fraley, 1-2004 + +## Functions + +| Name | Summary | +|---|---| +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [doubleToEditableString](double-to-editable-string.md) | public [doubleToEditableString](double-to-editable-string.md)(val: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a double to its formatted string representation but with full precision for editing | +| [doubleToString](double-to-string.md) | public [doubleToString](double-to-string.md)(val: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a double to its formatted string representation | +| [getFormat](get-format.md) | public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Return to format's string representation | +| [longToEditableString](long-to-editable-string.md) | public [longToEditableString](long-to-editable-string.md)(val: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a long to its formatted string representation but with full precision for editing | +| [longToString](long-to-string.md) | public [longToString](long-to-string.md)(val: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a long to its formatted string representation | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setFormat](set-format.md) | public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the format string | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [stringToDouble](string-to-double.md) | public [stringToDouble](string-to-double.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Converts a string representing a number in the given format to a real number | +| [stringToLong](string-to-long.md) | public [stringToLong](string-to-long.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Converts a string representing a number in the given format to an integer number | +| [stringToString](string-to-string.md) | public [stringToString](string-to-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a string to its formatted string representation | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/long-to-editable-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/long-to-editable-string.md index 9da98281b0..26b897a549 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/long-to-editable-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/long-to-editable-string.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format](index.md)/[longToEditableString](long-to-editable-string.md) - -# longToEditableString - - -public [longToEditableString](long-to-editable-string.md)(val: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Converts a long to its formatted string representation but with full precision for editing - -#### Return - -the resultant string representation - -#### Parameters - - - -| | | -|---|---| -| val | the integer to convert | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# longToEditableString + + +public [longToEditableString](long-to-editable-string.md)(val: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Converts a long to its formatted string representation but with full precision for editing + +#### Return + +the resultant string representation + +#### Parameters + + + +| | | +|---|---| +| val | the integer to convert | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/long-to-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/long-to-string.md index 2ccbdf2103..a9400dc592 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/long-to-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/long-to-string.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format](index.md)/[longToString](long-to-string.md) - -# longToString - - -public [longToString](long-to-string.md)(val: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Converts a long to its formatted string representation - -#### Return - -the resultant string representation - -#### Parameters - - - -| | | -|---|---| -| val | the integer to convert | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# longToString + + +public [longToString](long-to-string.md)(val: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Converts a long to its formatted string representation + +#### Return + +the resultant string representation + +#### Parameters + + + +| | | +|---|---| +| val | the integer to convert | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/set-format.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/set-format.md index 839b3c469e..37920815e7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/set-format.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/set-format.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format](index.md)/[setFormat](set-format.md) - -# setFormat - - -public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the format string - -#### Parameters - - - -| | | -|---|---| -| format | the format string to set | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setFormat + + +public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the format string + +#### Parameters + + + +| | | +|---|---| +| format | the format string to set | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/string-to-double.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/string-to-double.md index afcb4000d2..88efa5ea85 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/string-to-double.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/string-to-double.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format](index.md)/[stringToDouble](string-to-double.md) - -# stringToDouble - - -public [stringToDouble](string-to-double.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -Converts a string representing a number in the given format to a real number - -#### Return - -the resultant real - -#### Parameters - - - -| | | -|---|---| -| str | the string to convert | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# stringToDouble + + +public [stringToDouble](string-to-double.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +Converts a string representing a number in the given format to a real number + +#### Return + +the resultant real + +#### Parameters + + + +| | | +|---|---| +| str | the string to convert | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/string-to-long.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/string-to-long.md index a2f76a6a8d..58e0da39c4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/string-to-long.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/string-to-long.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format](index.md)/[stringToLong](string-to-long.md) - -# stringToLong - - -public [stringToLong](string-to-long.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -Converts a string representing a number in the given format to an integer number - -#### Return - -the resultant integer - -#### Parameters - - - -| | | -|---|---| -| str | the string to convert | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# stringToLong + + +public [stringToLong](string-to-long.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +Converts a string representing a number in the given format to an integer number + +#### Return + +the resultant integer + +#### Parameters + + + +| | | +|---|---| +| str | the string to convert | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/string-to-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/string-to-string.md index 03d272d890..c198f1dce8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/string-to-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format/string-to-string.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format](index.md)/[stringToString](string-to-string.md) - -# stringToString - - -public [stringToString](string-to-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Converts a string to its formatted string representation - -#### Return - -the resultant string representation - -#### Parameters - - - -| | | -|---|---| -| str | the string to convert | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# stringToString + + +public [stringToString](string-to-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Converts a string to its formatted string representation + +#### Return + +the resultant string representation + +#### Parameters + + + +| | | +|---|---| +| str | the string to convert | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/-format2.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/-format2.md index 06476eaf9f..e1266cb61f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/-format2.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/-format2.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format2](index.md)/[Format2](-format2.md) - -# Format2 - - -constructor(strFormat: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -constructor() +# Format2 + + +constructor(strFormat: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +constructor() diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/_set-format.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/_set-format.md index 18934b1707..cba86a9457 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/_set-format.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/_set-format.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format2](index.md)/[_setFormat](_set-format.md) - -# _setFormat - - -public [_setFormat](_set-format.md)(strFormat: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the format string - -#### Parameters - - - -| | | -|---|---| -| strFormat | the format string to set | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# _setFormat + + +public [_setFormat](_set-format.md)(strFormat: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the format string + +#### Parameters + + + +| | | +|---|---| +| strFormat | the format string to set | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/double-to-editable-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/double-to-editable-string.md index 20236cf232..0d8e5cc534 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/double-to-editable-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/double-to-editable-string.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format2](index.md)/[doubleToEditableString](double-to-editable-string.md) - -# doubleToEditableString - - -public [doubleToEditableString](double-to-editable-string.md)(val: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Converts a double to its formatted string representation but with full precision for editing - -#### Return - -the resultant string representation - -#### Parameters - - - -| | | -|---|---| -| val | the real to convert | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# doubleToEditableString + + +public [doubleToEditableString](double-to-editable-string.md)(val: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Converts a double to its formatted string representation but with full precision for editing + +#### Return + +the resultant string representation + +#### Parameters + + + +| | | +|---|---| +| val | the real to convert | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/double-to-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/double-to-string.md index 3bc9126f33..61c8e01d31 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/double-to-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/double-to-string.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format2](index.md)/[doubleToString](double-to-string.md) - -# doubleToString - - -public [doubleToString](double-to-string.md)(val: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Converts a double to its formatted string representation - -#### Return - -the resultant string representation - -#### Parameters - - - -| | | -|---|---| -| val | the real to convert | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# doubleToString + + +public [doubleToString](double-to-string.md)(val: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Converts a double to its formatted string representation + +#### Return + +the resultant string representation + +#### Parameters + + + +| | | +|---|---| +| val | the real to convert | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/index.md index 141d40e11f..8ca4506f0b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/index.md @@ -1,31 +1,29 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format2](index.md) - -# Format2 - - -public class [Format2](index.md) - -This is the wrapper class for formatting. This second iteration does not use the COM API under the hood and is safe to use in some cases when COM is not. - -#### Author - -Gaurav, 2010 - -## Constructors - -| | | -|---|---| -| [Format2](-format2.md) | constructor(strFormat: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))constructor() | - -## Functions - -| Name | Summary | -|---|---| -| [_setFormat](_set-format.md) | public [_setFormat](_set-format.md)(strFormat: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the format string | -| [doubleToEditableString](double-to-editable-string.md) | public [doubleToEditableString](double-to-editable-string.md)(val: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a double to its formatted string representation but with full precision for editing | -| [doubleToString](double-to-string.md) | public [doubleToString](double-to-string.md)(val: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a double to its formatted string representation | -| [longToEditableString](long-to-editable-string.md) | public [longToEditableString](long-to-editable-string.md)(val: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a long to its formatted string representation but with full precision for editing | -| [longToString](long-to-string.md) | public [longToString](long-to-string.md)(val: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a long to its formatted string representation | -| [stringToDouble](string-to-double.md) | public [stringToDouble](string-to-double.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Converts a string representing a number in the given format to a real number | -| [stringToLong](string-to-long.md) | public [stringToLong](string-to-long.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Converts a string representing a number in the given format to an integer number | -| [stringToString](string-to-string.md) | public [stringToString](string-to-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a string to its formatted string representation | +# Format2 + + +public class [Format2](index.md) + +This is the wrapper class for formatting. This second iteration does not use the COM API under the hood and is safe to use in some cases when COM is not. + +#### Author + +Gaurav, 2010 + +## Constructors + +| | | +|---|---| +| [Format2](-format2.md) | constructor(strFormat: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))constructor() | + +## Functions + +| Name | Summary | +|---|---| +| [_setFormat](_set-format.md) | public [_setFormat](_set-format.md)(strFormat: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the format string | +| [doubleToEditableString](double-to-editable-string.md) | public [doubleToEditableString](double-to-editable-string.md)(val: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a double to its formatted string representation but with full precision for editing | +| [doubleToString](double-to-string.md) | public [doubleToString](double-to-string.md)(val: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a double to its formatted string representation | +| [longToEditableString](long-to-editable-string.md) | public [longToEditableString](long-to-editable-string.md)(val: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a long to its formatted string representation but with full precision for editing | +| [longToString](long-to-string.md) | public [longToString](long-to-string.md)(val: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a long to its formatted string representation | +| [stringToDouble](string-to-double.md) | public [stringToDouble](string-to-double.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Converts a string representing a number in the given format to a real number | +| [stringToLong](string-to-long.md) | public [stringToLong](string-to-long.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Converts a string representing a number in the given format to an integer number | +| [stringToString](string-to-string.md) | public [stringToString](string-to-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts a string to its formatted string representation | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/long-to-editable-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/long-to-editable-string.md index 55f5ced007..26b897a549 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/long-to-editable-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/long-to-editable-string.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format2](index.md)/[longToEditableString](long-to-editable-string.md) - -# longToEditableString - - -public [longToEditableString](long-to-editable-string.md)(val: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Converts a long to its formatted string representation but with full precision for editing - -#### Return - -the resultant string representation - -#### Parameters - - - -| | | -|---|---| -| val | the integer to convert | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# longToEditableString + + +public [longToEditableString](long-to-editable-string.md)(val: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Converts a long to its formatted string representation but with full precision for editing + +#### Return + +the resultant string representation + +#### Parameters + + + +| | | +|---|---| +| val | the integer to convert | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/long-to-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/long-to-string.md index 485ecc2ec1..a9400dc592 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/long-to-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/long-to-string.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format2](index.md)/[longToString](long-to-string.md) - -# longToString - - -public [longToString](long-to-string.md)(val: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Converts a long to its formatted string representation - -#### Return - -the resultant string representation - -#### Parameters - - - -| | | -|---|---| -| val | the integer to convert | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# longToString + + +public [longToString](long-to-string.md)(val: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Converts a long to its formatted string representation + +#### Return + +the resultant string representation + +#### Parameters + + + +| | | +|---|---| +| val | the integer to convert | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/string-to-double.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/string-to-double.md index 2e176f3dcd..88efa5ea85 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/string-to-double.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/string-to-double.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format2](index.md)/[stringToDouble](string-to-double.md) - -# stringToDouble - - -public [stringToDouble](string-to-double.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -Converts a string representing a number in the given format to a real number - -#### Return - -the resultant real - -#### Parameters - - - -| | | -|---|---| -| str | the string to convert | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# stringToDouble + + +public [stringToDouble](string-to-double.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +Converts a string representing a number in the given format to a real number + +#### Return + +the resultant real + +#### Parameters + + + +| | | +|---|---| +| str | the string to convert | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/string-to-long.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/string-to-long.md index 6b67d0e3e5..58e0da39c4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/string-to-long.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/string-to-long.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format2](index.md)/[stringToLong](string-to-long.md) - -# stringToLong - - -public [stringToLong](string-to-long.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -Converts a string representing a number in the given format to an integer number - -#### Return - -the resultant integer - -#### Parameters - - - -| | | -|---|---| -| str | the string to convert | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# stringToLong + + +public [stringToLong](string-to-long.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +Converts a string representing a number in the given format to an integer number + +#### Return + +the resultant integer + +#### Parameters + + + +| | | +|---|---| +| str | the string to convert | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/string-to-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/string-to-string.md index 76d9553392..c198f1dce8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/string-to-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-format2/string-to-string.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Format2](index.md)/[stringToString](string-to-string.md) - -# stringToString - - -public [stringToString](string-to-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Converts a string to its formatted string representation - -#### Return - -the resultant string representation - -#### Parameters - - - -| | | -|---|---| -| str | the string to convert | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# stringToString + + +public [stringToString](string-to-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Converts a string to its formatted string representation + +#### Return + +the resultant string representation + +#### Parameters + + + +| | | +|---|---| +| str | the string to convert | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/get-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/get-description.md index c86c093318..f0c010045f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/get-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/get-description.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[GeometryVariable](index.md)/[getDescription](get-description.md) - -# getDescription - - -public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the description for the variable - -#### Return - -the description of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDescription + + +public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the description for the variable + +#### Return + +the description of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/get-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/get-value.md index 67023bc41a..f2aa424a85 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/get-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/get-value.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[GeometryVariable](index.md)/[getValue](get-value.md) - -# getValue - - -public [getValue](get-value.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable - -#### Return - -the value of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValue + + +public [getValue](get-value.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable + +#### Return + +the value of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/index.md index dfc011e313..646d432c7e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/index.md @@ -1,48 +1,46 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[GeometryVariable](index.md) - -# GeometryVariable - - -public class [GeometryVariable](index.md) : [Variable](../-variable/index.md) - -A variable type class for ModelCenter - -#### Author - -Woyak, 9/2001 - -## Functions - -| Name | Summary | -|---|---| -| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromString](../-variable/from-string.md) | public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | -| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | -| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | -| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | -| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | -| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | -| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | -| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | -| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | -| [getValue](get-value.md) | public [getValue](get-value.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the value of the variable | -| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | -| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | -| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | -| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | -| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | -| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | -| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | -| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setValue](set-value.md) | public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value of the variable | -| [toString](../-variable/to-string.md) | public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [toStringAbsolute](../-variable/to-string-absolute.md) | public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | +# GeometryVariable + + +public class [GeometryVariable](index.md) : [Variable](../-variable/index.md) + +A variable type class for ModelCenter + +#### Author + +Woyak, 9/2001 + +## Functions + +| Name | Summary | +|---|---| +| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromString](../-variable/from-string.md) | public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | +| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | +| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | +| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | +| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | +| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | +| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | +| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | +| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | +| [getValue](get-value.md) | public [getValue](get-value.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the value of the variable | +| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | +| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | +| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | +| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | +| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | +| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | +| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | +| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setValue](set-value.md) | public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value of the variable | +| [toString](../-variable/to-string.md) | public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [toStringAbsolute](../-variable/to-string-absolute.md) | public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/set-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/set-description.md index f610220400..0147b158ab 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/set-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/set-description.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[GeometryVariable](index.md)/[setDescription](set-description.md) - -# setDescription - - -public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the description for the variable - -#### Parameters - - - -| | | -|---|---| -| description | the description of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDescription + + +public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the description for the variable + +#### Parameters + + + +| | | +|---|---| +| description | the description of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/set-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/set-value.md index 151ab41f11..3210ea5545 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/set-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/set-value.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[GeometryVariable](index.md)/[setValue](set-value.md) - -# setValue - - -public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the value of the variable - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setValue + + +public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the value of the variable + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/get-count.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/get-count.md index 314f0ffddc..8ed001efcc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/get-count.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/get-count.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[GlobalParameters](index.md)/[getCount](get-count.md) - -# getCount - - -public [getCount](get-count.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -Returns the number of global parameters set +# getCount + + +public [getCount](get-count.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Returns the number of global parameters set diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/get-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/get-value.md index 90b90c16fc..9d3860c062 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/get-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/get-value.md @@ -1,29 +1,27 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[GlobalParameters](index.md)/[getValue](get-value.md) - -# getValue - - -public [getValue](get-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -Gets the value of a global parameter - -#### Parameters - - - -| | | -|---|---| -| index | Get the n'th (zero based) global parameter. The index isnot guarunteed to stay the same over time. | - - -public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -Gets the value of a global parameter - -#### Parameters - - - -| | | -|---|---| -| index | The name of the global parameter to retrieve | +# getValue + + +public [getValue](get-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Gets the value of a global parameter + +#### Parameters + + + +| | | +|---|---| +| index | Get the n'th (zero based) global parameter. The index isnot guarunteed to stay the same over time. | + + +public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Gets the value of a global parameter + +#### Parameters + + + +| | | +|---|---| +| index | The name of the global parameter to retrieve | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/index.md index d31b6f5714..5f0c071ea6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/index.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[GlobalParameters](index.md) - -# GlobalParameters - - -public class [GlobalParameters](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -Global Parameters is a hashtable of values that can be set via the ModelCenter API and used for any purpose the client desires. As a rule of practice to avoid conflicts, parameters should be named with a namespace prefix and a colon, such as "phx:CenterLinkServer". Global Parameters have a boolean flag which indicates whether the value should be passed along to external components, such as Analysis Server tools. Global parameters are saved at the ModelCenter level and as such are not stored across ModelCenter being closed/reopened, but are kept across file close/new file open in a single session. - -#### Author - -Sharp - -## Functions - -| Name | Summary | -|---|---| -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [getCount](get-count.md) | public [getCount](get-count.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns the number of global parameters set | -| [getValue](get-value.md) | public [getValue](get-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Gets the value of a global parameter | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [remove](remove.md) | public [remove](remove.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
public [remove](remove.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Removes a global parameter | -| [setExportToRemoteComponents](set-export-to-remote-components.md) | public [setExportToRemoteComponents](set-export-to-remote-components.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), export: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
public [setExportToRemoteComponents](set-export-to-remote-components.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), export: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets the flag that determines if a global parameter should be exported to all remote components. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setValue](set-value.md) | public [setValue](set-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
public [setValue](set-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
Sets the value of a global parameter. | +# GlobalParameters + + +public class [GlobalParameters](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +Global Parameters is a hashtable of values that can be set via the ModelCenter API and used for any purpose the client desires. As a rule of practice to avoid conflicts, parameters should be named with a namespace prefix and a colon, such as "phx:CenterLinkServer". Global Parameters have a boolean flag which indicates whether the value should be passed along to external components, such as Analysis Server tools. Global parameters are saved at the ModelCenter level and as such are not stored across ModelCenter being closed/reopened, but are kept across file close/new file open in a single session. + +#### Author + +Sharp + +## Functions + +| Name | Summary | +|---|---| +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [getCount](get-count.md) | public [getCount](get-count.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns the number of global parameters set | +| [getValue](get-value.md) | public [getValue](get-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Gets the value of a global parameter | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [remove](remove.md) | public [remove](remove.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
public [remove](remove.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Removes a global parameter | +| [setExportToRemoteComponents](set-export-to-remote-components.md) | public [setExportToRemoteComponents](set-export-to-remote-components.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), export: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
public [setExportToRemoteComponents](set-export-to-remote-components.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), export: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets the flag that determines if a global parameter should be exported to all remote components. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setValue](set-value.md) | public [setValue](set-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
public [setValue](set-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
Sets the value of a global parameter. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/remove.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/remove.md index 75533d9c76..ff742c6c4d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/remove.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/remove.md @@ -1,29 +1,27 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[GlobalParameters](index.md)/[remove](remove.md) - -# remove - - -public [remove](remove.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -Removes a global parameter - -#### Parameters - - - -| | | -|---|---| -| index | The 0 based index of the parameter to remove | - - -public [remove](remove.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Removes a global parameter - -#### Parameters - - - -| | | -|---|---| -| index | The name of the parameter to remove | +# remove + + +public [remove](remove.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +Removes a global parameter + +#### Parameters + + + +| | | +|---|---| +| index | The 0 based index of the parameter to remove | + + +public [remove](remove.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Removes a global parameter + +#### Parameters + + + +| | | +|---|---| +| index | The name of the parameter to remove | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/set-export-to-remote-components.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/set-export-to-remote-components.md index 1faa296cef..cf67e6beb3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/set-export-to-remote-components.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/set-export-to-remote-components.md @@ -1,29 +1,27 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[GlobalParameters](index.md)/[setExportToRemoteComponents](set-export-to-remote-components.md) - -# setExportToRemoteComponents - - -public [setExportToRemoteComponents](set-export-to-remote-components.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), export: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Sets the flag that determines if a global parameter should be exported to all remote components. - -#### Parameters - - - -| | | -|---|---| -| index | The 0 based index of the parameter to set | - - -public [setExportToRemoteComponents](set-export-to-remote-components.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), export: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Sets the flag that determines if a global parameter should be exported to all remote components. - -#### Parameters - - - -| | | -|---|---| -| index | The name of the parameter to set | +# setExportToRemoteComponents + + +public [setExportToRemoteComponents](set-export-to-remote-components.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), export: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Sets the flag that determines if a global parameter should be exported to all remote components. + +#### Parameters + + + +| | | +|---|---| +| index | The 0 based index of the parameter to set | + + +public [setExportToRemoteComponents](set-export-to-remote-components.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), export: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Sets the flag that determines if a global parameter should be exported to all remote components. + +#### Parameters + + + +| | | +|---|---| +| index | The name of the parameter to set | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/set-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/set-value.md index 23919bd09d..1614048d55 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/set-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-global-parameters/set-value.md @@ -1,29 +1,27 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[GlobalParameters](index.md)/[setValue](set-value.md) - -# setValue - - -public [setValue](set-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)) - -Sets the value of a global parameter. Creates the parameter if it doesn't exist. - -#### Parameters - - - -| | | -|---|---| -| index | The name of the global parameter to create or set | - - -public [setValue](set-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)) - -Sets the value of a global parameter. Will not creates the parameter if it doesn't exist. - -#### Parameters - - - -| | | -|---|---| -| index | The 0 based index of the parameter to set | +# setValue + + +public [setValue](set-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)) + +Sets the value of a global parameter. Creates the parameter if it doesn't exist. + +#### Parameters + + + +| | | +|---|---| +| index | The name of the global parameter to create or set | + + +public [setValue](set-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)) + +Sets the value of a global parameter. Will not creates the parameter if it doesn't exist. + +#### Parameters + + + +| | | +|---|---| +| index | The 0 based index of the parameter to set | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-full-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-full-name.md index 7b28f3cd36..713c6cd197 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-full-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-full-name.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Group](index.md)/[getFullName](get-full-name.md) - -# getFullName - - -public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the full name of the current object, e.g. "Model.Script.x" - -#### Return - -the object name - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getFullName + + +public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the full name of the current object, e.g. "Model.Script.x" + +#### Return + +the object name + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-group.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-group.md index 1abea1633e..628ac0c09d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-group.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-group.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Group](index.md)/[getGroup](get-group.md) - -# getGroup - - -public [getGroup](get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](index.md) - -gets the specified group - -#### Return - -the specified group - -#### Parameters - - - -| | | -|---|---| -| index | the group index (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getGroup](get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](index.md) - -gets the specified group - -#### Return - -the specified group - -#### Parameters - - - -| | | -|---|---| -| name | the variable name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getGroup + + +public [getGroup](get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](index.md) + +gets the specified group + +#### Return + +the specified group + +#### Parameters + + + +| | | +|---|---| +| index | the group index (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getGroup](get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](index.md) + +gets the specified group + +#### Return + +the specified group + +#### Parameters + + + +| | | +|---|---| +| name | the variable name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-icon-i-d.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-icon-i-d.md index 6d232605d4..18386ce17a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-icon-i-d.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-icon-i-d.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Group](index.md)/[getIconID](get-icon-i-d.md) - -# getIconID - - -public [getIconID](get-icon-i-d.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -Gets the icon id for the icon displayed for this Assembly - -#### Return - -the id of the icon +# getIconID + + +public [getIconID](get-icon-i-d.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Gets the icon id for the icon displayed for this Assembly + +#### Return + +the id of the icon diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-name.md index 6f8025a4d4..b3bd82ad9c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-name.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Group](index.md)/[getName](get-name.md) - -# getName - - -public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the name of the current object, e.g. "x" - -#### Return - -the object name - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getName + + +public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the name of the current object, e.g. "x" + +#### Return + +the object name + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-num-groups.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-num-groups.md index b315b6e66e..fadeac32cb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-num-groups.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-num-groups.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Group](index.md)/[getNumGroups](get-num-groups.md) - -# getNumGroups - - -public [getNumGroups](get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -get the number of groups stored in this object - -#### Return - -the number of stored groups - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumGroups + + +public [getNumGroups](get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +get the number of groups stored in this object + +#### Return + +the number of stored groups + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-num-variables.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-num-variables.md index ed322c9d8c..1985ce264e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-num-variables.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-num-variables.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Group](index.md)/[getNumVariables](get-num-variables.md) - -# getNumVariables - - -public [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -get the number of variables stored in this object - -#### Return - -the number of stored variables - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumVariables + + +public [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +get the number of variables stored in this object + +#### Return + +the number of stored variables + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-variable.md index d557ae4f05..a25ec5e8b6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/get-variable.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Group](index.md)/[getVariable](get-variable.md) - -# getVariable - - -public [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md) - -gets the specified variable - -#### Return - -the specified variable - -#### Parameters - - - -| | | -|---|---| -| index | the variable index (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) - -gets the specified variable - -#### Return - -the specified variable - -#### Parameters - - - -| | | -|---|---| -| name | the variable name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getVariable + + +public [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md) + +gets the specified variable + +#### Return + +the specified variable + +#### Parameters + + + +| | | +|---|---| +| index | the variable index (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) + +gets the specified variable + +#### Return + +the specified variable + +#### Parameters + + + +| | | +|---|---| +| name | the variable name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/index.md index 64a30404ac..4eb1dbc809 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/index.md @@ -1,29 +1,27 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Group](index.md) - -# Group - - -public class [Group](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [IVariableHolder](../-i-variable-holder/index.md) - -This is the wrapper class that handles the native COM calls to a Registry object. The class is used by Java plug-ins to ModelCenter. - -#### Author - -Woyak, 9-01 - -## Functions - -| Name | Summary | -|---|---| -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [getFullName](get-full-name.md) | public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the full name of the current object, e.g. | -| [getGroup](get-group.md) | public [getGroup](get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](index.md)
public [getGroup](get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](index.md)
gets the specified group | -| [getIconID](get-icon-i-d.md) | public [getIconID](get-icon-i-d.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the icon id for the icon displayed for this Assembly | -| [getName](get-name.md) | public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the current object, e.g. | -| [getNumGroups](get-num-groups.md) | public [getNumGroups](get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of groups stored in this object | -| [getNumVariables](get-num-variables.md) | public [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of variables stored in this object | -| [getVariable](get-variable.md) | public [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
public [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
gets the specified variable | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setIconID](set-icon-i-d.md) | public [setIconID](set-icon-i-d.md)(iconID: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
specified the icon for use with this Group. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +# Group + + +public class [Group](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [IVariableHolder](../-i-variable-holder/index.md) + +This is the wrapper class that handles the native COM calls to a Registry object. The class is used by Java plug-ins to ModelCenter. + +#### Author + +Woyak, 9-01 + +## Functions + +| Name | Summary | +|---|---| +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [getFullName](get-full-name.md) | public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the full name of the current object, e.g. | +| [getGroup](get-group.md) | public [getGroup](get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](index.md)
public [getGroup](get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](index.md)
gets the specified group | +| [getIconID](get-icon-i-d.md) | public [getIconID](get-icon-i-d.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the icon id for the icon displayed for this Assembly | +| [getName](get-name.md) | public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the current object, e.g. | +| [getNumGroups](get-num-groups.md) | public [getNumGroups](get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of groups stored in this object | +| [getNumVariables](get-num-variables.md) | public [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of variables stored in this object | +| [getVariable](get-variable.md) | public [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
public [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
gets the specified variable | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setIconID](set-icon-i-d.md) | public [setIconID](set-icon-i-d.md)(iconID: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
specified the icon for use with this Group. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/set-icon-i-d.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/set-icon-i-d.md index b8ff054cbe..cd57920dae 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/set-icon-i-d.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-group/set-icon-i-d.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Group](index.md)/[setIconID](set-icon-i-d.md) - -# setIconID - - -public [setIconID](set-icon-i-d.md)(iconID: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -specified the icon for use with this Group. The icon must be first registered with ModelCenter using the IModelCenter.addIcon() function - -#### Parameters - - - -| | | -|---|---| -| iconID | the id of the icon. -1 for the default icon | +# setIconID + + +public [setIconID](set-icon-i-d.md)(iconID: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +specified the icon for use with this Group. The icon must be first registered with ModelCenter using the IModelCenter.addIcon() function + +#### Parameters + + + +| | | +|---|---| +| iconID | the id of the icon. -1 for the default icon | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/construct.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/construct.md index 59c72006cf..f5ee25e890 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/construct.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/construct.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IComponentPlugIn](index.md)/[construct](construct.md) - -# construct - - -abstract fun [construct](construct.md)(mc: [ModelCenter](../-model-center/index.md), atm: [AddToModel](../-add-to-model/index.md)) - -called when the plug-in is launched from ModelCenter - -#### Parameters - - - -| | | -|---|---| -| mc | the ModelCenter object | -| atm | the AddToModel API object | - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# construct + + +abstract fun [construct](construct.md)(mc: [ModelCenter](../-model-center/index.md), atm: [AddToModel](../-add-to-model/index.md)) + +called when the plug-in is launched from ModelCenter + +#### Parameters + + + +| | | +|---|---| +| mc | the ModelCenter object | +| atm | the AddToModel API object | + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/from-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/from-string.md index b199d96121..1d96a5628c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/from-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/from-string.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IComponentPlugIn](index.md)/[fromString](from-string.md) - -# fromString - - -abstract fun [fromString](from-string.md)(state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Called to restore the state of a Plug-In. Should be able to restore the state from whatever string is returned by [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--). - -#### Parameters - - - -| | | -|---|---| -| state | the state string | - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# fromString + + +abstract fun [fromString](from-string.md)(state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Called to restore the state of a Plug-In. Should be able to restore the state from whatever string is returned by [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--). + +#### Parameters + + + +| | | +|---|---| +| state | the state string | + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/index.md index 93274d0dba..44031fb078 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/index.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IComponentPlugIn](index.md) - -# IComponentPlugIn - - -interface [IComponentPlugIn](index.md) - -This is the interface that must be implemented by all Java plug-ins for ModelCenter. Please note that due to an issue in Java 8, we do not explicitly override [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) here, but you still need to implement it. - -## Functions - -| Name | Summary | -|---|---| -| [construct](construct.md) | abstract fun [construct](construct.md)(mc: [ModelCenter](../-model-center/index.md), atm: [AddToModel](../-add-to-model/index.md))
called when the plug-in is launched from ModelCenter | -| [fromString](from-string.md) | abstract fun [fromString](from-string.md)(state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Called to restore the state of a Plug-In. | -| [onEnd](on-end.md) | abstract fun [onEnd](on-end.md)()
called when the plug-in is about to be deleted. | -| [run](run.md) | abstract fun [run](run.md)()
called when the plug-in should run | -| [show](show.md) | abstract fun [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
called to display the plug-in | +# IComponentPlugIn + + +interface [IComponentPlugIn](index.md) + +This is the interface that must be implemented by all Java plug-ins for ModelCenter. Please note that due to an issue in Java 8, we do not explicitly override [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) here, but you still need to implement it. + +## Functions + +| Name | Summary | +|---|---| +| [construct](construct.md) | abstract fun [construct](construct.md)(mc: [ModelCenter](../-model-center/index.md), atm: [AddToModel](../-add-to-model/index.md))
called when the plug-in is launched from ModelCenter | +| [fromString](from-string.md) | abstract fun [fromString](from-string.md)(state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Called to restore the state of a Plug-In. | +| [onEnd](on-end.md) | abstract fun [onEnd](on-end.md)()
called when the plug-in is about to be deleted. | +| [run](run.md) | abstract fun [run](run.md)()
called when the plug-in should run | +| [show](show.md) | abstract fun [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
called to display the plug-in | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/on-end.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/on-end.md index 6c39ad1031..9240fd2dfa 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/on-end.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/on-end.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IComponentPlugIn](index.md)/[onEnd](on-end.md) - -# onEnd - - -abstract fun [onEnd](on-end.md)() - -called when the plug-in is about to be deleted. Informs the Plug-In to do any necessary clean up. - -#### Throws - -| | | -|---|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | thrown if an error occurs | +# onEnd + + +abstract fun [onEnd](on-end.md)() + +called when the plug-in is about to be deleted. Informs the Plug-In to do any necessary clean up. + +#### Throws + +| | | +|---|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | thrown if an error occurs | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/run.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/run.md index 0928601ef0..613d858342 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/run.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/run.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IComponentPlugIn](index.md)/[run](run.md) - -# run - - -abstract fun [run](run.md)() - -called when the plug-in should run - -#### Throws - -| | | -|---|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | thrown if an error occurs | +# run + + +abstract fun [run](run.md)() + +called when the plug-in should run + +#### Throws + +| | | +|---|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | thrown if an error occurs | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/show.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/show.md index 3225f4be78..21aeabf4a7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/show.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/show.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IComponentPlugIn](index.md)/[show](show.md) - -# show - - -abstract fun [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -called to display the plug-in - -#### Return - -true(use Generic Driver tool) or false - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# show + + +abstract fun [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +called to display the plug-in + +#### Return + +true(use Generic Driver tool) or false + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/construct.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/construct.md index 45aeaff0ca..64b0e2f986 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/construct.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/construct.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataCollectorPlugIn](index.md)/[construct](construct.md) - -# construct - - -abstract fun [construct](construct.md)(mc: [ModelCenter](../-model-center/index.md), atm: [AddToModel](../-add-to-model/index.md), dc: [DataCollector](../-data-collector/index.md)) - -called when the plug-in is launched from ModelCenter - -#### Parameters - - - -| | | -|---|---| -| mc | the ModelCenter object | -| atm | the AddToModel API object | -| dc | the Data Collector API object | - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# construct + + +abstract fun [construct](construct.md)(mc: [ModelCenter](../-model-center/index.md), atm: [AddToModel](../-add-to-model/index.md), dc: [DataCollector](../-data-collector/index.md)) + +called when the plug-in is launched from ModelCenter + +#### Parameters + + + +| | | +|---|---| +| mc | the ModelCenter object | +| atm | the AddToModel API object | +| dc | the Data Collector API object | + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/from-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/from-string.md index 1bf0ca8726..1d96a5628c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/from-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/from-string.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataCollectorPlugIn](index.md)/[fromString](from-string.md) - -# fromString - - -abstract fun [fromString](from-string.md)(state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Called to restore the state of a Plug-In. Should be able to restore the state from whatever string is returned by [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--). - -#### Parameters - - - -| | | -|---|---| -| state | the state string | - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# fromString + + +abstract fun [fromString](from-string.md)(state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Called to restore the state of a Plug-In. Should be able to restore the state from whatever string is returned by [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--). + +#### Parameters + + + +| | | +|---|---| +| state | the state string | + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/index.md index 7987267ecf..17c3028f67 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/index.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataCollectorPlugIn](index.md) - -# IDataCollectorPlugIn - - -interface [IDataCollectorPlugIn](index.md) - -This is the interface that must be implemented by all Java data collector plug-ins for ModelCenter. Please note that due to an issue in Java 8, we do not explicitly override [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) here, but you still need to implement it. - -## Functions - -| Name | Summary | -|---|---| -| [construct](construct.md) | abstract fun [construct](construct.md)(mc: [ModelCenter](../-model-center/index.md), atm: [AddToModel](../-add-to-model/index.md), dc: [DataCollector](../-data-collector/index.md))
called when the plug-in is launched from ModelCenter | -| [fromString](from-string.md) | abstract fun [fromString](from-string.md)(state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Called to restore the state of a Plug-In. | -| [show](show.md) | abstract fun [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
called to display the plug-in | +# IDataCollectorPlugIn + + +interface [IDataCollectorPlugIn](index.md) + +This is the interface that must be implemented by all Java data collector plug-ins for ModelCenter. Please note that due to an issue in Java 8, we do not explicitly override [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) here, but you still need to implement it. + +## Functions + +| Name | Summary | +|---|---| +| [construct](construct.md) | abstract fun [construct](construct.md)(mc: [ModelCenter](../-model-center/index.md), atm: [AddToModel](../-add-to-model/index.md), dc: [DataCollector](../-data-collector/index.md))
called when the plug-in is launched from ModelCenter | +| [fromString](from-string.md) | abstract fun [fromString](from-string.md)(state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Called to restore the state of a Plug-In. | +| [show](show.md) | abstract fun [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
called to display the plug-in | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/show.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/show.md index 6d77f41c46..1eed09290e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/show.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/show.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataCollectorPlugIn](index.md)/[show](show.md) - -# show - - -abstract fun [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -called to display the plug-in - -#### Return - -false always - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# show + + +abstract fun [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +called to display the plug-in + +#### Return + +false always + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/construct.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/construct.md index 2797babf89..7d6b615a27 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/construct.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/construct.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataExplorerPlugIn](index.md)/[construct](construct.md) - -# construct - - -abstract fun [construct](construct.md)(dhid: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), freeDaX: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), dialogParent: [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html), pluginid: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), dh: [DataHistory](../-data-history/index.md), mc: [ModelCenter](../-model-center/index.md), context: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html) - -Construct your plug-in. - -#### Parameters - - - -| | | -|---|---| -| dhid | The unique Data History ID. Will be unique per instance of ModelCenter | -| freeDaX | True if this is the standalone Data Explorer product and running without a license. | -| dialogParent | A JFrame to use as a parent to any dialog boxes | -| pluginid | A unique ID for your plugin instance that won't change | -| dh | The Data History object. Do not call this object on the Swing Event Dispatch Thread | -| mc | The ModelCenter object. Do not call this object on the Swing Event Dispatch Thread | -| context | This is the name of the plug-in, such as "2D Line". This is useful if you have a single plug-in with multiple behaviors. | +# construct + + +abstract fun [construct](construct.md)(dhid: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), freeDaX: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), dialogParent: [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html), pluginid: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), dh: [DataHistory](../-data-history/index.md), mc: [ModelCenter](../-model-center/index.md), context: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html) + +Construct your plug-in. + +#### Parameters + + + +| | | +|---|---| +| dhid | The unique Data History ID. Will be unique per instance of ModelCenter | +| freeDaX | True if this is the standalone Data Explorer product and running without a license. | +| dialogParent | A JFrame to use as a parent to any dialog boxes | +| pluginid | A unique ID for your plugin instance that won't change | +| dh | The Data History object. Do not call this object on the Swing Event Dispatch Thread | +| mc | The ModelCenter object. Do not call this object on the Swing Event Dispatch Thread | +| context | This is the name of the plug-in, such as "2D Line". This is useful if you have a single plug-in with multiple behaviors. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/data-changed.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/data-changed.md index 260c18c3b1..6ccdba2ade 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/data-changed.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/data-changed.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataExplorerPlugIn](index.md)/[dataChanged](data-changed.md) - -# dataChanged - - -abstract fun [dataChanged](data-changed.md)(varIndex: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), runIndex: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -Called by the Data Explorer to notify the plug-in that the data in the DataHistory has changed. - -#### Parameters - - - -| | | -|---|---| -| varIndex | The index of the changed variable | -| runIndex | The index of the changed run | +# dataChanged + + +abstract fun [dataChanged](data-changed.md)(varIndex: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), runIndex: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +Called by the Data Explorer to notify the plug-in that the data in the DataHistory has changed. + +#### Parameters + + + +| | | +|---|---| +| varIndex | The index of the changed variable | +| runIndex | The index of the changed run | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/export-image.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/export-image.md index a641f90768..99b232336c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/export-image.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/export-image.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataExplorerPlugIn](index.md)/[exportImage](export-image.md) - -# exportImage - - -abstract fun [exportImage](export-image.md)(hints: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filename: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Tells the plug-in to export an image to a file. - -#### Parameters - - - -| | | -|---|---| -| hints | Hints to the page as to how to export. For now, this is not used, although in the future it can be used to express size, format, and "thumbnail" characteristics. | -| filename | The name of the file to create | +# exportImage + + +abstract fun [exportImage](export-image.md)(hints: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filename: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Tells the plug-in to export an image to a file. + +#### Parameters + + + +| | | +|---|---| +| hints | Hints to the page as to how to export. For now, this is not used, although in the future it can be used to express size, format, and "thumbnail" characteristics. | +| filename | The name of the file to create | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/from-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/from-string.md index 957184259f..8df602a55b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/from-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/from-string.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataExplorerPlugIn](index.md)/[fromString](from-string.md) - -# fromString - - -abstract fun [fromString](from-string.md)(s: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Called to restore the state of a Plug-In. Should be able to restore the state from whatever string is returned by [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--). - -#### Parameters - - - -| | | -|---|---| -| s | The setup string | - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# fromString + + +abstract fun [fromString](from-string.md)(s: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Called to restore the state of a Plug-In. Should be able to restore the state from whatever string is returned by [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--). + +#### Parameters + + + +| | | +|---|---| +| s | The setup string | + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/get-page-title.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/get-page-title.md index a63587b766..f77f05ee3f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/get-page-title.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/get-page-title.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataExplorerPlugIn](index.md)/[getPageTitle](get-page-title.md) - -# getPageTitle - - -abstract fun [getPageTitle](get-page-title.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Called by the Data Explorer to get the plug-in title. - -#### Return - -The page title +# getPageTitle + + +abstract fun [getPageTitle](get-page-title.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Called by the Data Explorer to get the plug-in title. + +#### Return + +The page title diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/get-required-license.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/get-required-license.md index c74ae5dd04..a3b7bdd917 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/get-required-license.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/get-required-license.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataExplorerPlugIn](index.md)/[getRequiredLicense](get-required-license.md) - -# getRequiredLicense - - -abstract fun [getRequiredLicense](get-required-license.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -If this plot needs a license to operate, return the feature name in this function and ModelCenter will check it out for you. +# getRequiredLicense + + +abstract fun [getRequiredLicense](get-required-license.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +If this plot needs a license to operate, return the feature name in this function and ModelCenter will check it out for you. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/get-thumbnail.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/get-thumbnail.md index 0c6539c2e5..353c6ba07f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/get-thumbnail.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/get-thumbnail.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataExplorerPlugIn](index.md)/[getThumbnail](get-thumbnail.md) - -# getThumbnail - - -abstract fun [getThumbnail](get-thumbnail.md)(hints: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Called by the Data Explorer to get the name of a file that contains the thumbnail image. The image can be EMF (preferred), BMP, JPG, or GIF. - -#### Return - -The name of the file containing the thumbnail image - -#### Parameters - - - -| | | -|---|---| -| hints | Hints to the page as to how to export. For now, this is not used, although in the future it can be used to express size format and "thumbnail" characteristics. | +# getThumbnail + + +abstract fun [getThumbnail](get-thumbnail.md)(hints: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Called by the Data Explorer to get the name of a file that contains the thumbnail image. The image can be EMF (preferred), BMP, JPG, or GIF. + +#### Return + +The name of the file containing the thumbnail image + +#### Parameters + + + +| | | +|---|---| +| hints | Hints to the page as to how to export. For now, this is not used, although in the future it can be used to express size format and "thumbnail" characteristics. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/index.md index e64cbd5123..e7214ede61 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/index.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataExplorerPlugIn](index.md) - -# IDataExplorerPlugIn - - -interface [IDataExplorerPlugIn](index.md) - -This is the interface that must be implemented by all Java Data Explorer plug-ins for ModelCenter. Please note that due to an issue in Java 8, we do not explicitly override [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) here, but you still need to implement it. - -## Functions - -| Name | Summary | -|---|---| -| [construct](construct.md) | abstract fun [construct](construct.md)(dhid: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), freeDaX: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), dialogParent: [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html), pluginid: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), dh: [DataHistory](../-data-history/index.md), mc: [ModelCenter](../-model-center/index.md), context: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html)
Construct your plug-in. | -| [dataChanged](data-changed.md) | abstract fun [dataChanged](data-changed.md)(varIndex: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), runIndex: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Called by the Data Explorer to notify the plug-in that the data in the DataHistory has changed. | -| [exportImage](export-image.md) | abstract fun [exportImage](export-image.md)(hints: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filename: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Tells the plug-in to export an image to a file. | -| [fromString](from-string.md) | abstract fun [fromString](from-string.md)(s: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Called to restore the state of a Plug-In. | -| [getPageTitle](get-page-title.md) | abstract fun [getPageTitle](get-page-title.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Called by the Data Explorer to get the plug-in title. | -| [getRequiredLicense](get-required-license.md) | abstract fun [getRequiredLicense](get-required-license.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
If this plot needs a license to operate, return the feature name in this function and ModelCenter will check it out for you. | -| [getThumbnail](get-thumbnail.md) | abstract fun [getThumbnail](get-thumbnail.md)(hints: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Called by the Data Explorer to get the name of a file that contains the thumbnail image. | -| [invokeMenuItem](invoke-menu-item.md) | abstract fun [invokeMenuItem](invoke-menu-item.md)(id: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Called by the Data Explorer to notify the plug-in that a user has selected a menu item. | -| [onEnd](on-end.md) | abstract fun [onEnd](on-end.md)()
Called by the Data Explorer to notify the plug-in that it is about to be destroyed | -| [progressMeterStop](progress-meter-stop.md) | abstract fun [progressMeterStop](progress-meter-stop.md)()
Called by the Data Explorer to notify the plug-in that its progress meter has stopped | -| [variablesChanged](variables-changed.md) | abstract fun [variablesChanged](variables-changed.md)()
Called by the Data Explorer to notify the plug-in that the variables in the DataHistory have changed. | +# IDataExplorerPlugIn + + +interface [IDataExplorerPlugIn](index.md) + +This is the interface that must be implemented by all Java Data Explorer plug-ins for ModelCenter. Please note that due to an issue in Java 8, we do not explicitly override [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) here, but you still need to implement it. + +## Functions + +| Name | Summary | +|---|---| +| [construct](construct.md) | abstract fun [construct](construct.md)(dhid: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), freeDaX: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), dialogParent: [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html), pluginid: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), dh: [DataHistory](../-data-history/index.md), mc: [ModelCenter](../-model-center/index.md), context: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html)
Construct your plug-in. | +| [dataChanged](data-changed.md) | abstract fun [dataChanged](data-changed.md)(varIndex: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), runIndex: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Called by the Data Explorer to notify the plug-in that the data in the DataHistory has changed. | +| [exportImage](export-image.md) | abstract fun [exportImage](export-image.md)(hints: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filename: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Tells the plug-in to export an image to a file. | +| [fromString](from-string.md) | abstract fun [fromString](from-string.md)(s: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Called to restore the state of a Plug-In. | +| [getPageTitle](get-page-title.md) | abstract fun [getPageTitle](get-page-title.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Called by the Data Explorer to get the plug-in title. | +| [getRequiredLicense](get-required-license.md) | abstract fun [getRequiredLicense](get-required-license.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
If this plot needs a license to operate, return the feature name in this function and ModelCenter will check it out for you. | +| [getThumbnail](get-thumbnail.md) | abstract fun [getThumbnail](get-thumbnail.md)(hints: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Called by the Data Explorer to get the name of a file that contains the thumbnail image. | +| [invokeMenuItem](invoke-menu-item.md) | abstract fun [invokeMenuItem](invoke-menu-item.md)(id: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Called by the Data Explorer to notify the plug-in that a user has selected a menu item. | +| [onEnd](on-end.md) | abstract fun [onEnd](on-end.md)()
Called by the Data Explorer to notify the plug-in that it is about to be destroyed | +| [progressMeterStop](progress-meter-stop.md) | abstract fun [progressMeterStop](progress-meter-stop.md)()
Called by the Data Explorer to notify the plug-in that its progress meter has stopped | +| [variablesChanged](variables-changed.md) | abstract fun [variablesChanged](variables-changed.md)()
Called by the Data Explorer to notify the plug-in that the variables in the DataHistory have changed. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/invoke-menu-item.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/invoke-menu-item.md index 64574e4312..88ddc7434d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/invoke-menu-item.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/invoke-menu-item.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataExplorerPlugIn](index.md)/[invokeMenuItem](invoke-menu-item.md) - -# invokeMenuItem - - -abstract fun [invokeMenuItem](invoke-menu-item.md)(id: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -Called by the Data Explorer to notify the plug-in that a user has selected a menu item. The following items are predefined: Basic Settings = -5, Print Page = -6, Export Page = -7. Optional menu items (see getMenuItems) are positive integers starting at zero. - -#### Parameters - - - -| | | -|---|---| -| id | The id of the menu item | +# invokeMenuItem + + +abstract fun [invokeMenuItem](invoke-menu-item.md)(id: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +Called by the Data Explorer to notify the plug-in that a user has selected a menu item. The following items are predefined: Basic Settings = -5, Print Page = -6, Export Page = -7. Optional menu items (see getMenuItems) are positive integers starting at zero. + +#### Parameters + + + +| | | +|---|---| +| id | The id of the menu item | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/on-end.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/on-end.md index f6187386ac..f434470c0d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/on-end.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/on-end.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataExplorerPlugIn](index.md)/[onEnd](on-end.md) - -# onEnd - - -abstract fun [onEnd](on-end.md)() - -Called by the Data Explorer to notify the plug-in that it is about to be destroyed +# onEnd + + +abstract fun [onEnd](on-end.md)() + +Called by the Data Explorer to notify the plug-in that it is about to be destroyed diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/progress-meter-stop.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/progress-meter-stop.md index d84458e9a5..afe1263526 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/progress-meter-stop.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/progress-meter-stop.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataExplorerPlugIn](index.md)/[progressMeterStop](progress-meter-stop.md) - -# progressMeterStop - - -abstract fun [progressMeterStop](progress-meter-stop.md)() - -Called by the Data Explorer to notify the plug-in that its progress meter has stopped +# progressMeterStop + + +abstract fun [progressMeterStop](progress-meter-stop.md)() + +Called by the Data Explorer to notify the plug-in that its progress meter has stopped diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/variables-changed.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/variables-changed.md index f6e5082930..5c05f2faa9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/variables-changed.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/variables-changed.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataExplorerPlugIn](index.md)/[variablesChanged](variables-changed.md) - -# variablesChanged - - -abstract fun [variablesChanged](variables-changed.md)() - -Called by the Data Explorer to notify the plug-in that the variables in the DataHistory have changed. +# variablesChanged + + +abstract fun [variablesChanged](variables-changed.md)() + +Called by the Data Explorer to notify the plug-in that the variables in the DataHistory have changed. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/can-rerun-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/can-rerun-runs.md index 0b80db38ac..bbcbb1594c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/can-rerun-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/can-rerun-runs.md @@ -1,21 +1,19 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataHistoryToModel](index.md)/[canRerunRuns](can-rerun-runs.md) - -# canRerunRuns - - -abstract fun [canRerunRuns](can-rerun-runs.md)(dataHistory: [DataHistory](../-data-history/index.md), runIndexes: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Determine if the specified runs can be re-run. Returning FALSE means that the option should be disabled in any menus. - -#### Return - -TRUE if the runs can be re-run, false if not - -#### Parameters - - - -| | | -|---|---| -| dataHistory | the data history to check in regards to | -| runIndexes | an array of run indexes | +# canRerunRuns + + +abstract fun [canRerunRuns](can-rerun-runs.md)(dataHistory: [DataHistory](../-data-history/index.md), runIndexes: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Determine if the specified runs can be re-run. Returning FALSE means that the option should be disabled in any menus. + +#### Return + +TRUE if the runs can be re-run, false if not + +#### Parameters + + + +| | | +|---|---| +| dataHistory | the data history to check in regards to | +| runIndexes | an array of run indexes | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/can-save-to-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/can-save-to-model.md index c16b45c99d..84f5893ffd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/can-save-to-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/can-save-to-model.md @@ -1,21 +1,19 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataHistoryToModel](index.md)/[canSaveToModel](can-save-to-model.md) - -# canSaveToModel - - -abstract fun [canSaveToModel](can-save-to-model.md)(dataHistory: [DataHistory](../-data-history/index.md), runIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Determine if a run could be saved to the model; returning FALSE means that option should be disabled in any menus. - -#### Return - -TRUE if the run could be saved, FALSE if not - -#### Parameters - - - -| | | -|---|---| -| dataHistory | the data history to check in regards to | -| runIndex | the index of the run to check | +# canSaveToModel + + +abstract fun [canSaveToModel](can-save-to-model.md)(dataHistory: [DataHistory](../-data-history/index.md), runIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Determine if a run could be saved to the model; returning FALSE means that option should be disabled in any menus. + +#### Return + +TRUE if the run could be saved, FALSE if not + +#### Parameters + + + +| | | +|---|---| +| dataHistory | the data history to check in regards to | +| runIndex | the index of the run to check | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/close-data-history.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/close-data-history.md index d205ebe1a8..7b477fe012 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/close-data-history.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/close-data-history.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataHistoryToModel](index.md)/[closeDataHistory](close-data-history.md) - -# closeDataHistory - - -abstract fun [closeDataHistory](close-data-history.md)(dataHistory: [DataHistory](../-data-history/index.md)) - -Notify that the user is attempting to close the given data history. This class does not own the DataHistory passed into this method, and it will be released. If a new DataHistory is needed, call the [newInstance](../-data-explorer/new-instance.md) method. - -#### Parameters - - - -| | | -|---|---| -| dataHistory | the data history the user is attempting to close | - -#### Throws - -| | | -|---|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | on error | +# closeDataHistory + + +abstract fun [closeDataHistory](close-data-history.md)(dataHistory: [DataHistory](../-data-history/index.md)) + +Notify that the user is attempting to close the given data history. This class does not own the DataHistory passed into this method, and it will be released. If a new DataHistory is needed, call the [newInstance](../-data-explorer/new-instance.md) method. + +#### Parameters + + + +| | | +|---|---| +| dataHistory | the data history the user is attempting to close | + +#### Throws + +| | | +|---|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | on error | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/index.md index a5afa2cb32..2cb5d0d3aa 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/index.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataHistoryToModel](index.md) - -# IDataHistoryToModel - - -interface [IDataHistoryToModel](index.md) - -The Data History to Model connector is the piece that connects a Data History to a ModelCenter instance, for the purpose of restoring a run or re-running runs. It allows a user to override the default behaviors of the "Save to Model" and "Rerun Runs" capabilities of Data Explorer. - -## Functions - -| Name | Summary | -|---|---| -| [canRerunRuns](can-rerun-runs.md) | abstract fun [canRerunRuns](can-rerun-runs.md)(dataHistory: [DataHistory](../-data-history/index.md), runIndexes: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determine if the specified runs can be re-run. | -| [canSaveToModel](can-save-to-model.md) | abstract fun [canSaveToModel](can-save-to-model.md)(dataHistory: [DataHistory](../-data-history/index.md), runIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determine if a run could be saved to the model; returning FALSE means that option should be disabled in any menus. | -| [closeDataHistory](close-data-history.md) | abstract fun [closeDataHistory](close-data-history.md)(dataHistory: [DataHistory](../-data-history/index.md))
Notify that the user is attempting to close the given data history. | -| [rerunRuns](rerun-runs.md) | abstract fun [rerunRuns](rerun-runs.md)(dataHistory: [DataHistory](../-data-history/index.md), runIndexes: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>)
Notify that the user has requested to re-run a set of runs. | -| [saveToModel](save-to-model.md) | abstract fun [saveToModel](save-to-model.md)(dataHistory: [DataHistory](../-data-history/index.md), runIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Notify that a user has requested to save the indicated run to the model. | +# IDataHistoryToModel + + +interface [IDataHistoryToModel](index.md) + +The Data History to Model connector is the piece that connects a Data History to a ModelCenter instance, for the purpose of restoring a run or re-running runs. It allows a user to override the default behaviors of the "Save to Model" and "Rerun Runs" capabilities of Data Explorer. + +## Functions + +| Name | Summary | +|---|---| +| [canRerunRuns](can-rerun-runs.md) | abstract fun [canRerunRuns](can-rerun-runs.md)(dataHistory: [DataHistory](../-data-history/index.md), runIndexes: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determine if the specified runs can be re-run. | +| [canSaveToModel](can-save-to-model.md) | abstract fun [canSaveToModel](can-save-to-model.md)(dataHistory: [DataHistory](../-data-history/index.md), runIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determine if a run could be saved to the model; returning FALSE means that option should be disabled in any menus. | +| [closeDataHistory](close-data-history.md) | abstract fun [closeDataHistory](close-data-history.md)(dataHistory: [DataHistory](../-data-history/index.md))
Notify that the user is attempting to close the given data history. | +| [rerunRuns](rerun-runs.md) | abstract fun [rerunRuns](rerun-runs.md)(dataHistory: [DataHistory](../-data-history/index.md), runIndexes: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>)
Notify that the user has requested to re-run a set of runs. | +| [saveToModel](save-to-model.md) | abstract fun [saveToModel](save-to-model.md)(dataHistory: [DataHistory](../-data-history/index.md), runIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Notify that a user has requested to save the indicated run to the model. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/rerun-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/rerun-runs.md index 96c6d5cfb7..661910267d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/rerun-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/rerun-runs.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataHistoryToModel](index.md)/[rerunRuns](rerun-runs.md) - -# rerunRuns - - -abstract fun [rerunRuns](rerun-runs.md)(dataHistory: [DataHistory](../-data-history/index.md), runIndexes: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>) - -Notify that the user has requested to re-run a set of runs. Does not wait for the runs to complete. endRuns from PHXDataHistory will be called when completed. - -#### Parameters - - - -| | | -|---|---| -| dataHistory | the data history to read and write from | -| runIndexes | an array of run indexes | +# rerunRuns + + +abstract fun [rerunRuns](rerun-runs.md)(dataHistory: [DataHistory](../-data-history/index.md), runIndexes: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>) + +Notify that the user has requested to re-run a set of runs. Does not wait for the runs to complete. endRuns from PHXDataHistory will be called when completed. + +#### Parameters + + + +| | | +|---|---| +| dataHistory | the data history to read and write from | +| runIndexes | an array of run indexes | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/save-to-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/save-to-model.md index 539b8d7ba8..0adfc78a01 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/save-to-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/save-to-model.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IDataHistoryToModel](index.md)/[saveToModel](save-to-model.md) - -# saveToModel - - -abstract fun [saveToModel](save-to-model.md)(dataHistory: [DataHistory](../-data-history/index.md), runIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -Notify that a user has requested to save the indicated run to the model. - -#### Parameters - - - -| | | -|---|---| -| dataHistory | the data history to supply the data | -| runIndex | the index of the run to save | +# saveToModel + + +abstract fun [saveToModel](save-to-model.md)(dataHistory: [DataHistory](../-data-history/index.md), runIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +Notify that a user has requested to save the indicated run to the model. + +#### Parameters + + + +| | | +|---|---| +| dataHistory | the data history to supply the data | +| runIndex | the index of the run to save | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-holder/get-full-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-holder/get-full-name.md index 391c2f7ea7..7e3785b0b9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-holder/get-full-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-holder/get-full-name.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IHolder](index.md)/[getFullName](get-full-name.md) - -# getFullName - - -abstract fun [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the full name of the current object, e.g. "Model.Script.x" - -#### Return - -the object name +# getFullName + + +abstract fun [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the full name of the current object, e.g. "Model.Script.x" + +#### Return + +the object name diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-holder/get-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-holder/get-name.md index 0a4bf90777..bb88e0f412 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-holder/get-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-holder/get-name.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IHolder](index.md)/[getName](get-name.md) - -# getName - - -abstract fun [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the name of the current object, e.g. "x" - -#### Return - -the object name +# getName + + +abstract fun [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the name of the current object, e.g. "x" + +#### Return + +the object name diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-holder/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-holder/index.md index 27ec57d965..0a44b8139c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-holder/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-holder/index.md @@ -1,25 +1,23 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IHolder](index.md) - -# IHolder - -interface [IHolder](index.md) - -This is an interface for things in ModelCenter that hold other things - -#### Author - -Woyak, 10-01 - -#### Inheritors - -| | -|---| -| [IVariableHolder](../-i-variable-holder/index.md) | -| [IVariableHolder](../-i-variable-holder/index.md) | - -## Functions - -| Name | Summary | -|---|---| -| [getFullName](get-full-name.md) | abstract fun [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the full name of the current object, e.g. | -| [getName](get-name.md) | abstract fun [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the current object, e.g. | +# IHolder + +interface [IHolder](index.md) + +This is an interface for things in ModelCenter that hold other things + +#### Author + +Woyak, 10-01 + +#### Inheritors + +| | +|---| +| [IVariableHolder](../-i-variable-holder/index.md) | +| [IVariableHolder](../-i-variable-holder/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [getFullName](get-full-name.md) | abstract fun [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the full name of the current object, e.g. | +| [getName](get-name.md) | abstract fun [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the current object, e.g. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/index.md index 0b864beccc..6d320b4545 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/index.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ILoginCallback](index.md) - -# ILoginCallback - - -interface [ILoginCallback](index.md) - -Interface for handling login requests from ModelCenter. - -#### Author - -acook - -## Functions - -| Name | Summary | -|---|---| -| [loginSucceeded](login-succeeded.md) | abstract fun [loginSucceeded](login-succeeded.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), username: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), password: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), savePassword: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Called when ModelCenter succeeds in authentication. | -| [requestAuthCredentials](request-auth-credentials.md) | abstract fun [requestAuthCredentials](request-auth-credentials.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isFailedAttempt: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), username: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, password: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, savePassword: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html)>): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Called when ModelCenter needs to request a username and password. | -| [verifySslWarning](verify-ssl-warning.md) | abstract fun [verifySslWarning](verify-ssl-warning.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Called when ModelCenter needs an SSL warning to be verified/accepted. | +# ILoginCallback + + +interface [ILoginCallback](index.md) + +Interface for handling login requests from ModelCenter. + +#### Author + +acook + +## Functions + +| Name | Summary | +|---|---| +| [loginSucceeded](login-succeeded.md) | abstract fun [loginSucceeded](login-succeeded.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), username: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), password: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), savePassword: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Called when ModelCenter succeeds in authentication. | +| [requestAuthCredentials](request-auth-credentials.md) | abstract fun [requestAuthCredentials](request-auth-credentials.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isFailedAttempt: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), username: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, password: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, savePassword: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html)>): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Called when ModelCenter needs to request a username and password. | +| [verifySslWarning](verify-ssl-warning.md) | abstract fun [verifySslWarning](verify-ssl-warning.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Called when ModelCenter needs an SSL warning to be verified/accepted. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/login-succeeded.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/login-succeeded.md index 56ba842028..ffa01a553c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/login-succeeded.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/login-succeeded.md @@ -1,25 +1,23 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ILoginCallback](index.md)/[loginSucceeded](login-succeeded.md) - -# loginSucceeded - - -abstract fun [loginSucceeded](login-succeeded.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), username: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), password: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), savePassword: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Called when ModelCenter succeeds in authentication. - -#### Parameters - - - -| | | -|---|---| -| uri | URI successfully authenticated to | -| username | username that successfully authenticated | -| password | password that successfully authenticated | -| savePassword | true if password should be saved, false otherwise | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# loginSucceeded + + +abstract fun [loginSucceeded](login-succeeded.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), username: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), password: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), savePassword: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Called when ModelCenter succeeds in authentication. + +#### Parameters + + + +| | | +|---|---| +| uri | URI successfully authenticated to | +| username | username that successfully authenticated | +| password | password that successfully authenticated | +| savePassword | true if password should be saved, false otherwise | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/request-auth-credentials.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/request-auth-credentials.md index c601a1b6c0..87138dcca6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/request-auth-credentials.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/request-auth-credentials.md @@ -1,30 +1,28 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ILoginCallback](index.md)/[requestAuthCredentials](request-auth-credentials.md) - -# requestAuthCredentials - - -abstract fun [requestAuthCredentials](request-auth-credentials.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isFailedAttempt: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), username: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, password: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, savePassword: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html)>): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Called when ModelCenter needs to request a username and password. - -#### Return - -true if username/password is submitted, false otherwise - -#### Parameters - - - -| | | -|---|---| -| uri | URI authenticating to | -| isFailedAttempt | true if request is due to previous failed attempt, false otherwise | -| username | username to use (inout) | -| password | password to use (inout) | -| savePassword | true if password should be saved, false otherwise (inout) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# requestAuthCredentials + + +abstract fun [requestAuthCredentials](request-auth-credentials.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isFailedAttempt: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), username: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, password: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, savePassword: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html)>): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Called when ModelCenter needs to request a username and password. + +#### Return + +true if username/password is submitted, false otherwise + +#### Parameters + + + +| | | +|---|---| +| uri | URI authenticating to | +| isFailedAttempt | true if request is due to previous failed attempt, false otherwise | +| username | username to use (inout) | +| password | password to use (inout) | +| savePassword | true if password should be saved, false otherwise (inout) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/verify-ssl-warning.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/verify-ssl-warning.md index f4c7700c52..b5ef58f07e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/verify-ssl-warning.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/verify-ssl-warning.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ILoginCallback](index.md)/[verifySslWarning](verify-ssl-warning.md) - -# verifySslWarning - - -abstract fun [verifySslWarning](verify-ssl-warning.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Called when ModelCenter needs an SSL warning to be verified/accepted. - -#### Return - -true if ModelCenter should proceed, false otherwse - -#### Parameters - - - -| | | -|---|---| -| uri | URI that has SSL warning | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# verifySslWarning + + +abstract fun [verifySslWarning](verify-ssl-warning.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Called when ModelCenter needs an SSL warning to be verified/accepted. + +#### Return + +true if ModelCenter should proceed, false otherwse + +#### Parameters + + + +| | | +|---|---| +| uri | URI that has SSL warning | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/-h-t-m-l-viewer-wait-for-close.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/-h-t-m-l-viewer-wait-for-close.md index 032c83af91..6e5ede7d84 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/-h-t-m-l-viewer-wait-for-close.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/-h-t-m-l-viewer-wait-for-close.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[HTMLViewerWaitForClose](-h-t-m-l-viewer-wait-for-close.md) - -# HTMLViewerWaitForClose - - -abstract fun [HTMLViewerWaitForClose](-h-t-m-l-viewer-wait-for-close.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -waits for the HTMLViewer embedded browser tool to close +# HTMLViewerWaitForClose + + +abstract fun [HTMLViewerWaitForClose](-h-t-m-l-viewer-wait-for-close.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +waits for the HTMLViewer embedded browser tool to close diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/-message-box.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/-message-box.md index a38029fa11..3a82fc7cd0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/-message-box.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/-message-box.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[MessageBox](-message-box.md) - -# MessageBox - - -abstract fun [MessageBox](-message-box.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -displays a Windows Message Box - -#### Parameters - - - -| | | -|---|---| -| msg | the message to display | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# MessageBox + + +abstract fun [MessageBox](-message-box.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +displays a Windows Message Box + +#### Parameters + + + +| | | +|---|---| +| msg | the message to display | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/add-icon.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/add-icon.md index bbf17b422d..b0667dfade 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/add-icon.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/add-icon.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[addIcon](add-icon.md) - -# addIcon - - -abstract fun [addIcon](add-icon.md)(iconFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -Registers an icon with ModelCenter. This icon can then later be used to customize Assemblies and Groups via the iconID property - -#### Return - -the id of the added icon - -#### Parameters - - - -| | -|---| -| iconFile | +# addIcon + + +abstract fun [addIcon](add-icon.md)(iconFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Registers an icon with ModelCenter. This icon can then later be used to customize Assemblies and Groups via the iconID property + +#### Return + +the id of the added icon + +#### Parameters + + + +| | +|---| +| iconFile | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/add-new-macro.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/add-new-macro.md index 1ca6b5298a..0510503a2a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/add-new-macro.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/add-new-macro.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[addNewMacro](add-new-macro.md) - -# addNewMacro - - -abstract fun [addNewMacro](add-new-macro.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isAppMacro: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -adds a new Macro to ModelCenter's macro facility - -#### Parameters - - - -| | | -|---|---| -| macroName | the name of the new macro | -| isAppMacro | defines whether the new macro is an Application macro (true) or Model macro (false) | +# addNewMacro + + +abstract fun [addNewMacro](add-new-macro.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isAppMacro: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +adds a new Macro to ModelCenter's macro facility + +#### Parameters + + + +| | | +|---|---| +| macroName | the name of the new macro | +| isAppMacro | defines whether the new macro is an Application macro (true) or Model macro (false) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/auto-link.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/auto-link.md index 9bebbd9368..403e5fe476 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/auto-link.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/auto-link.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[autoLink](auto-link.md) - -# autoLink - - -abstract fun [autoLink](auto-link.md)(srcComp: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), destComp: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -auto links the variables of two Components - -#### Parameters - - - -| | | -|---|---| -| srcComp | name of the source component | -| destComp | name of the destination component | +# autoLink + + +abstract fun [autoLink](auto-link.md)(srcComp: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), destComp: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +auto links the variables of two Components + +#### Parameters + + + +| | | +|---|---| +| srcComp | name of the source component | +| destComp | name of the destination component | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/break-link.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/break-link.md index 4babd5715a..309a7fa465 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/break-link.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/break-link.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[breakLink](break-link.md) - -# breakLink - - -abstract fun [breakLink](break-link.md)(variable: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Breaks the link of a specified variable - -#### Parameters - - - -| | | -|---|---| -| variable | the variable whose link is to be broken | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# breakLink + + +abstract fun [breakLink](break-link.md)(variable: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Breaks the link of a specified variable + +#### Parameters + + + +| | | +|---|---| +| variable | the variable whose link is to be broken | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/checkout.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/checkout.md index b54f7562f8..9cb9f315f7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/checkout.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/checkout.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[checkout](checkout.md) - -# checkout - - -abstract fun [checkout](checkout.md)(feature: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Feature](../-feature/index.md) - -Should check out a license feature from Ansys - -#### Return - -a Feature object - -#### Parameters - - - -| | | -|---|---| -| feature | the name of the feature to be checked out | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# checkout + + +abstract fun [checkout](checkout.md)(feature: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Feature](../-feature/index.md) + +Should check out a license feature from Ansys + +#### Return + +a Feature object + +#### Parameters + + + +| | | +|---|---| +| feature | the name of the feature to be checked out | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/checkout2.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/checkout2.md index 3d03463dfe..f0836ee85d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/checkout2.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/checkout2.md @@ -1,27 +1,25 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[checkout2](checkout2.md) - -# checkout2 - - -abstract fun [checkout2](checkout2.md)(feature: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), productRelease: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Feature](../-feature/index.md) - -Should check out a license feature from Ansys - -#### Return - -a Feature object - -#### Parameters - - - -| | | -|---|---| -| feature | the name of the feature to be checked out | -| productRelease | the release date of the feature being passed | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# checkout2 + + +abstract fun [checkout2](checkout2.md)(feature: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), productRelease: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Feature](../-feature/index.md) + +Should check out a license feature from Ansys + +#### Return + +a Feature object + +#### Parameters + + + +| | | +|---|---| +| feature | the name of the feature to be checked out | +| productRelease | the release date of the feature being passed | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/close-h-t-m-l-viewer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/close-h-t-m-l-viewer.md index 3ff09a74c6..37dcc9aca7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/close-h-t-m-l-viewer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/close-h-t-m-l-viewer.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[closeHTMLViewer](close-h-t-m-l-viewer.md) - -# closeHTMLViewer - - -abstract fun [closeHTMLViewer](close-h-t-m-l-viewer.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -closes the HTMLViewer embedded browser tool +# closeHTMLViewer + + +abstract fun [closeHTMLViewer](close-h-t-m-l-viewer.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +closes the HTMLViewer embedded browser tool diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/close-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/close-model.md index 1cf45959f4..56ea09babf 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/close-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/close-model.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[closeModel](close-model.md) - -# closeModel - - -abstract fun [closeModel](close-model.md)() - -closes the model within ModelCenter - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# closeModel + + +abstract fun [closeModel](close-model.md)() + +closes the model within ModelCenter + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-and-init-component.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-and-init-component.md index 55d1a2209c..49d051ad13 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-and-init-component.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-and-init-component.md @@ -1,31 +1,29 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[createAndInitComponent](create-and-init-component.md) - -# createAndInitComponent - - -abstract fun [createAndInitComponent](create-and-init-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), initString: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Component](../-component/index.md) - -Creates a new component and initializes it from string data. IMPORTANT NOTE: This method can only be invoked on plugins which support IComponentPlugin.fromString(). Furthermore, it should only be used when you know EXACTLY the format that is expected by the component's fromString() method. It is designed to be used from plugins in third-party software which need to initialize a matching component to connect to that software in the model. Ideally, both the plugin for the third-party software and the ModelCenter component WILL SHARE THE SAME CODEBASE, so you can generate the configuration string from the same code which you will use to process it later. Mismatch between formats will almost certainly cause this method to fail. - -#### Return - -the component created - -#### Parameters - - - -| | | -|---|---| -| serverPath | the server path, e.g. "mcre:\\localhost\block" | -| name | the name for the new component | -| parentName | the parent component | -| initString | the initialization string for the component (see above) if initString is NULL, behavior is identical to createComponent() | -| xPos | the x position | -| yPos | the y position | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# createAndInitComponent + + +abstract fun [createAndInitComponent](create-and-init-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), initString: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Component](../-component/index.md) + +Creates a new component and initializes it from string data. IMPORTANT NOTE: This method can only be invoked on plugins which support IComponentPlugin.fromString(). Furthermore, it should only be used when you know EXACTLY the format that is expected by the component's fromString() method. It is designed to be used from plugins in third-party software which need to initialize a matching component to connect to that software in the model. Ideally, both the plugin for the third-party software and the ModelCenter component WILL SHARE THE SAME CODEBASE, so you can generate the configuration string from the same code which you will use to process it later. Mismatch between formats will almost certainly cause this method to fail. + +#### Return + +the component created + +#### Parameters + + + +| | | +|---|---| +| serverPath | the server path, e.g. "mcre:\\localhost\block" | +| name | the name for the new component | +| parentName | the parent component | +| initString | the initialization string for the component (see above) if initString is NULL, behavior is identical to createComponent() | +| xPos | the x position | +| yPos | the y position | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-assembly-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-assembly-variable.md index c11967e165..42559948f0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-assembly-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-assembly-variable.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[createAssemblyVariable](create-assembly-variable.md) - -# createAssemblyVariable - - -abstract fun [createAssemblyVariable](create-assembly-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) - -creates an assembly variable - -#### Return - -a Variable object - -#### Parameters - - - -| | | -|---|---| -| name | Name of the new variable to create. | -| type | Type of the new variable. Possible types are: double, int, string, file, double[], int[], boolean[], string[], quadfacet, surfaceofrevolution, nurbs, bspline, ruled, skinned, vrml, node | -| parent | the name of the parent assembly | +# createAssemblyVariable + + +abstract fun [createAssemblyVariable](create-assembly-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) + +creates an assembly variable + +#### Return + +a Variable object + +#### Parameters + + + +| | | +|---|---| +| name | Name of the new variable to create. | +| type | Type of the new variable. Possible types are: double, int, string, file, double[], int[], boolean[], string[], quadfacet, surfaceofrevolution, nurbs, bspline, ruled, skinned, vrml, node | +| parent | the name of the parent assembly | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-assembly.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-assembly.md index 1ea6ac27e2..e51912b63b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-assembly.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-assembly.md @@ -1,40 +1,38 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[createAssembly](create-assembly.md) - -# createAssembly - - -abstract fun [createAssembly](create-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md) - -creates an assembly - -#### Return - -an Assembly object - -#### Parameters - - - -| | | -|---|---| -| name | the name of the assembly to be created | -| parent | the name of the parent assembly | - - -abstract fun [createAssembly](create-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), assemblyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md) - -creates an assembly - -#### Return - -an Assembly object - -#### Parameters - - - -| | | -|---|---| -| name | the name of the assembly to be created | -| parent | the name of the parent assembly | -| assemblyType | the type of assembly to create: ASSEMBLY_TYPE_ASSEMBLY - traditional ModelCenter assembly The following additional assembly types are available in ModelCenter process models (i.e. modelType == MODEL_TYPE_PROCESS) ASSEMBLY_TYPE_SEQUENCE - sequential flow ASSEMBLY_TYPE_IF - if-then-else flow ASSEMBLY_TYPE_FOR_EACH - loop over a data array | +# createAssembly + + +abstract fun [createAssembly](create-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md) + +creates an assembly + +#### Return + +an Assembly object + +#### Parameters + + + +| | | +|---|---| +| name | the name of the assembly to be created | +| parent | the name of the parent assembly | + + +abstract fun [createAssembly](create-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), assemblyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md) + +creates an assembly + +#### Return + +an Assembly object + +#### Parameters + + + +| | | +|---|---| +| name | the name of the assembly to be created | +| parent | the name of the parent assembly | +| assemblyType | the type of assembly to create: ASSEMBLY_TYPE_ASSEMBLY - traditional ModelCenter assembly The following additional assembly types are available in ModelCenter process models (i.e. modelType == MODEL_TYPE_PROCESS) ASSEMBLY_TYPE_SEQUENCE - sequential flow ASSEMBLY_TYPE_IF - if-then-else flow ASSEMBLY_TYPE_FOR_EACH - loop over a data array | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-component.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-component.md index b4c1f5c11f..bd024db732 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-component.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-component.md @@ -1,47 +1,45 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[createComponent](create-component.md) - -# createComponent - - -abstract fun [createComponent](create-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Instantiates a new component into the Model - -#### Parameters - - - -| | | -|---|---| -| serverPath | the location of the Component to instantiate, e.g. mcre://localhost/Block | -| name | the name for the instantiated Component | -| parentName | the name of the parent Component to instantiate the new Component into. To instantiate the Component into the top level, the parent name is usually "Model" | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -abstract fun [createComponent](create-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -Instantiates a new component into the Model - -#### Parameters - - - -| | | -|---|---| -| serverPath | the location of the Component to instantiate, e.g. mcre://localhost/Block | -| name | the name for the instantiated Component | -| parentName | the name of the parent Component to instantiate the new Component into. To instantiate the Component into the top level, the parent name is usually "Model" | -| xPos | the x position for the new component in the Analysis View | -| yPos | the y position for the new component in the Analysis View | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# createComponent + + +abstract fun [createComponent](create-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Instantiates a new component into the Model + +#### Parameters + + + +| | | +|---|---| +| serverPath | the location of the Component to instantiate, e.g. mcre://localhost/Block | +| name | the name for the instantiated Component | +| parentName | the name of the parent Component to instantiate the new Component into. To instantiate the Component into the top level, the parent name is usually "Model" | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +abstract fun [createComponent](create-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +Instantiates a new component into the Model + +#### Parameters + + + +| | | +|---|---| +| serverPath | the location of the Component to instantiate, e.g. mcre://localhost/Block | +| name | the name for the instantiated Component | +| parentName | the name of the parent Component to instantiate the new Component into. To instantiate the Component into the top level, the parent name is usually "Model" | +| xPos | the x position for the new component in the Analysis View | +| yPos | the y position for the new component in the Analysis View | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-collector.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-collector.md index 56f5bd37fb..686d40c642 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-collector.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-collector.md @@ -1,28 +1,26 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[createDataCollector](create-data-collector.md) - -# createDataCollector - - -abstract fun [~~createDataCollector~~](create-data-collector.md)(tradeStudyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DataCollector](../-data-collector/index.md) - ---- - -### Deprecated - ---- - -creates a Data Collector for storing and displaying data - -#### Return - -a DataCollector object - -#### Deprecated - -use [createDataExplorer](create-data-explorer.md) instead - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# createDataCollector + + +abstract fun [~~createDataCollector~~](create-data-collector.md)(tradeStudyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DataCollector](../-data-collector/index.md) + +--- + +### Deprecated + +--- + +creates a Data Collector for storing and displaying data + +#### Return + +a DataCollector object + +#### Deprecated + +use [createDataExplorer](create-data-explorer.md) instead + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-explorer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-explorer.md index 1685675cc6..1dc08b9620 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-explorer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-explorer.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[createDataExplorer](create-data-explorer.md) - -# createDataExplorer - - -abstract fun [createDataExplorer](create-data-explorer.md)(tradeStudyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DataExplorer](../-data-explorer/index.md) - -creates a Data Explorer for storing and displaying data - -#### Return - -a DataExplorer object - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# createDataExplorer + + +abstract fun [createDataExplorer](create-data-explorer.md)(tradeStudyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DataExplorer](../-data-explorer/index.md) + +creates a Data Explorer for storing and displaying data + +#### Return + +a DataExplorer object + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-history-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-history-variable.md index 5335138aa0..d6b67c867f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-history-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-history-variable.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[createDataHistoryVariable](create-data-history-variable.md) - -# createDataHistoryVariable - - -abstract fun [createDataHistoryVariable](create-data-history-variable.md)(): [DHVariable](../-d-h-variable/index.md) - -Creates a new DHVariable instance. - -#### Return - -a blank DHVariable object - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# createDataHistoryVariable + + +abstract fun [createDataHistoryVariable](create-data-history-variable.md)(): [DHVariable](../-d-h-variable/index.md) + +Creates a new DHVariable instance. + +#### Return + +a blank DHVariable object + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-monitor.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-monitor.md index da9005435d..9529bb83bf 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-monitor.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-monitor.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[createDataMonitor](create-data-monitor.md) - -# createDataMonitor - - -abstract fun [createDataMonitor](create-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), x: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), y: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [DataMonitor](../-data-monitor/index.md) - -create a data monitor and associate it with a particular component - -#### Return - -a PHXCOMDataMonitor COM object representing the data monitor control - -#### Parameters - - - -| | | -|---|---| -| component | the name of the component under which to create this data monitor | -| title | the title of the new data monitor | -| x | the x coordinate (in model space) of the new data monitor | -| y | the y coordinate (in model space) of the new data monitor | +# createDataMonitor + + +abstract fun [createDataMonitor](create-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), x: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), y: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [DataMonitor](../-data-monitor/index.md) + +create a data monitor and associate it with a particular component + +#### Return + +a PHXCOMDataMonitor COM object representing the data monitor control + +#### Parameters + + + +| | | +|---|---| +| component | the name of the component under which to create this data monitor | +| title | the title of the new data monitor | +| x | the x coordinate (in model space) of the new data monitor | +| y | the y coordinate (in model space) of the new data monitor | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-job-manager.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-job-manager.md index c422e6cb71..52e122d9d0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-job-manager.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-job-manager.md @@ -1,64 +1,62 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[createJobManager](create-job-manager.md) - -# createJobManager - - -abstract fun [createJobManager](create-job-manager.md)(): [JobManager](../-job-manager/index.md) - -creates a JobManager object for performing trade study runs - -#### Return - -a JobManager object - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -abstract fun [createJobManager](create-job-manager.md)(showProgressDialog: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [JobManager](../-job-manager/index.md) - -Creates a JobManager for performing trade study runs. - -#### Return - -a JobManager object - -#### Parameters - - - -| | | -|---|---| -| showProgressDialog | if true, show a progress dialog when creating the job manager and attempt to parent it to the main ModelCenter window. If false, don't show a progress dialog. | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if something goes wrong creating a job manager | - - -abstract fun [createJobManager](create-job-manager.md)(progressDialogParent: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [JobManager](../-job-manager/index.md) - -Creates a JobManager for performing trade study runs. - -#### Return - -a JobManager object - -#### Parameters - - - -| | | -|---|---| -| progressDialogParent | the ID of the window that should own the progress dialog that will be shown when creating the job manager. | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if something goes wrong creating a job manager | +# createJobManager + + +abstract fun [createJobManager](create-job-manager.md)(): [JobManager](../-job-manager/index.md) + +creates a JobManager object for performing trade study runs + +#### Return + +a JobManager object + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +abstract fun [createJobManager](create-job-manager.md)(showProgressDialog: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [JobManager](../-job-manager/index.md) + +Creates a JobManager for performing trade study runs. + +#### Return + +a JobManager object + +#### Parameters + + + +| | | +|---|---| +| showProgressDialog | if true, show a progress dialog when creating the job manager and attempt to parent it to the main ModelCenter window. If false, don't show a progress dialog. | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if something goes wrong creating a job manager | + + +abstract fun [createJobManager](create-job-manager.md)(progressDialogParent: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [JobManager](../-job-manager/index.md) + +Creates a JobManager for performing trade study runs. + +#### Return + +a JobManager object + +#### Parameters + + + +| | | +|---|---| +| progressDialogParent | the ID of the window that should own the progress dialog that will be shown when creating the job manager. | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if something goes wrong creating a job manager | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-link.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-link.md index 4e71b57b34..66c688264c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-link.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-link.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[createLink](create-link.md) - -# createLink - - -abstract fun [createLink](create-link.md)(varName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Creates a new link - -#### Parameters - - - -| | | -|---|---| -| varName | the full name of the variable to be linked | -| equation | the variable(s) to link varName to. | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# createLink + + +abstract fun [createLink](create-link.md)(varName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Creates a new link + +#### Parameters + + + +| | | +|---|---| +| varName | the full name of the variable to be linked | +| equation | the variable(s) to link varName to. | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-plug-in-frame.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-plug-in-frame.md index 95ae3725b6..f9d3823c76 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-plug-in-frame.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-plug-in-frame.md @@ -1,30 +1,28 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[createPlugInFrame](create-plug-in-frame.md) - -# createPlugInFrame - - -abstract fun [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -Create a frame window in which to embed the java plug-in - -#### Return - -window handle for the frame created - -#### Parameters - - - -| | | -|---|---| -| name | name of the plug-in frame | -| title | window title for the plug-in frame | -| reserved | Reserved for future use | -| plugin | IDispatch for the plug-in asking to be put into a frame | - - -abstract fun [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -abstract fun [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), defWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), defHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -abstract fun [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), defWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), defHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), minWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), minHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) +# createPlugInFrame + + +abstract fun [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +Create a frame window in which to embed the java plug-in + +#### Return + +window handle for the frame created + +#### Parameters + + + +| | | +|---|---| +| name | name of the plug-in frame | +| title | window title for the plug-in frame | +| reserved | Reserved for future use | +| plugin | IDispatch for the plug-in asking to be put into a frame | + + +abstract fun [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +abstract fun [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), defWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), defHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +abstract fun [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), defWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), defHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), minWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), minHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-trade-study.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-trade-study.md index 41ddb62f50..d90fc2e5d9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-trade-study.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-trade-study.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[createTradeStudy](create-trade-study.md) - -# createTradeStudy - - -abstract fun [createTradeStudy](create-trade-study.md)(idStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [TradeStudy](../-trade-study/index.md) - -Creates the specified trade study and returns a handle to it. Unlike for launchTradeStudy method, the trade study is not shown before object is returned. Does not currently support Java plug-ins. - -#### Parameters - - - -| | | -|---|---| -| idStr | a fully specified URL like "SOFTWARE\\Phoenix Integration\\Trade Study Plug-Ins\\DOE Tool" | +# createTradeStudy + + +abstract fun [createTradeStudy](create-trade-study.md)(idStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [TradeStudy](../-trade-study/index.md) + +Creates the specified trade study and returns a handle to it. Unlike for launchTradeStudy method, the trade study is not shown before object is returned. Does not currently support Java plug-ins. + +#### Parameters + + + +| | | +|---|---| +| idStr | a fully specified URL like "SOFTWARE\\Phoenix Integration\\Trade Study Plug-Ins\\DOE Tool" | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/destroy-plug-in-frame.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/destroy-plug-in-frame.md index dfd2486037..6af1cafce8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/destroy-plug-in-frame.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/destroy-plug-in-frame.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[destroyPlugInFrame](destroy-plug-in-frame.md) - -# destroyPlugInFrame - - -abstract fun [destroyPlugInFrame](destroy-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -Destroys the frame window which the java plug-in is embedded in - -#### Parameters - - - -| | | -|---|---| -| hwnd | handle to the frame window CWnd | +# destroyPlugInFrame + + +abstract fun [destroyPlugInFrame](destroy-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +Destroys the frame window which the java plug-in is embedded in + +#### Parameters + + + +| | | +|---|---| +| hwnd | handle to the frame window CWnd | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/dump-com-debug.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/dump-com-debug.md index a1b294935c..f73b8cefed 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/dump-com-debug.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/dump-com-debug.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[dumpComDebug](dump-com-debug.md) - -# dumpComDebug - - -abstract fun [dumpComDebug](dump-com-debug.md)() - -Dumps COM debugging information on the ModelCenter process side; only has an effect if ModelCenter is compiled in Debug mode. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# dumpComDebug + + +abstract fun [dumpComDebug](dump-com-debug.md)() + +Dumps COM debugging information on the ModelCenter process side; only has an effect if ModelCenter is compiled in Debug mode. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-active-job-manager.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-active-job-manager.md index 41dcbc7c89..9804aee61b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-active-job-manager.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-active-job-manager.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getActiveJobManager](get-active-job-manager.md) - -# getActiveJobManager - - -abstract fun [getActiveJobManager](get-active-job-manager.md)(): [JobManager](../-job-manager/index.md) - -Gets the Job Manager associated with the currently running trade study. An exception will be thrown if a trade study is not currently running - -#### Return - -a Job Manager object +# getActiveJobManager + + +abstract fun [getActiveJobManager](get-active-job-manager.md)(): [JobManager](../-job-manager/index.md) + +Gets the Job Manager associated with the currently running trade study. An exception will be thrown if a trade study is not currently running + +#### Return + +a Job Manager object diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-app-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-app-name.md index 54196b2f55..3119f215f6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-app-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-app-name.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getAppName](get-app-name.md) - -# getAppName - - -abstract fun [getAppName](get-app-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the Application name - -#### Return - -Application name - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getAppName + + +abstract fun [getAppName](get-app-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the Application name + +#### Return + +Application name + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-assembly-style.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-assembly-style.md index a26d33daab..f205f82eca 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-assembly-style.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-assembly-style.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getAssemblyStyle](get-assembly-style.md) - -# getAssemblyStyle - - -abstract fun [getAssemblyStyle](get-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [ModelCenter.AssemblyStyleInfo](../-model-center/-assembly-style-info/index.md) - -Get the visual style of an assembly. This method can be used to get information about any control with children, including IF blocks, traditional assemblies, drivers (in process mode), sequences, and parallel blocks. The style in the returned data will either be Expanded or Collapsed, except for expanded data-driven assemblies, which will have more detailed information. - -#### Return - -the style information - -#### Parameters - - - -| | | -|---|---| -| assemblyName | the full name of the assembly to modify | +# getAssemblyStyle + + +abstract fun [getAssemblyStyle](get-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [ModelCenter.AssemblyStyleInfo](../-model-center/-assembly-style-info/index.md) + +Get the visual style of an assembly. This method can be used to get information about any control with children, including IF blocks, traditional assemblies, drivers (in process mode), sequences, and parallel blocks. The style in the returned data will either be Expanded or Collapsed, except for expanded data-driven assemblies, which will have more detailed information. + +#### Return + +the style information + +#### Parameters + + + +| | | +|---|---| +| assemblyName | the full name of the assembly to modify | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-assembly.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-assembly.md index 7c095c0cd9..90b5728b38 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-assembly.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-assembly.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getAssembly](get-assembly.md) - -# getAssembly - - -abstract fun [getAssembly](get-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md) - -Gets the specified assembly from the model. - -#### Return - -an Assembly object - -#### Parameters - - - -| | | -|---|---| -| name | the assembly name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getAssembly + + +abstract fun [getAssembly](get-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md) + +Gets the specified assembly from the model. + +#### Return + +an Assembly object + +#### Parameters + + + +| | | +|---|---| +| name | the assembly name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-component.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-component.md index 4e5756734e..e939ad778c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-component.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-component.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getComponent](get-component.md) - -# getComponent - - -abstract fun [getComponent](get-component.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Component](../-component/index.md) - -Gets the specified component from the Model - -#### Return - -a Component object - -#### Parameters - - - -| | | -|---|---| -| name | the component name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getComponent + + +abstract fun [getComponent](get-component.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Component](../-component/index.md) + +Gets the specified component from the Model + +#### Return + +a Component object + +#### Parameters + + + +| | | +|---|---| +| name | the component name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-collector-for-data-explorer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-collector-for-data-explorer.md index 4143b6135d..f72c69f780 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-collector-for-data-explorer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-collector-for-data-explorer.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getDataCollectorForDataExplorer](get-data-collector-for-data-explorer.md) - -# getDataCollectorForDataExplorer - - -abstract fun [getDataCollectorForDataExplorer](get-data-collector-for-data-explorer.md)(dataExplorer: [DataExplorer](../-data-explorer/index.md)): [DataCollector](../-data-collector/index.md) - -Retrieves a DataCollector for the DataExplorer with the specified ID. - -#### Return - -A DataCollector for the DataExplorer with the specified ID - -#### Parameters - - - -| | | -|---|---| -| dataExplorer | The DataExplorer for which to retrieve a DataCollector | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | If something goes wrong in retrieving a DataCollector for the specified DataExplorerID | +# getDataCollectorForDataExplorer + + +abstract fun [getDataCollectorForDataExplorer](get-data-collector-for-data-explorer.md)(dataExplorer: [DataExplorer](../-data-explorer/index.md)): [DataCollector](../-data-collector/index.md) + +Retrieves a DataCollector for the DataExplorer with the specified ID. + +#### Return + +A DataCollector for the DataExplorer with the specified ID + +#### Parameters + + + +| | | +|---|---| +| dataExplorer | The DataExplorer for which to retrieve a DataCollector | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | If something goes wrong in retrieving a DataCollector for the specified DataExplorerID | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-collector.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-collector.md index 9b06503457..fdd856871e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-collector.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-collector.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getDataCollector](get-data-collector.md) - -# getDataCollector - - -abstract fun [getDataCollector](get-data-collector.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [DataCollector](../-data-collector/index.md) +# getDataCollector + + +abstract fun [getDataCollector](get-data-collector.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [DataCollector](../-data-collector/index.md) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-explorer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-explorer.md index c2aa31cdc7..27e8f54ecb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-explorer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-explorer.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getDataExplorer](get-data-explorer.md) - -# getDataExplorer - - -abstract fun [getDataExplorer](get-data-explorer.md)(id: [Variant](../-variant/index.md)): [DataExplorer](../-data-explorer/index.md) - -gets a specific DataExplorer - -#### Return - -a PHXCOMDataMonitor COM object representing the data monitor control - -#### Parameters - - - -| | | -|---|---| -| id | 0-based index of Data Explorer | +# getDataExplorer + + +abstract fun [getDataExplorer](get-data-explorer.md)(id: [Variant](../-variant/index.md)): [DataExplorer](../-data-explorer/index.md) + +gets a specific DataExplorer + +#### Return + +a PHXCOMDataMonitor COM object representing the data monitor control + +#### Parameters + + + +| | | +|---|---| +| id | 0-based index of Data Explorer | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-monitor.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-monitor.md index 42bb5d5508..0a3f8cfe54 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-monitor.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-monitor.md @@ -1,21 +1,19 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getDataMonitor](get-data-monitor.md) - -# getDataMonitor - - -abstract fun [getDataMonitor](get-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Variant](../-variant/index.md)): [DataMonitor](../-data-monitor/index.md) - -gets a specific data monitor associated with a particular component - -#### Return - -a PHXCOMDataMonitor COM object representing the data monitor control - -#### Parameters - - - -| | | -|---|---| -| component | the name of the component under which to search for data monitors | -| index | the integer index (0-based index) or string title of the data monitor being sought | +# getDataMonitor + + +abstract fun [getDataMonitor](get-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Variant](../-variant/index.md)): [DataMonitor](../-data-monitor/index.md) + +gets a specific data monitor associated with a particular component + +#### Return + +a PHXCOMDataMonitor COM object representing the data monitor control + +#### Parameters + + + +| | | +|---|---| +| component | the name of the component under which to search for data monitors | +| index | the integer index (0-based index) or string title of the data monitor being sought | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-file-system-info.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-file-system-info.md index fdbe5df91a..63f8124b81 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-file-system-info.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-file-system-info.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getFileSystemInfo](get-file-system-info.md) - -# getFileSystemInfo - - -abstract fun [getFileSystemInfo](get-file-system-info.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [FileSystemInfo](../-file-system-info/index.md) - -Gets the FileSystemInfo for a given URI. The URI doesn't necessarily need to exist. - -#### Return - -the FileSystemInfo for the given uri - -#### Parameters - - - -| | | -|---|---| -| uri | the URI of the file to get system info for | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if an error is encountered generating the FileSystemInfo | +# getFileSystemInfo + + +abstract fun [getFileSystemInfo](get-file-system-info.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [FileSystemInfo](../-file-system-info/index.md) + +Gets the FileSystemInfo for a given URI. The URI doesn't necessarily need to exist. + +#### Return + +the FileSystemInfo for the given uri + +#### Parameters + + + +| | | +|---|---| +| uri | the URI of the file to get system info for | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if an error is encountered generating the FileSystemInfo | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-formatter.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-formatter.md index 197a981036..fdbbda1eda 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-formatter.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-formatter.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getFormatter](get-formatter.md) - -# getFormatter - - -abstract fun [getFormatter](get-formatter.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Format](../-format/index.md) - -Gets an instance of a formatter object +# getFormatter + + +abstract fun [getFormatter](get-formatter.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Format](../-format/index.md) + +Gets an instance of a formatter object diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-frame.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-frame.md index 0bd2a6e5aa..6ae79dc532 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-frame.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-frame.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getFrame](get-frame.md) - -# getFrame - - -abstract fun [getFrame](get-frame.md)(): [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html) - -gets a Frame that should be used as the parent for all windows displayed by Java plug-ins. This Frame is not the actual ModelCenter window and should not be used for anything but specifying a parent window. If ModelCenter is running in server mode, this object will be null. - -#### Return - -a JFrame object +# getFrame + + +abstract fun [getFrame](get-frame.md)(): [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html) + +gets a Frame that should be used as the parent for all windows displayed by Java plug-ins. This Frame is not the actual ModelCenter window and should not be used for anything but specifying a parent window. If ModelCenter is running in server mode, this object will be null. + +#### Return + +a JFrame object diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-global-parameters.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-global-parameters.md index edb03880f2..9c8acef0f6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-global-parameters.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-global-parameters.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getGlobalParameters](get-global-parameters.md) - -# getGlobalParameters - - -abstract fun [getGlobalParameters](get-global-parameters.md)(): [GlobalParameters](../-global-parameters/index.md) - -Gets the list of global parameters +# getGlobalParameters + + +abstract fun [getGlobalParameters](get-global-parameters.md)(): [GlobalParameters](../-global-parameters/index.md) + +Gets the list of global parameters diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-halt-status.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-halt-status.md index f90983a584..e0302d7c6f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-halt-status.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-halt-status.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getHaltStatus](get-halt-status.md) - -# getHaltStatus - - -abstract fun [getHaltStatus](get-halt-status.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -checks to see if the halt button has been pressed - -#### Return - -true if the halt button was pressed and the current actions should be halted - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getHaltStatus + + +abstract fun [getHaltStatus](get-halt-status.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +checks to see if the halt button has been pressed + +#### Return + +true if the halt button was pressed and the current actions should be halted + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-is-interactive.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-is-interactive.md index 9fd65e81f5..d3979840a4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-is-interactive.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-is-interactive.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getIsInteractive](get-is-interactive.md) - -# getIsInteractive - - -abstract fun [getIsInteractive](get-is-interactive.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Determine if the current ModelCenter is running interactively - that is, if it has a GUI and a main window. Some methods will not work if the application is running in non-interactive (server or COM) mode. +# getIsInteractive + + +abstract fun [getIsInteractive](get-is-interactive.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Determine if the current ModelCenter is running interactively - that is, if it has a GUI and a main window. Some methods will not work if the application is running in non-interactive (server or COM) mode. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-last-error-message.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-last-error-message.md index da83bdcd3a..096ba89541 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-last-error-message.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-last-error-message.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getLastErrorMessage](get-last-error-message.md) - -# getLastErrorMessage - - -abstract fun [getLastErrorMessage](get-last-error-message.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -retrieves the text associated with the last ModelCenter error - -#### Return - -error text - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getLastErrorMessage + + +abstract fun [getLastErrorMessage](get-last-error-message.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +retrieves the text associated with the last ModelCenter error + +#### Return + +error text + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-licensing-path.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-licensing-path.md index f7760b2d8c..35f0b319b5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-licensing-path.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-licensing-path.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getLicensingPath](get-licensing-path.md) - -# getLicensingPath - - -abstract fun [getLicensingPath](get-licensing-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the ModelCenter licensing path returns ModelCenter licensing path +# getLicensingPath + + +abstract fun [getLicensingPath](get-licensing-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the ModelCenter licensing path returns ModelCenter licensing path diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-links.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-links.md index b5260f5cf9..4fd69ba4c4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-links.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-links.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getLinks](get-links.md) - -# getLinks - - -abstract fun [getLinks](get-links.md)(includeReferences: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [VariableLinks](../-variable-links/index.md) - -Retreive a list of all links in a model - -#### Return - -a VariableLinks object encapsulating all the links in the model - -#### Parameters - - - -| | | -|---|---| -| includeReferences | whether or not to include references in the listing | +# getLinks + + +abstract fun [getLinks](get-links.md)(includeReferences: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [VariableLinks](../-variable-links/index.md) + +Retreive a list of all links in a model + +#### Return + +a VariableLinks object encapsulating all the links in the model + +#### Parameters + + + +| | | +|---|---| +| includeReferences | whether or not to include references in the listing | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-logger.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-logger.md index c0dc5194c3..1d13ea5b5c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-logger.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-logger.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getLogger](get-logger.md) - -# getLogger - - -abstract fun [getLogger](get-logger.md)(): [Logger](../../com.phoenix_int.ModelCenter.logging/-logger/index.md) - -Retrieves a logger. Note that the logger is always associated with the caller component if there is one, otherwise it is associated with the Model component. If there is not model then a logger associated with the application will be returned - -#### Return - -a Logger object - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getLogger + + +abstract fun [getLogger](get-logger.md)(): [Logger](../../com.phoenix_int.ModelCenter.logging/-logger/index.md) + +Retrieves a logger. Note that the logger is always associated with the caller component if there is one, otherwise it is associated with the Model component. If there is not model then a logger associated with the application will be returned + +#### Return + +a Logger object + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-macro-script-language.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-macro-script-language.md index 91ef3f5eec..0785b22dd7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-macro-script-language.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-macro-script-language.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getMacroScriptLanguage](get-macro-script-language.md) - -# getMacroScriptLanguage - - -abstract fun [getMacroScriptLanguage](get-macro-script-language.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -get the script lancuage for a macro if the macro exists - -#### Return - -the macro script language - -#### Parameters - - - -| | | -|---|---| -| macroName | the name of the macro | +# getMacroScriptLanguage + + +abstract fun [getMacroScriptLanguage](get-macro-script-language.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +get the script lancuage for a macro if the macro exists + +#### Return + +the macro script language + +#### Parameters + + + +| | | +|---|---| +| macroName | the name of the macro | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-macro-script.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-macro-script.md index 815139807e..07e2238467 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-macro-script.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-macro-script.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getMacroScript](get-macro-script.md) - -# getMacroScript - - -abstract fun [getMacroScript](get-macro-script.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -get the script for a macro if the macro exists - -#### Return - -the macro script - -#### Parameters - - - -| | | -|---|---| -| macroName | the name of the macro | +# getMacroScript + + +abstract fun [getMacroScript](get-macro-script.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +get the script for a macro if the macro exists + +#### Return + +the macro script + +#### Parameters + + + +| | | +|---|---| +| macroName | the name of the macro | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model-center-path.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model-center-path.md index b77929dffa..5788ccd587 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model-center-path.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model-center-path.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getModelCenterPath](get-model-center-path.md) - -# getModelCenterPath - - -abstract fun [getModelCenterPath](get-model-center-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Retrieves the install path for ModelCenter. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getModelCenterPath + + +abstract fun [getModelCenterPath](get-model-center-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Retrieves the install path for ModelCenter. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model-directory.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model-directory.md index 052f3d5aa8..63df501cef 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model-directory.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model-directory.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getModelDirectory](get-model-directory.md) - -# getModelDirectory - - -abstract fun [getModelDirectory](get-model-directory.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the Model directory returns an exception when Model is not open returns an empty string when Model has not been saved +# getModelDirectory + + +abstract fun [getModelDirectory](get-model-directory.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the Model directory returns an exception when Model is not open returns an empty string when Model has not been saved diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model-file-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model-file-name.md index 1a69aae06a..368d6e6f9d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model-file-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model-file-name.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getModelFileName](get-model-file-name.md) - -# getModelFileName - - -abstract fun [getModelFileName](get-model-file-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the Model file name - -#### Return - -Model file name - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getModelFileName + + +abstract fun [getModelFileName](get-model-file-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the Model file name + +#### Return + +Model file name + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model.md index baf1244547..365eb03d9c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getModel](get-model.md) - -# getModel - - -abstract fun [getModel](get-model.md)(): [Assembly](../-assembly/index.md) - -Gets the Model object - -#### Return - -an Assembly object - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getModel + + +abstract fun [getModel](get-model.md)(): [Assembly](../-assembly/index.md) + +Gets the Model object + +#### Return + +an Assembly object + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-preference.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-preference.md index 449f9a3e69..476d1277fe 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-preference.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-preference.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getPreference](get-preference.md) - -# getPreference - - -abstract fun [getPreference](get-preference.md)(prefName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) - -gets a preference - -#### Return - -a preference value - -#### Parameters - - - -| | | -|---|---| -| prefName | the name of the preference | +# getPreference + + +abstract fun [getPreference](get-preference.md)(prefName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) + +gets a preference + +#### Return + +a preference value + +#### Parameters + + + +| | | +|---|---| +| prefName | the name of the preference | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-process-i-d.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-process-i-d.md index d9b91726f7..370f7e4ead 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-process-i-d.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-process-i-d.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getProcessID](get-process-i-d.md) - -# getProcessID - - -abstract fun [getProcessID](get-process-i-d.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -Retrieves the process identifier (PID) of the ModelCenter process. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getProcessID + + +abstract fun [getProcessID](get-process-i-d.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +Retrieves the process identifier (PID) of the ModelCenter process. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-run-only-mode.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-run-only-mode.md index 3668fd32d8..a0d56049c0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-run-only-mode.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-run-only-mode.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getRunOnlyMode](get-run-only-mode.md) - -# getRunOnlyMode - - -abstract fun [getRunOnlyMode](get-run-only-mode.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Gets the status of ModelCenter being in Run-Only Mode. - -#### Return - -true if ModelCenter is in Run-Only Mode; otherwise, false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getRunOnlyMode + + +abstract fun [getRunOnlyMode](get-run-only-mode.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Gets the status of ModelCenter being in Run-Only Mode. + +#### Return + +true if ModelCenter is in Run-Only Mode; otherwise, false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-screen-updating.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-screen-updating.md index 2c7f97c514..7176ffa1de 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-screen-updating.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-screen-updating.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getScreenUpdating](get-screen-updating.md) - -# getScreenUpdating - - -abstract fun [getScreenUpdating](get-screen-updating.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -returns the current screen updating flag - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getScreenUpdating + + +abstract fun [getScreenUpdating](get-screen-updating.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +returns the current screen updating flag + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-trade-study-filters.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-trade-study-filters.md index 60e993246f..cdee85c540 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-trade-study-filters.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-trade-study-filters.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getTradeStudyFilters](get-trade-study-filters.md) - -# getTradeStudyFilters - - -abstract fun [getTradeStudyFilters](get-trade-study-filters.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> - -Get the filters for saving Trade Study files (for use in showFileBrowseDialog and showFileSaveDialog) - -#### Return - -the filters for saving Trade Study files - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if an error is encountered getting the trade study filters | +# getTradeStudyFilters + + +abstract fun [getTradeStudyFilters](get-trade-study-filters.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> + +Get the filters for saving Trade Study files (for use in showFileBrowseDialog and showFileSaveDialog) + +#### Return + +the filters for saving Trade Study files + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if an error is encountered getting the trade study filters | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-value-absolute.md index 55405d7160..ec8e32e4b7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-value-absolute.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getValueAbsolute](get-value-absolute.md) - -# getValueAbsolute - - -abstract fun [getValueAbsolute](get-value-absolute.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) - -gets a value for the specified variable without validating it - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| name | the full variable name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValueAbsolute + + +abstract fun [getValueAbsolute](get-value-absolute.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) + +gets a value for the specified variable without validating it + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| name | the full variable name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-value.md index 604c348503..e4d7e0d536 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-value.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getValue](get-value.md) - -# getValue - - -abstract fun [getValue](get-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) - -gets a value for the specified variable - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| name | the full variable name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValue + + +abstract fun [getValue](get-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) + +gets a value for the specified variable + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| name | the full variable name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-variable-meta-data.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-variable-meta-data.md index 2f194a2d7c..c5b96e3fb6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-variable-meta-data.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-variable-meta-data.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getVariableMetaData](get-variable-meta-data.md) - -# getVariableMetaData - - -abstract fun [getVariableMetaData](get-variable-meta-data.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md) - -Get metadata about the specified variable from the Model. - -#### Return - -a DHVariable object - -#### Parameters - - - -| | | -|---|---| -| name | the variable name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getVariableMetaData + + +abstract fun [getVariableMetaData](get-variable-meta-data.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md) + +Get metadata about the specified variable from the Model. + +#### Return + +a DHVariable object + +#### Parameters + + + +| | | +|---|---| +| name | the variable name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-variable.md index f0ba9f52fd..5096449c50 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-variable.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getVariable](get-variable.md) - -# getVariable - - -abstract fun [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) - -Gets the specified variable from the Model - -#### Return - -a Variable object - -#### Parameters - - - -| | | -|---|---| -| name | the variable name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getVariable + + +abstract fun [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) + +Gets the specified variable from the Model + +#### Return + +a Variable object + +#### Parameters + + + +| | | +|---|---| +| name | the variable name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-version.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-version.md index 3809531aa1..ede58ecea2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-version.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-version.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[getVersion](get-version.md) - -# getVersion - - -abstract fun [getVersion](get-version.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -Gets the ModelCenter version - -#### Return - -the version number requested - -#### Parameters - - - -| | | -|---|---| -| index | The version item to get:
- 0 - Major version - 1 - Minor version - 2 - Patch version | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getVersion + + +abstract fun [getVersion](get-version.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Gets the ModelCenter version + +#### Return + +the version number requested + +#### Parameters + + + +| | | +|---|---| +| index | The version item to get:
- 0 - Major version - 1 - Minor version - 2 - Patch version | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/gui-close-all-multiplexers.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/gui-close-all-multiplexers.md index 4e809fc797..608da152d3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/gui-close-all-multiplexers.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/gui-close-all-multiplexers.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[guiCloseAllMultiplexers](gui-close-all-multiplexers.md) - -# guiCloseAllMultiplexers - - -abstract fun [guiCloseAllMultiplexers](gui-close-all-multiplexers.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Attempts to close the DataExplorers of all vizualization multiplexers. - -#### Return - -true if the user allowed all multiplexers to close, false if the user canceled the operation. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# guiCloseAllMultiplexers + + +abstract fun [guiCloseAllMultiplexers](gui-close-all-multiplexers.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Attempts to close the DataExplorers of all vizualization multiplexers. + +#### Return + +true if the user allowed all multiplexers to close, false if the user canceled the operation. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/gui-load-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/gui-load-file.md index 546097ea6f..bcb953ea94 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/gui-load-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/gui-load-file.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[guiLoadFile](gui-load-file.md) - -# guiLoadFile - - -abstract fun [guiLoadFile](gui-load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Loads a file in "GUI" mode, that is, unlike loadFile(...), will produce a prompt to the user to verify whether or not any currently opened model should be saved prior to loading the given file. - -#### Return - -false if the save was cancelled; true otherwise - -#### Parameters - - - -| | | -|---|---| -| modelFile | Path of the file to load. | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if something goes wrong loading the file | +# guiLoadFile + + +abstract fun [guiLoadFile](gui-load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Loads a file in "GUI" mode, that is, unlike loadFile(...), will produce a prompt to the user to verify whether or not any currently opened model should be saved prior to loading the given file. + +#### Return + +false if the save was cancelled; true otherwise + +#### Parameters + + + +| | | +|---|---| +| modelFile | Path of the file to load. | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if something goes wrong loading the file | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/gui-save-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/gui-save-model.md index fa1d671f85..ea721c7497 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/gui-save-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/gui-save-model.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[guiSaveModel](gui-save-model.md) - -# guiSaveModel - - -abstract fun [guiSaveModel](gui-save-model.md)() - -Saves a file in "GUI" mode, which will pop up a dialog if the file has not yet been saved. - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if there is an error while saving the file | +# guiSaveModel + + +abstract fun [guiSaveModel](gui-save-model.md)() + +Saves a file in "GUI" mode, which will pop up a dialog if the file has not yet been saved. + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if there is an error while saving the file | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/halt.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/halt.md index 401eac34f0..fd30b4ec8f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/halt.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/halt.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[halt](halt.md) - -# halt - - -abstract fun [halt](halt.md)() - -Halts any running trade studies +# halt + + +abstract fun [halt](halt.md)() + +Halts any running trade studies diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/hide-plug-in-frame.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/hide-plug-in-frame.md index 37c48424f8..d6e1364bdb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/hide-plug-in-frame.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/hide-plug-in-frame.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[hidePlugInFrame](hide-plug-in-frame.md) - -# hidePlugInFrame - - -abstract fun [hidePlugInFrame](hide-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -Hides the frame window which the java plugin is embedded in - -#### Parameters - - - -| | | -|---|---| -| hwnd | handle to the frame window CWnd | +# hidePlugInFrame + + +abstract fun [hidePlugInFrame](hide-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +Hides the frame window which the java plugin is embedded in + +#### Parameters + + + +| | | +|---|---| +| hwnd | handle to the frame window CWnd | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/index.md index 845443688e..b0b1612e25 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/index.md @@ -1,130 +1,128 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md) - -# IModelCenter - -interface [IModelCenter](index.md) - -Interface for ModelCenter class. - -#### Author - -rshah - -#### Inheritors - -| | -|---| -| [ModelCenter](../-model-center/index.md) | -| [ModelCenter](../-model-center/index.md) | - -## Functions - -| Name | Summary | -|---|---| -| [addIcon](add-icon.md) | abstract fun [addIcon](add-icon.md)(iconFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Registers an icon with ModelCenter. | -| [addNewMacro](add-new-macro.md) | abstract fun [addNewMacro](add-new-macro.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isAppMacro: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
adds a new Macro to ModelCenter's macro facility | -| [autoLink](auto-link.md) | abstract fun [autoLink](auto-link.md)(srcComp: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), destComp: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
auto links the variables of two Components | -| [breakLink](break-link.md) | abstract fun [breakLink](break-link.md)(variable: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Breaks the link of a specified variable | -| [checkout](checkout.md) | abstract fun [checkout](checkout.md)(feature: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Feature](../-feature/index.md)
Should check out a license feature from Ansys | -| [checkout2](checkout2.md) | abstract fun [checkout2](checkout2.md)(feature: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), productRelease: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Feature](../-feature/index.md)
Should check out a license feature from Ansys | -| [closeHTMLViewer](close-h-t-m-l-viewer.md) | abstract fun [closeHTMLViewer](close-h-t-m-l-viewer.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
closes the HTMLViewer embedded browser tool | -| [closeModel](close-model.md) | abstract fun [closeModel](close-model.md)()
closes the model within ModelCenter | -| [createAndInitComponent](create-and-init-component.md) | abstract fun [createAndInitComponent](create-and-init-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), initString: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Component](../-component/index.md)
Creates a new component and initializes it from string data. | -| [createAssembly](create-assembly.md) | abstract fun [createAssembly](create-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md)
abstract fun [createAssembly](create-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), assemblyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md)
creates an assembly | -| [createAssemblyVariable](create-assembly-variable.md) | abstract fun [createAssemblyVariable](create-assembly-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
creates an assembly variable | -| [createComponent](create-component.md) | abstract fun [createComponent](create-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
abstract fun [createComponent](create-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Instantiates a new component into the Model | -| [createDataCollector](create-data-collector.md) | abstract fun [~~createDataCollector~~](create-data-collector.md)(tradeStudyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DataCollector](../-data-collector/index.md)
creates a Data Collector for storing and displaying data | -| [createDataExplorer](create-data-explorer.md) | abstract fun [createDataExplorer](create-data-explorer.md)(tradeStudyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DataExplorer](../-data-explorer/index.md)
creates a Data Explorer for storing and displaying data | -| [createDataHistoryVariable](create-data-history-variable.md) | abstract fun [createDataHistoryVariable](create-data-history-variable.md)(): [DHVariable](../-d-h-variable/index.md)
Creates a new DHVariable instance. | -| [createDataMonitor](create-data-monitor.md) | abstract fun [createDataMonitor](create-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), x: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), y: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [DataMonitor](../-data-monitor/index.md)
create a data monitor and associate it with a particular component | -| [createJobManager](create-job-manager.md) | abstract fun [createJobManager](create-job-manager.md)(): [JobManager](../-job-manager/index.md)
creates a JobManager object for performing trade study runs
abstract fun [createJobManager](create-job-manager.md)(showProgressDialog: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [JobManager](../-job-manager/index.md)
abstract fun [createJobManager](create-job-manager.md)(progressDialogParent: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [JobManager](../-job-manager/index.md)
Creates a JobManager for performing trade study runs. | -| [createLink](create-link.md) | abstract fun [createLink](create-link.md)(varName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Creates a new link | -| [createPlugInFrame](create-plug-in-frame.md) | abstract fun [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Create a frame window in which to embed the java plug-in
abstract fun [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
abstract fun [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), defWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), defHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
abstract fun [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), defWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), defHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), minWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), minHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | -| [createTradeStudy](create-trade-study.md) | abstract fun [createTradeStudy](create-trade-study.md)(idStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [TradeStudy](../-trade-study/index.md)
Creates the specified trade study and returns a handle to it. | -| [destroyPlugInFrame](destroy-plug-in-frame.md) | abstract fun [destroyPlugInFrame](destroy-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Destroys the frame window which the java plug-in is embedded in | -| [dumpComDebug](dump-com-debug.md) | abstract fun [dumpComDebug](dump-com-debug.md)()
Dumps COM debugging information on the ModelCenter process side; only has an effect if ModelCenter is compiled in Debug mode. | -| [getActiveJobManager](get-active-job-manager.md) | abstract fun [getActiveJobManager](get-active-job-manager.md)(): [JobManager](../-job-manager/index.md)
Gets the Job Manager associated with the currently running trade study. | -| [getAppName](get-app-name.md) | abstract fun [getAppName](get-app-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Application name | -| [getAssembly](get-assembly.md) | abstract fun [getAssembly](get-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md)
Gets the specified assembly from the model. | -| [getAssemblyStyle](get-assembly-style.md) | abstract fun [getAssemblyStyle](get-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [ModelCenter.AssemblyStyleInfo](../-model-center/-assembly-style-info/index.md)
Get the visual style of an assembly. | -| [getComponent](get-component.md) | abstract fun [getComponent](get-component.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Component](../-component/index.md)
Gets the specified component from the Model | -| [getDataCollector](get-data-collector.md) | abstract fun [getDataCollector](get-data-collector.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [DataCollector](../-data-collector/index.md) | -| [getDataCollectorForDataExplorer](get-data-collector-for-data-explorer.md) | abstract fun [getDataCollectorForDataExplorer](get-data-collector-for-data-explorer.md)(dataExplorer: [DataExplorer](../-data-explorer/index.md)): [DataCollector](../-data-collector/index.md)
Retrieves a DataCollector for the DataExplorer with the specified ID. | -| [getDataExplorer](get-data-explorer.md) | abstract fun [getDataExplorer](get-data-explorer.md)(id: [Variant](../-variant/index.md)): [DataExplorer](../-data-explorer/index.md)
gets a specific DataExplorer | -| [getDataMonitor](get-data-monitor.md) | abstract fun [getDataMonitor](get-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Variant](../-variant/index.md)): [DataMonitor](../-data-monitor/index.md)
gets a specific data monitor associated with a particular component | -| [getFileSystemInfo](get-file-system-info.md) | abstract fun [getFileSystemInfo](get-file-system-info.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [FileSystemInfo](../-file-system-info/index.md)
Gets the FileSystemInfo for a given URI. | -| [getFormatter](get-formatter.md) | abstract fun [getFormatter](get-formatter.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Format](../-format/index.md)
Gets an instance of a formatter object | -| [getFrame](get-frame.md) | abstract fun [getFrame](get-frame.md)(): [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html)
gets a Frame that should be used as the parent for all windows displayed by Java plug-ins. | -| [getGlobalParameters](get-global-parameters.md) | abstract fun [getGlobalParameters](get-global-parameters.md)(): [GlobalParameters](../-global-parameters/index.md)
Gets the list of global parameters | -| [getHaltStatus](get-halt-status.md) | abstract fun [getHaltStatus](get-halt-status.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks to see if the halt button has been pressed | -| [getIsInteractive](get-is-interactive.md) | abstract fun [getIsInteractive](get-is-interactive.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determine if the current ModelCenter is running interactively - that is, if it has a GUI and a main window. | -| [getLastErrorMessage](get-last-error-message.md) | abstract fun [getLastErrorMessage](get-last-error-message.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
retrieves the text associated with the last ModelCenter error | -| [getLicensingPath](get-licensing-path.md) | abstract fun [getLicensingPath](get-licensing-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the ModelCenter licensing path returns ModelCenter licensing path | -| [getLinks](get-links.md) | abstract fun [getLinks](get-links.md)(includeReferences: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [VariableLinks](../-variable-links/index.md)
Retreive a list of all links in a model | -| [getLogger](get-logger.md) | abstract fun [getLogger](get-logger.md)(): [Logger](../../com.phoenix_int.ModelCenter.logging/-logger/index.md)
Retrieves a logger. | -| [getMacroScript](get-macro-script.md) | abstract fun [getMacroScript](get-macro-script.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the script for a macro if the macro exists | -| [getMacroScriptLanguage](get-macro-script-language.md) | abstract fun [getMacroScriptLanguage](get-macro-script-language.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the script lancuage for a macro if the macro exists | -| [getModel](get-model.md) | abstract fun [getModel](get-model.md)(): [Assembly](../-assembly/index.md)
Gets the Model object | -| [getModelCenterPath](get-model-center-path.md) | abstract fun [getModelCenterPath](get-model-center-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Retrieves the install path for ModelCenter. | -| [getModelDirectory](get-model-directory.md) | abstract fun [getModelDirectory](get-model-directory.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Model directory returns an exception when Model is not open returns an empty string when Model has not been saved | -| [getModelFileName](get-model-file-name.md) | abstract fun [getModelFileName](get-model-file-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Model file name | -| [getPreference](get-preference.md) | abstract fun [getPreference](get-preference.md)(prefName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
gets a preference | -| [getProcessID](get-process-i-d.md) | abstract fun [getProcessID](get-process-i-d.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Retrieves the process identifier (PID) of the ModelCenter process. | -| [getRunOnlyMode](get-run-only-mode.md) | abstract fun [getRunOnlyMode](get-run-only-mode.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets the status of ModelCenter being in Run-Only Mode. | -| [getScreenUpdating](get-screen-updating.md) | abstract fun [getScreenUpdating](get-screen-updating.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
returns the current screen updating flag | -| [getTradeStudyFilters](get-trade-study-filters.md) | abstract fun [getTradeStudyFilters](get-trade-study-filters.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>
Get the filters for saving Trade Study files (for use in showFileBrowseDialog and showFileSaveDialog) | -| [getValue](get-value.md) | abstract fun [getValue](get-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
gets a value for the specified variable | -| [getValueAbsolute](get-value-absolute.md) | abstract fun [getValueAbsolute](get-value-absolute.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
gets a value for the specified variable without validating it | -| [getVariable](get-variable.md) | abstract fun [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
Gets the specified variable from the Model | -| [getVariableMetaData](get-variable-meta-data.md) | abstract fun [getVariableMetaData](get-variable-meta-data.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md)
Get metadata about the specified variable from the Model. | -| [getVersion](get-version.md) | abstract fun [getVersion](get-version.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the ModelCenter version | -| [guiCloseAllMultiplexers](gui-close-all-multiplexers.md) | abstract fun [guiCloseAllMultiplexers](gui-close-all-multiplexers.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Attempts to close the DataExplorers of all vizualization multiplexers. | -| [guiLoadFile](gui-load-file.md) | abstract fun [guiLoadFile](gui-load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Loads a file in "GUI" mode, that is, unlike loadFile(...), will produce a prompt to the user to verify whether or not any currently opened model should be saved prior to loading the given file. | -| [guiSaveModel](gui-save-model.md) | abstract fun [guiSaveModel](gui-save-model.md)()
Saves a file in "GUI" mode, which will pop up a dialog if the file has not yet been saved. | -| [halt](halt.md) | abstract fun [halt](halt.md)()
Halts any running trade studies | -| [hidePlugInFrame](hide-plug-in-frame.md) | abstract fun [hidePlugInFrame](hide-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Hides the frame window which the java plugin is embedded in | -| [HTMLViewerWaitForClose](-h-t-m-l-viewer-wait-for-close.md) | abstract fun [HTMLViewerWaitForClose](-h-t-m-l-viewer-wait-for-close.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
waits for the HTMLViewer embedded browser tool to close | -| [internalLicensing](internal-licensing.md) | abstract fun [internalLicensing](internal-licensing.md)(one: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), two: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
For internal use only | -| [invokeHelp](invoke-help.md) | abstract fun [invokeHelp](invoke-help.md)(helpID: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Display a topic in ModelCenter's help system | -| [isOkToClose](is-ok-to-close.md) | abstract fun [isOkToClose](is-ok-to-close.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determine whether it's ok to shutdown ModelCenter or whether there are still windows open | -| [launchDataCollectorPlugIn](launch-data-collector-plug-in.md) | abstract fun [launchDataCollectorPlugIn](launch-data-collector-plug-in.md)(plugInName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), dataExplorer: [DataExplorer](../-data-explorer/index.md))
Launches a specific Data Collector PlugIn, by name, on the specified Data Explorer. | -| [launchHTMLViewer](launch-h-t-m-l-viewer.md) | abstract fun [launchHTMLViewer](launch-h-t-m-l-viewer.md)(url: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), popup: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
starts the HTMLViewer embedded browser tool | -| [launchMacroEditor](launch-macro-editor.md) | abstract fun [launchMacroEditor](launch-macro-editor.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
launches the macro editor, displays the macro scrip if it exists | -| [launchTradeStudy](launch-trade-study.md) | abstract fun [launchTradeStudy](launch-trade-study.md)(idStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Launches the specified trade study. | -| [loadFile](load-file.md) | abstract fun [loadFile](load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
abstract fun [loadFile](load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), connectErrorMode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
opens the specified Model | -| [loadModel](load-model.md) | abstract fun [loadModel](load-model.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
abstract fun [loadModel](load-model.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), connectErrorMode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
opens the specified Model | -| [MessageBox](-message-box.md) | abstract fun [MessageBox](-message-box.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
displays a Windows Message Box | -| [moveComponent](move-component.md) | abstract fun [moveComponent](move-component.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Moves a component. | -| [newInstance](new-instance.md) | abstract fun [newInstance](new-instance.md)(): [IModelCenter](index.md)
creates a new ModelCenter object (that is connected to the same ModelCenter session) that is not currently attached to any thread. | -| [newModel](new-model.md) | abstract fun [newModel](new-model.md)()
loads ModelCenter with a new, empty Model (data dependency model - MODEL_TYPE_DATA)
abstract fun [newModel](new-model.md)(modelType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
loads ModelCenter with a new, empty Model | -| [parallelInstance](parallel-instance.md) | abstract fun [parallelInstance](parallel-instance.md)(): [ModelCenter](../-model-center/index.md)
For internal use only | -| [release](release.md) | abstract fun [release](release.md)()
Releases the COM reference to ModelCenter for this object. | -| [removeComponent](remove-component.md) | abstract fun [removeComponent](remove-component.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Removes a specified component | -| [removeDataMonitor](remove-data-monitor.md) | abstract fun [removeDataMonitor](remove-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Variant](../-variant/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
remove a specific data monitor associated with a particular component | -| [run](run.md) | abstract fun [run](run.md)(variableArray: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
A comma-separated list of ModelCenter variables to validate. | -| [runAntFile](run-ant-file.md) | abstract fun [runAntFile](run-ant-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
runs an ANT testing file | -| [runMacro](run-macro.md) | abstract fun [runMacro](run-macro.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
runs a macro | -| [runMacro2](run-macro2.md) | abstract fun [runMacro2](run-macro2.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
runs a macro and passes the current modelCenter object to the script (i.e. | -| [saveModel](save-model.md) | abstract fun [saveModel](save-model.md)()
saves the current Model with it's existing file name | -| [saveModelAs](save-model-as.md) | abstract fun [saveModelAs](save-model-as.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
saves the current Model with the specified file name | -| [saveTradeStudy](save-trade-study.md) | abstract fun [saveTradeStudy](save-trade-study.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileType: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), dataExplorer: [DataExplorer](../-data-explorer/index.md))
Save the trade study inside of the Data Explorer | -| [saveVersionedModel](save-versioned-model.md) | abstract fun [saveVersionedModel](save-versioned-model.md)(versionStatus: [ModelCenter.VersionStatus](../-model-center/-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
saves the current Model with it's existing file name | -| [saveVersionedModelAs](save-versioned-model-as.md) | abstract fun [saveVersionedModelAs](save-versioned-model-as.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), versionStatus: [ModelCenter.VersionStatus](../-model-center/-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
saves the current Model with the specified file name | -| [setAssemblyStyle](set-assembly-style.md) | abstract fun [setAssemblyStyle](set-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), style: [ModelCenter.AssemblyStyle](../-model-center/-assembly-style/index.md))
Set the visual style of an assembly.
abstract fun [setAssemblyStyle](set-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), style: [ModelCenter.AssemblyStyle](../-model-center/-assembly-style/index.md), width: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), height: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Set the visual style of an assembly including (optionally) width and height. | -| [setIconPlugInFrame](set-icon-plug-in-frame.md) | abstract fun [setIconPlugInFrame](set-icon-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), iconFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the icon for the frame window which the java plugin is embedded in | -| [setLoginCallback](set-login-callback.md) | abstract fun [setLoginCallback](set-login-callback.md)(callback: [ILoginCallback](../-i-login-callback/index.md))
Set the login callback to use | -| [setMacroScript](set-macro-script.md) | abstract fun [setMacroScript](set-macro-script.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), script: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set the script for a macro if the macro exists | -| [setMacroScriptLanguage](set-macro-script-language.md) | abstract fun [setMacroScriptLanguage](set-macro-script-language.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), language: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set the script lancuage for a macro if the macro exists | -| [setPassword](set-password.md) | abstract fun [setPassword](set-password.md)(password: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the global default password combination in ModelCenter | -| [setPreference](set-preference.md) | abstract fun [setPreference](set-preference.md)(prefName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets a preference | -| [setRunOnlyMode](set-run-only-mode.md) | abstract fun [setRunOnlyMode](set-run-only-mode.md)(shouldBeInRunOnly: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets the status of ModelCenter being in Run-Only Mode to the specified value. | -| [setScheduler](set-scheduler.md) | abstract fun [setScheduler](set-scheduler.md)(scheduler: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the appropriate schdeuler. | -| [setScreenUpdating](set-screen-updating.md) | abstract fun [setScreenUpdating](set-screen-updating.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets a flag indicating if the ModelCenter window should update due to Model changes. | -| [setUserName](set-user-name.md) | abstract fun [setUserName](set-user-name.md)(username: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the global default username combination in ModelCenter | -| [setValue](set-value.md) | abstract fun [setValue](set-value.md)(varName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value for the specified variable | -| [showFileBrowseDialog](show-file-browse-dialog.md) | abstract fun [showFileBrowseDialog](show-file-browse-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
abstract fun [showFileBrowseDialog](show-file-browse-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Displays file selection dialog for loading and returns URL of selected file. | -| [showFileSaveDialog](show-file-save-dialog.md) | abstract fun [showFileSaveDialog](show-file-save-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), selectedFilter: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html)>, initialFileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Displays file selection dialog for saving and returns URL of selected file. | -| [showPlugInFrame](show-plug-in-frame.md) | abstract fun [showPlugInFrame](show-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Shows the frame window which the java plugin is embedded in | -| [startGUIMode](start-g-u-i-mode.md) | abstract fun [startGUIMode](start-g-u-i-mode.md)(showDialogs: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
THIS FUNCTION IS A BETA CAPABILITY Normally when invoked via COM, ModelCenter is in "server" mode and it hides all GUI and dialogs. | -| [tradeStudyEnd](trade-study-end.md) | abstract fun [tradeStudyEnd](trade-study-end.md)()
lets ModelCenter know that a trade study is ending | -| [tradeStudyStart](trade-study-start.md) | abstract fun [tradeStudyStart](trade-study-start.md)()
lets ModelCenter know that a trade study is beginning | +# IModelCenter + +interface [IModelCenter](index.md) + +Interface for ModelCenter class. + +#### Author + +rshah + +#### Inheritors + +| | +|---| +| [ModelCenter](../-model-center/index.md) | +| [ModelCenter](../-model-center/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [addIcon](add-icon.md) | abstract fun [addIcon](add-icon.md)(iconFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Registers an icon with ModelCenter. | +| [addNewMacro](add-new-macro.md) | abstract fun [addNewMacro](add-new-macro.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isAppMacro: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
adds a new Macro to ModelCenter's macro facility | +| [autoLink](auto-link.md) | abstract fun [autoLink](auto-link.md)(srcComp: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), destComp: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
auto links the variables of two Components | +| [breakLink](break-link.md) | abstract fun [breakLink](break-link.md)(variable: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Breaks the link of a specified variable | +| [checkout](checkout.md) | abstract fun [checkout](checkout.md)(feature: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Feature](../-feature/index.md)
Should check out a license feature from Ansys | +| [checkout2](checkout2.md) | abstract fun [checkout2](checkout2.md)(feature: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), productRelease: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Feature](../-feature/index.md)
Should check out a license feature from Ansys | +| [closeHTMLViewer](close-h-t-m-l-viewer.md) | abstract fun [closeHTMLViewer](close-h-t-m-l-viewer.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
closes the HTMLViewer embedded browser tool | +| [closeModel](close-model.md) | abstract fun [closeModel](close-model.md)()
closes the model within ModelCenter | +| [createAndInitComponent](create-and-init-component.md) | abstract fun [createAndInitComponent](create-and-init-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), initString: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Component](../-component/index.md)
Creates a new component and initializes it from string data. | +| [createAssembly](create-assembly.md) | abstract fun [createAssembly](create-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md)
abstract fun [createAssembly](create-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), assemblyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md)
creates an assembly | +| [createAssemblyVariable](create-assembly-variable.md) | abstract fun [createAssemblyVariable](create-assembly-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
creates an assembly variable | +| [createComponent](create-component.md) | abstract fun [createComponent](create-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
abstract fun [createComponent](create-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Instantiates a new component into the Model | +| [createDataCollector](create-data-collector.md) | abstract fun [~~createDataCollector~~](create-data-collector.md)(tradeStudyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DataCollector](../-data-collector/index.md)
creates a Data Collector for storing and displaying data | +| [createDataExplorer](create-data-explorer.md) | abstract fun [createDataExplorer](create-data-explorer.md)(tradeStudyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DataExplorer](../-data-explorer/index.md)
creates a Data Explorer for storing and displaying data | +| [createDataHistoryVariable](create-data-history-variable.md) | abstract fun [createDataHistoryVariable](create-data-history-variable.md)(): [DHVariable](../-d-h-variable/index.md)
Creates a new DHVariable instance. | +| [createDataMonitor](create-data-monitor.md) | abstract fun [createDataMonitor](create-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), x: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), y: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [DataMonitor](../-data-monitor/index.md)
create a data monitor and associate it with a particular component | +| [createJobManager](create-job-manager.md) | abstract fun [createJobManager](create-job-manager.md)(): [JobManager](../-job-manager/index.md)
creates a JobManager object for performing trade study runs
abstract fun [createJobManager](create-job-manager.md)(showProgressDialog: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [JobManager](../-job-manager/index.md)
abstract fun [createJobManager](create-job-manager.md)(progressDialogParent: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [JobManager](../-job-manager/index.md)
Creates a JobManager for performing trade study runs. | +| [createLink](create-link.md) | abstract fun [createLink](create-link.md)(varName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Creates a new link | +| [createPlugInFrame](create-plug-in-frame.md) | abstract fun [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Create a frame window in which to embed the java plug-in
abstract fun [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
abstract fun [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), defWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), defHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
abstract fun [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), defWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), defHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), minWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), minHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | +| [createTradeStudy](create-trade-study.md) | abstract fun [createTradeStudy](create-trade-study.md)(idStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [TradeStudy](../-trade-study/index.md)
Creates the specified trade study and returns a handle to it. | +| [destroyPlugInFrame](destroy-plug-in-frame.md) | abstract fun [destroyPlugInFrame](destroy-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Destroys the frame window which the java plug-in is embedded in | +| [dumpComDebug](dump-com-debug.md) | abstract fun [dumpComDebug](dump-com-debug.md)()
Dumps COM debugging information on the ModelCenter process side; only has an effect if ModelCenter is compiled in Debug mode. | +| [getActiveJobManager](get-active-job-manager.md) | abstract fun [getActiveJobManager](get-active-job-manager.md)(): [JobManager](../-job-manager/index.md)
Gets the Job Manager associated with the currently running trade study. | +| [getAppName](get-app-name.md) | abstract fun [getAppName](get-app-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Application name | +| [getAssembly](get-assembly.md) | abstract fun [getAssembly](get-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md)
Gets the specified assembly from the model. | +| [getAssemblyStyle](get-assembly-style.md) | abstract fun [getAssemblyStyle](get-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [ModelCenter.AssemblyStyleInfo](../-model-center/-assembly-style-info/index.md)
Get the visual style of an assembly. | +| [getComponent](get-component.md) | abstract fun [getComponent](get-component.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Component](../-component/index.md)
Gets the specified component from the Model | +| [getDataCollector](get-data-collector.md) | abstract fun [getDataCollector](get-data-collector.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [DataCollector](../-data-collector/index.md) | +| [getDataCollectorForDataExplorer](get-data-collector-for-data-explorer.md) | abstract fun [getDataCollectorForDataExplorer](get-data-collector-for-data-explorer.md)(dataExplorer: [DataExplorer](../-data-explorer/index.md)): [DataCollector](../-data-collector/index.md)
Retrieves a DataCollector for the DataExplorer with the specified ID. | +| [getDataExplorer](get-data-explorer.md) | abstract fun [getDataExplorer](get-data-explorer.md)(id: [Variant](../-variant/index.md)): [DataExplorer](../-data-explorer/index.md)
gets a specific DataExplorer | +| [getDataMonitor](get-data-monitor.md) | abstract fun [getDataMonitor](get-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Variant](../-variant/index.md)): [DataMonitor](../-data-monitor/index.md)
gets a specific data monitor associated with a particular component | +| [getFileSystemInfo](get-file-system-info.md) | abstract fun [getFileSystemInfo](get-file-system-info.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [FileSystemInfo](../-file-system-info/index.md)
Gets the FileSystemInfo for a given URI. | +| [getFormatter](get-formatter.md) | abstract fun [getFormatter](get-formatter.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Format](../-format/index.md)
Gets an instance of a formatter object | +| [getFrame](get-frame.md) | abstract fun [getFrame](get-frame.md)(): [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html)
gets a Frame that should be used as the parent for all windows displayed by Java plug-ins. | +| [getGlobalParameters](get-global-parameters.md) | abstract fun [getGlobalParameters](get-global-parameters.md)(): [GlobalParameters](../-global-parameters/index.md)
Gets the list of global parameters | +| [getHaltStatus](get-halt-status.md) | abstract fun [getHaltStatus](get-halt-status.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks to see if the halt button has been pressed | +| [getIsInteractive](get-is-interactive.md) | abstract fun [getIsInteractive](get-is-interactive.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determine if the current ModelCenter is running interactively - that is, if it has a GUI and a main window. | +| [getLastErrorMessage](get-last-error-message.md) | abstract fun [getLastErrorMessage](get-last-error-message.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
retrieves the text associated with the last ModelCenter error | +| [getLicensingPath](get-licensing-path.md) | abstract fun [getLicensingPath](get-licensing-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the ModelCenter licensing path returns ModelCenter licensing path | +| [getLinks](get-links.md) | abstract fun [getLinks](get-links.md)(includeReferences: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [VariableLinks](../-variable-links/index.md)
Retreive a list of all links in a model | +| [getLogger](get-logger.md) | abstract fun [getLogger](get-logger.md)(): [Logger](../../com.phoenix_int.ModelCenter.logging/-logger/index.md)
Retrieves a logger. | +| [getMacroScript](get-macro-script.md) | abstract fun [getMacroScript](get-macro-script.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the script for a macro if the macro exists | +| [getMacroScriptLanguage](get-macro-script-language.md) | abstract fun [getMacroScriptLanguage](get-macro-script-language.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the script lancuage for a macro if the macro exists | +| [getModel](get-model.md) | abstract fun [getModel](get-model.md)(): [Assembly](../-assembly/index.md)
Gets the Model object | +| [getModelCenterPath](get-model-center-path.md) | abstract fun [getModelCenterPath](get-model-center-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Retrieves the install path for ModelCenter. | +| [getModelDirectory](get-model-directory.md) | abstract fun [getModelDirectory](get-model-directory.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Model directory returns an exception when Model is not open returns an empty string when Model has not been saved | +| [getModelFileName](get-model-file-name.md) | abstract fun [getModelFileName](get-model-file-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Model file name | +| [getPreference](get-preference.md) | abstract fun [getPreference](get-preference.md)(prefName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
gets a preference | +| [getProcessID](get-process-i-d.md) | abstract fun [getProcessID](get-process-i-d.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Retrieves the process identifier (PID) of the ModelCenter process. | +| [getRunOnlyMode](get-run-only-mode.md) | abstract fun [getRunOnlyMode](get-run-only-mode.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets the status of ModelCenter being in Run-Only Mode. | +| [getScreenUpdating](get-screen-updating.md) | abstract fun [getScreenUpdating](get-screen-updating.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
returns the current screen updating flag | +| [getTradeStudyFilters](get-trade-study-filters.md) | abstract fun [getTradeStudyFilters](get-trade-study-filters.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>
Get the filters for saving Trade Study files (for use in showFileBrowseDialog and showFileSaveDialog) | +| [getValue](get-value.md) | abstract fun [getValue](get-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
gets a value for the specified variable | +| [getValueAbsolute](get-value-absolute.md) | abstract fun [getValueAbsolute](get-value-absolute.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
gets a value for the specified variable without validating it | +| [getVariable](get-variable.md) | abstract fun [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
Gets the specified variable from the Model | +| [getVariableMetaData](get-variable-meta-data.md) | abstract fun [getVariableMetaData](get-variable-meta-data.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md)
Get metadata about the specified variable from the Model. | +| [getVersion](get-version.md) | abstract fun [getVersion](get-version.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the ModelCenter version | +| [guiCloseAllMultiplexers](gui-close-all-multiplexers.md) | abstract fun [guiCloseAllMultiplexers](gui-close-all-multiplexers.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Attempts to close the DataExplorers of all vizualization multiplexers. | +| [guiLoadFile](gui-load-file.md) | abstract fun [guiLoadFile](gui-load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Loads a file in "GUI" mode, that is, unlike loadFile(...), will produce a prompt to the user to verify whether or not any currently opened model should be saved prior to loading the given file. | +| [guiSaveModel](gui-save-model.md) | abstract fun [guiSaveModel](gui-save-model.md)()
Saves a file in "GUI" mode, which will pop up a dialog if the file has not yet been saved. | +| [halt](halt.md) | abstract fun [halt](halt.md)()
Halts any running trade studies | +| [hidePlugInFrame](hide-plug-in-frame.md) | abstract fun [hidePlugInFrame](hide-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Hides the frame window which the java plugin is embedded in | +| [HTMLViewerWaitForClose](-h-t-m-l-viewer-wait-for-close.md) | abstract fun [HTMLViewerWaitForClose](-h-t-m-l-viewer-wait-for-close.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
waits for the HTMLViewer embedded browser tool to close | +| [internalLicensing](internal-licensing.md) | abstract fun [internalLicensing](internal-licensing.md)(one: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), two: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
For internal use only | +| [invokeHelp](invoke-help.md) | abstract fun [invokeHelp](invoke-help.md)(helpID: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Display a topic in ModelCenter's help system | +| [isOkToClose](is-ok-to-close.md) | abstract fun [isOkToClose](is-ok-to-close.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determine whether it's ok to shutdown ModelCenter or whether there are still windows open | +| [launchDataCollectorPlugIn](launch-data-collector-plug-in.md) | abstract fun [launchDataCollectorPlugIn](launch-data-collector-plug-in.md)(plugInName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), dataExplorer: [DataExplorer](../-data-explorer/index.md))
Launches a specific Data Collector PlugIn, by name, on the specified Data Explorer. | +| [launchHTMLViewer](launch-h-t-m-l-viewer.md) | abstract fun [launchHTMLViewer](launch-h-t-m-l-viewer.md)(url: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), popup: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
starts the HTMLViewer embedded browser tool | +| [launchMacroEditor](launch-macro-editor.md) | abstract fun [launchMacroEditor](launch-macro-editor.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
launches the macro editor, displays the macro scrip if it exists | +| [launchTradeStudy](launch-trade-study.md) | abstract fun [launchTradeStudy](launch-trade-study.md)(idStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Launches the specified trade study. | +| [loadFile](load-file.md) | abstract fun [loadFile](load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
abstract fun [loadFile](load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), connectErrorMode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
opens the specified Model | +| [loadModel](load-model.md) | abstract fun [loadModel](load-model.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
abstract fun [loadModel](load-model.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), connectErrorMode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
opens the specified Model | +| [MessageBox](-message-box.md) | abstract fun [MessageBox](-message-box.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
displays a Windows Message Box | +| [moveComponent](move-component.md) | abstract fun [moveComponent](move-component.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Moves a component. | +| [newInstance](new-instance.md) | abstract fun [newInstance](new-instance.md)(): [IModelCenter](index.md)
creates a new ModelCenter object (that is connected to the same ModelCenter session) that is not currently attached to any thread. | +| [newModel](new-model.md) | abstract fun [newModel](new-model.md)()
loads ModelCenter with a new, empty Model (data dependency model - MODEL_TYPE_DATA)
abstract fun [newModel](new-model.md)(modelType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
loads ModelCenter with a new, empty Model | +| [parallelInstance](parallel-instance.md) | abstract fun [parallelInstance](parallel-instance.md)(): [ModelCenter](../-model-center/index.md)
For internal use only | +| [release](release.md) | abstract fun [release](release.md)()
Releases the COM reference to ModelCenter for this object. | +| [removeComponent](remove-component.md) | abstract fun [removeComponent](remove-component.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Removes a specified component | +| [removeDataMonitor](remove-data-monitor.md) | abstract fun [removeDataMonitor](remove-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Variant](../-variant/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
remove a specific data monitor associated with a particular component | +| [run](run.md) | abstract fun [run](run.md)(variableArray: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
A comma-separated list of ModelCenter variables to validate. | +| [runAntFile](run-ant-file.md) | abstract fun [runAntFile](run-ant-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
runs an ANT testing file | +| [runMacro](run-macro.md) | abstract fun [runMacro](run-macro.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
runs a macro | +| [runMacro2](run-macro2.md) | abstract fun [runMacro2](run-macro2.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
runs a macro and passes the current modelCenter object to the script (i.e. | +| [saveModel](save-model.md) | abstract fun [saveModel](save-model.md)()
saves the current Model with it's existing file name | +| [saveModelAs](save-model-as.md) | abstract fun [saveModelAs](save-model-as.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
saves the current Model with the specified file name | +| [saveTradeStudy](save-trade-study.md) | abstract fun [saveTradeStudy](save-trade-study.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileType: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), dataExplorer: [DataExplorer](../-data-explorer/index.md))
Save the trade study inside of the Data Explorer | +| [saveVersionedModel](save-versioned-model.md) | abstract fun [saveVersionedModel](save-versioned-model.md)(versionStatus: [ModelCenter.VersionStatus](../-model-center/-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
saves the current Model with it's existing file name | +| [saveVersionedModelAs](save-versioned-model-as.md) | abstract fun [saveVersionedModelAs](save-versioned-model-as.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), versionStatus: [ModelCenter.VersionStatus](../-model-center/-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
saves the current Model with the specified file name | +| [setAssemblyStyle](set-assembly-style.md) | abstract fun [setAssemblyStyle](set-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), style: [ModelCenter.AssemblyStyle](../-model-center/-assembly-style/index.md))
Set the visual style of an assembly.
abstract fun [setAssemblyStyle](set-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), style: [ModelCenter.AssemblyStyle](../-model-center/-assembly-style/index.md), width: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), height: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Set the visual style of an assembly including (optionally) width and height. | +| [setIconPlugInFrame](set-icon-plug-in-frame.md) | abstract fun [setIconPlugInFrame](set-icon-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), iconFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the icon for the frame window which the java plugin is embedded in | +| [setLoginCallback](set-login-callback.md) | abstract fun [setLoginCallback](set-login-callback.md)(callback: [ILoginCallback](../-i-login-callback/index.md))
Set the login callback to use | +| [setMacroScript](set-macro-script.md) | abstract fun [setMacroScript](set-macro-script.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), script: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set the script for a macro if the macro exists | +| [setMacroScriptLanguage](set-macro-script-language.md) | abstract fun [setMacroScriptLanguage](set-macro-script-language.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), language: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set the script lancuage for a macro if the macro exists | +| [setPassword](set-password.md) | abstract fun [setPassword](set-password.md)(password: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the global default password combination in ModelCenter | +| [setPreference](set-preference.md) | abstract fun [setPreference](set-preference.md)(prefName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets a preference | +| [setRunOnlyMode](set-run-only-mode.md) | abstract fun [setRunOnlyMode](set-run-only-mode.md)(shouldBeInRunOnly: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets the status of ModelCenter being in Run-Only Mode to the specified value. | +| [setScheduler](set-scheduler.md) | abstract fun [setScheduler](set-scheduler.md)(scheduler: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the appropriate schdeuler. | +| [setScreenUpdating](set-screen-updating.md) | abstract fun [setScreenUpdating](set-screen-updating.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets a flag indicating if the ModelCenter window should update due to Model changes. | +| [setUserName](set-user-name.md) | abstract fun [setUserName](set-user-name.md)(username: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the global default username combination in ModelCenter | +| [setValue](set-value.md) | abstract fun [setValue](set-value.md)(varName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value for the specified variable | +| [showFileBrowseDialog](show-file-browse-dialog.md) | abstract fun [showFileBrowseDialog](show-file-browse-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
abstract fun [showFileBrowseDialog](show-file-browse-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Displays file selection dialog for loading and returns URL of selected file. | +| [showFileSaveDialog](show-file-save-dialog.md) | abstract fun [showFileSaveDialog](show-file-save-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), selectedFilter: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html)>, initialFileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Displays file selection dialog for saving and returns URL of selected file. | +| [showPlugInFrame](show-plug-in-frame.md) | abstract fun [showPlugInFrame](show-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Shows the frame window which the java plugin is embedded in | +| [startGUIMode](start-g-u-i-mode.md) | abstract fun [startGUIMode](start-g-u-i-mode.md)(showDialogs: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
THIS FUNCTION IS A BETA CAPABILITY Normally when invoked via COM, ModelCenter is in "server" mode and it hides all GUI and dialogs. | +| [tradeStudyEnd](trade-study-end.md) | abstract fun [tradeStudyEnd](trade-study-end.md)()
lets ModelCenter know that a trade study is ending | +| [tradeStudyStart](trade-study-start.md) | abstract fun [tradeStudyStart](trade-study-start.md)()
lets ModelCenter know that a trade study is beginning | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/internal-licensing.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/internal-licensing.md index a8d8181106..24ef00c0ea 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/internal-licensing.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/internal-licensing.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[internalLicensing](internal-licensing.md) - -# internalLicensing - - -abstract fun [internalLicensing](internal-licensing.md)(one: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), two: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -For internal use only +# internalLicensing + + +abstract fun [internalLicensing](internal-licensing.md)(one: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), two: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +For internal use only diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/invoke-help.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/invoke-help.md index a4a151b00e..5bf8d14c1c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/invoke-help.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/invoke-help.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[invokeHelp](invoke-help.md) - -# invokeHelp - - -abstract fun [invokeHelp](invoke-help.md)(helpID: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -Display a topic in ModelCenter's help system - -#### Parameters - - - -| | | -|---|---| -| helpID | The id of the help topic to display: | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# invokeHelp + + +abstract fun [invokeHelp](invoke-help.md)(helpID: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +Display a topic in ModelCenter's help system + +#### Parameters + + + +| | | +|---|---| +| helpID | The id of the help topic to display: | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/is-ok-to-close.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/is-ok-to-close.md index 73296c4abb..a382af6c7a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/is-ok-to-close.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/is-ok-to-close.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[isOkToClose](is-ok-to-close.md) - -# isOkToClose - - -abstract fun [isOkToClose](is-ok-to-close.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Determine whether it's ok to shutdown ModelCenter or whether there are still windows open +# isOkToClose + + +abstract fun [isOkToClose](is-ok-to-close.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Determine whether it's ok to shutdown ModelCenter or whether there are still windows open diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-data-collector-plug-in.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-data-collector-plug-in.md index 5d39c8cdfd..6bc22c76fe 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-data-collector-plug-in.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-data-collector-plug-in.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[launchDataCollectorPlugIn](launch-data-collector-plug-in.md) - -# launchDataCollectorPlugIn - - -abstract fun [launchDataCollectorPlugIn](launch-data-collector-plug-in.md)(plugInName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), dataExplorer: [DataExplorer](../-data-explorer/index.md)) - -Launches a specific Data Collector PlugIn, by name, on the specified Data Explorer. - -#### Parameters - - - -| | | -|---|---| -| plugInName | The name of the Data Collector PlugIn to be launched | -| dataExplorer | The Data Explorer for which to launch the PlugIn | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | If something goes wrong in launching the PlugIn | +# launchDataCollectorPlugIn + + +abstract fun [launchDataCollectorPlugIn](launch-data-collector-plug-in.md)(plugInName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), dataExplorer: [DataExplorer](../-data-explorer/index.md)) + +Launches a specific Data Collector PlugIn, by name, on the specified Data Explorer. + +#### Parameters + + + +| | | +|---|---| +| plugInName | The name of the Data Collector PlugIn to be launched | +| dataExplorer | The Data Explorer for which to launch the PlugIn | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | If something goes wrong in launching the PlugIn | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-h-t-m-l-viewer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-h-t-m-l-viewer.md index f48108f1f1..1205f4abcb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-h-t-m-l-viewer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-h-t-m-l-viewer.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[launchHTMLViewer](launch-h-t-m-l-viewer.md) - -# launchHTMLViewer - - -abstract fun [launchHTMLViewer](launch-h-t-m-l-viewer.md)(url: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), popup: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -starts the HTMLViewer embedded browser tool +# launchHTMLViewer + + +abstract fun [launchHTMLViewer](launch-h-t-m-l-viewer.md)(url: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), popup: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +starts the HTMLViewer embedded browser tool diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-macro-editor.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-macro-editor.md index f368d40113..b830ab0abd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-macro-editor.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-macro-editor.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[launchMacroEditor](launch-macro-editor.md) - -# launchMacroEditor - - -abstract fun [launchMacroEditor](launch-macro-editor.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -launches the macro editor, displays the macro scrip if it exists - -#### Parameters - - - -| | | -|---|---| -| macroName | the macro to display in the editor | +# launchMacroEditor + + +abstract fun [launchMacroEditor](launch-macro-editor.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +launches the macro editor, displays the macro scrip if it exists + +#### Parameters + + + +| | | +|---|---| +| macroName | the macro to display in the editor | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-trade-study.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-trade-study.md index 84404d60b7..c33ae88c8f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-trade-study.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-trade-study.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[launchTradeStudy](launch-trade-study.md) - -# launchTradeStudy - - -abstract fun [launchTradeStudy](launch-trade-study.md)(idStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Launches the specified trade study. May be a common name, like "doe" or a fully specified URL like "common:\\tradestudy\\doe" - -#### Parameters - - - -| | | -|---|---| -| idStr | the trade study name | +# launchTradeStudy + + +abstract fun [launchTradeStudy](launch-trade-study.md)(idStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Launches the specified trade study. May be a common name, like "doe" or a fully specified URL like "common:\\tradestudy\\doe" + +#### Parameters + + + +| | | +|---|---| +| idStr | the trade study name | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/load-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/load-file.md index 285bd6ecf9..eeafbd4abd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/load-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/load-file.md @@ -1,42 +1,40 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[loadFile](load-file.md) - -# loadFile - - -abstract fun [loadFile](load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -opens the specified Model - -#### Parameters - - - -| | | -|---|---| -| modelFile | the Model to open | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -abstract fun [loadFile](load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), connectErrorMode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -opens the specified Model - -#### Parameters - - - -| | | -|---|---| -| modelFile | the Model to open | -| connectErrorMode | What to do when a connect error is encountered. (see error modes below)
```kotlin Error Modes: CONN_ERR_ERROR - (default) Abort loading and throw the error back to the caller. CONN_ERR_IGNORE - Ignore the error and continue loading (as if user has pressed "Ignore" in the dialog). CONN_ERR_USEDIALOG - (option not available when running ModelCenter in server mode) Shows the error as if the user were loading the file manually with full control. ``` | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# loadFile + + +abstract fun [loadFile](load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +opens the specified Model + +#### Parameters + + + +| | | +|---|---| +| modelFile | the Model to open | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +abstract fun [loadFile](load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), connectErrorMode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +opens the specified Model + +#### Parameters + + + +| | | +|---|---| +| modelFile | the Model to open | +| connectErrorMode | What to do when a connect error is encountered. (see error modes below)
```kotlin Error Modes: CONN_ERR_ERROR - (default) Abort loading and throw the error back to the caller. CONN_ERR_IGNORE - Ignore the error and continue loading (as if user has pressed "Ignore" in the dialog). CONN_ERR_USEDIALOG - (option not available when running ModelCenter in server mode) Shows the error as if the user were loading the file manually with full control. ``` | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/load-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/load-model.md index b81ca4228c..c081d57be5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/load-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/load-model.md @@ -1,42 +1,40 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[loadModel](load-model.md) - -# loadModel - - -abstract fun [loadModel](load-model.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -opens the specified Model - -#### Parameters - - - -| | | -|---|---| -| modelFile | the Model to open | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -abstract fun [loadModel](load-model.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), connectErrorMode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -opens the specified Model - -#### Parameters - - - -| | | -|---|---| -| modelFile | the Model to open | -| connectErrorMode | What to do when a connect error is encountered. (see error modes below)
```kotlin Error Modes: CONN_ERR_ERROR - (default) Abort loading and throw the error back to the caller. CONN_ERR_IGNORE - Ignore the error and continue loading (as if user has pressed "Ignore" in the dialog). CONN_ERR_USEDIALOG - (option not available when running ModelCenter in server mode) Shows the error as if the user were loading the file manually with full control. ``` | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# loadModel + + +abstract fun [loadModel](load-model.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +opens the specified Model + +#### Parameters + + + +| | | +|---|---| +| modelFile | the Model to open | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +abstract fun [loadModel](load-model.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), connectErrorMode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +opens the specified Model + +#### Parameters + + + +| | | +|---|---| +| modelFile | the Model to open | +| connectErrorMode | What to do when a connect error is encountered. (see error modes below)
```kotlin Error Modes: CONN_ERR_ERROR - (default) Abort loading and throw the error back to the caller. CONN_ERR_IGNORE - Ignore the error and continue loading (as if user has pressed "Ignore" in the dialog). CONN_ERR_USEDIALOG - (option not available when running ModelCenter in server mode) Shows the error as if the user were loading the file manually with full control. ``` | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/move-component.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/move-component.md index 5a84eb7474..8ee6d99bf5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/move-component.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/move-component.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[moveComponent](move-component.md) - -# moveComponent - - -abstract fun [moveComponent](move-component.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -Moves a component. - -#### Parameters - - - -| | | -|---|---| -| component | the component to move | -| parent | the name of the parent | -| index | the index to move to; -1 for end | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# moveComponent + + +abstract fun [moveComponent](move-component.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +Moves a component. + +#### Parameters + + + +| | | +|---|---| +| component | the component to move | +| parent | the name of the parent | +| index | the index to move to; -1 for end | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/new-instance.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/new-instance.md index 7337802006..bfddbff790 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/new-instance.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/new-instance.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[newInstance](new-instance.md) - -# newInstance - - -abstract fun [newInstance](new-instance.md)(): [IModelCenter](index.md) - -creates a new ModelCenter object (that is connected to the same ModelCenter session) that is not currently attached to any thread. Use this method if you need to call ModelCenter from multiple threads. The spawning thread should call this function for each thread that needs to call ModelCenter. The new instance should be passed to the spawned thread and used there. - -#### Return - -a ModelCenter instance that is not attached to any thread - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# newInstance + + +abstract fun [newInstance](new-instance.md)(): [IModelCenter](index.md) + +creates a new ModelCenter object (that is connected to the same ModelCenter session) that is not currently attached to any thread. Use this method if you need to call ModelCenter from multiple threads. The spawning thread should call this function for each thread that needs to call ModelCenter. The new instance should be passed to the spawned thread and used there. + +#### Return + +a ModelCenter instance that is not attached to any thread + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/new-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/new-model.md index 18d22c49cb..8dbb7506a7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/new-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/new-model.md @@ -1,33 +1,31 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[newModel](new-model.md) - -# newModel - - -abstract fun [newModel](new-model.md)() - -loads ModelCenter with a new, empty Model (data dependency model - MODEL_TYPE_DATA) - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -abstract fun [newModel](new-model.md)(modelType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -loads ModelCenter with a new, empty Model - -#### Parameters - - - -| | | -|---|---| -| modelType | can be either MODEL_TYPE_DATA to create a traditional data dependency ModelCenter model or MODEL_TYPE_PROCESS to create a model that can incorporate newer process modeling components and features | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# newModel + + +abstract fun [newModel](new-model.md)() + +loads ModelCenter with a new, empty Model (data dependency model - MODEL_TYPE_DATA) + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +abstract fun [newModel](new-model.md)(modelType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +loads ModelCenter with a new, empty Model + +#### Parameters + + + +| | | +|---|---| +| modelType | can be either MODEL_TYPE_DATA to create a traditional data dependency ModelCenter model or MODEL_TYPE_PROCESS to create a model that can incorporate newer process modeling components and features | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/parallel-instance.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/parallel-instance.md index a18c6356ce..078ce3d16c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/parallel-instance.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/parallel-instance.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[parallelInstance](parallel-instance.md) - -# parallelInstance - - -abstract fun [parallelInstance](parallel-instance.md)(): [ModelCenter](../-model-center/index.md) - -For internal use only +# parallelInstance + + +abstract fun [parallelInstance](parallel-instance.md)(): [ModelCenter](../-model-center/index.md) + +For internal use only diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/release.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/release.md index e4b709e216..5da2a77919 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/release.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/release.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[release](release.md) - -# release - - -abstract fun [release](release.md)() - -Releases the COM reference to ModelCenter for this object. Although some attempt is made to clean up objects automatically through releaseObjects(), failure to call this function can sometimes lead to intermittent and difficult to debug problems or memory leaks. This object can no longer be used after calling release, but it is safe to call release() multiple times. - - ModelCenter 6.1 includes a Reference Debugger on the Java Console window which can be used to find objects which have not been properly released. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# release + + +abstract fun [release](release.md)() + +Releases the COM reference to ModelCenter for this object. Although some attempt is made to clean up objects automatically through releaseObjects(), failure to call this function can sometimes lead to intermittent and difficult to debug problems or memory leaks. This object can no longer be used after calling release, but it is safe to call release() multiple times. + + ModelCenter 6.1 includes a Reference Debugger on the Java Console window which can be used to find objects which have not been properly released. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/remove-component.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/remove-component.md index 5450dbb1e7..6bf0186950 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/remove-component.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/remove-component.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[removeComponent](remove-component.md) - -# removeComponent - - -abstract fun [removeComponent](remove-component.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Removes a specified component - -#### Parameters - - - -| | | -|---|---| -| component | the component to remove | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# removeComponent + + +abstract fun [removeComponent](remove-component.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Removes a specified component + +#### Parameters + + + +| | | +|---|---| +| component | the component to remove | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/remove-data-monitor.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/remove-data-monitor.md index 9f027dac46..032287da39 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/remove-data-monitor.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/remove-data-monitor.md @@ -1,21 +1,19 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[removeDataMonitor](remove-data-monitor.md) - -# removeDataMonitor - - -abstract fun [removeDataMonitor](remove-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Variant](../-variant/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -remove a specific data monitor associated with a particular component - -#### Return - -whether the data monitor was successfully found and deleted - -#### Parameters - - - -| | | -|---|---| -| component | the name of the component under which to find the data monitor for deletion | -| index | the integer index (0-based index) or string title of the data monitor being removed | +# removeDataMonitor + + +abstract fun [removeDataMonitor](remove-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Variant](../-variant/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +remove a specific data monitor associated with a particular component + +#### Return + +whether the data monitor was successfully found and deleted + +#### Parameters + + + +| | | +|---|---| +| component | the name of the component under which to find the data monitor for deletion | +| index | the integer index (0-based index) or string title of the data monitor being removed | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run-ant-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run-ant-file.md index d9a47f60ce..a02ae0581b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run-ant-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run-ant-file.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[runAntFile](run-ant-file.md) - -# runAntFile - - -abstract fun [runAntFile](run-ant-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -runs an ANT testing file +# runAntFile + + +abstract fun [runAntFile](run-ant-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +runs an ANT testing file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run-macro.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run-macro.md index a17b8a99fe..f22cc76174 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run-macro.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run-macro.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[runMacro](run-macro.md) - -# runMacro - - -abstract fun [runMacro](run-macro.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) - -runs a macro - -#### Return - -Variant(reserved for future use) - -#### Parameters - - - -| | | -|---|---| -| macroName | the name of the macro to run | +# runMacro + + +abstract fun [runMacro](run-macro.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) + +runs a macro + +#### Return + +Variant(reserved for future use) + +#### Parameters + + + +| | | +|---|---| +| macroName | the name of the macro to run | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run-macro2.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run-macro2.md index 2de27037a7..4c761bde21 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run-macro2.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run-macro2.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[runMacro2](run-macro2.md) - -# runMacro2 - - -abstract fun [runMacro2](run-macro2.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) - -runs a macro and passes the current modelCenter object to the script (i.e., the script "app" object) - -#### Return - -Variant(reserved for future use) - -#### Parameters - - - -| | | -|---|---| -| macroName | the name of the macro to run | +# runMacro2 + + +abstract fun [runMacro2](run-macro2.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) + +runs a macro and passes the current modelCenter object to the script (i.e., the script "app" object) + +#### Return + +Variant(reserved for future use) + +#### Parameters + + + +| | | +|---|---| +| macroName | the name of the macro to run | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run.md index 16993712aa..5e4e6189f2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[run](run.md) - -# run - - -abstract fun [run](run.md)(variableArray: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -A comma-separated list of ModelCenter variables to validate. If no variables are specified then the entire model will be run (equivalent to clicking the scheduler run button). - -#### Parameters - - - -| | | -|---|---| -| variableArray | a csv | +# run + + +abstract fun [run](run.md)(variableArray: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +A comma-separated list of ModelCenter variables to validate. If no variables are specified then the entire model will be run (equivalent to clicking the scheduler run button). + +#### Parameters + + + +| | | +|---|---| +| variableArray | a csv | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-model-as.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-model-as.md index 5173fd6036..d4c5f909f4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-model-as.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-model-as.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[saveModelAs](save-model-as.md) - -# saveModelAs - - -abstract fun [saveModelAs](save-model-as.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -saves the current Model with the specified file name - -#### Parameters - - - -| | | -|---|---| -| fileName | the file name to save the Model as | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# saveModelAs + + +abstract fun [saveModelAs](save-model-as.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +saves the current Model with the specified file name + +#### Parameters + + + +| | | +|---|---| +| fileName | the file name to save the Model as | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-model.md index 2ca5b00a49..1fdccfd667 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-model.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[saveModel](save-model.md) - -# saveModel - - -abstract fun [saveModel](save-model.md)() - -saves the current Model with it's existing file name - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# saveModel + + +abstract fun [saveModel](save-model.md)() + +saves the current Model with it's existing file name + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-trade-study.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-trade-study.md index 4b4307ecce..63c7e2917b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-trade-study.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-trade-study.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[saveTradeStudy](save-trade-study.md) - -# saveTradeStudy - - -abstract fun [saveTradeStudy](save-trade-study.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileType: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), dataExplorer: [DataExplorer](../-data-explorer/index.md)) - -Save the trade study inside of the Data Explorer - -#### Parameters - - - -| | | -|---|---| -| uri | the URI to save the trade study to | -| fileType | the file format for the trade study | -| dataExplorer | a pointer to the Data Explorer from which to save | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if an argument is invalid or if an error occurs while saving | +# saveTradeStudy + + +abstract fun [saveTradeStudy](save-trade-study.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileType: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), dataExplorer: [DataExplorer](../-data-explorer/index.md)) + +Save the trade study inside of the Data Explorer + +#### Parameters + + + +| | | +|---|---| +| uri | the URI to save the trade study to | +| fileType | the file format for the trade study | +| dataExplorer | a pointer to the Data Explorer from which to save | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if an argument is invalid or if an error occurs while saving | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-versioned-model-as.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-versioned-model-as.md index bcbc735bd2..c078139a0d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-versioned-model-as.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-versioned-model-as.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[saveVersionedModelAs](save-versioned-model-as.md) - -# saveVersionedModelAs - - -abstract fun [saveVersionedModelAs](save-versioned-model-as.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), versionStatus: [ModelCenter.VersionStatus](../-model-center/-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -saves the current Model with the specified file name - -#### Parameters - - - -| | | -|---|---| -| fileName | the file name to save the Model as | -| versionStatus | how to go about versioning the file | -| checkinMessage | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# saveVersionedModelAs + + +abstract fun [saveVersionedModelAs](save-versioned-model-as.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), versionStatus: [ModelCenter.VersionStatus](../-model-center/-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +saves the current Model with the specified file name + +#### Parameters + + + +| | | +|---|---| +| fileName | the file name to save the Model as | +| versionStatus | how to go about versioning the file | +| checkinMessage | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-versioned-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-versioned-model.md index 62a2f5534a..e32246ce7c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-versioned-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-versioned-model.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[saveVersionedModel](save-versioned-model.md) - -# saveVersionedModel - - -abstract fun [saveVersionedModel](save-versioned-model.md)(versionStatus: [ModelCenter.VersionStatus](../-model-center/-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -saves the current Model with it's existing file name - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# saveVersionedModel + + +abstract fun [saveVersionedModel](save-versioned-model.md)(versionStatus: [ModelCenter.VersionStatus](../-model-center/-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +saves the current Model with it's existing file name + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-assembly-style.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-assembly-style.md index a84e896616..71337c50f3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-assembly-style.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-assembly-style.md @@ -1,37 +1,35 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[setAssemblyStyle](set-assembly-style.md) - -# setAssemblyStyle - - -abstract fun [setAssemblyStyle](set-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), style: [ModelCenter.AssemblyStyle](../-model-center/-assembly-style/index.md)) - -Set the visual style of an assembly. This method can be used to modify any control with children, including IF blocks, traditional assemblies, drivers (in process mode), sequences, and parallel blocks. - -#### Parameters - - - -| | | -|---|---| -| assemblyName | the full name of the assembly to modify | -| style | the style | - - -abstract fun [setAssemblyStyle](set-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), style: [ModelCenter.AssemblyStyle](../-model-center/-assembly-style/index.md), width: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), height: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - - Set the visual style of an assembly including (optionally) width and height. Style constants are defined above and in ModelCenter.odl in the ModelCenter project. - - Width and height are ignored for the model, elements to be collapsed, and for assemblies which are not data-driven. - - This method can be used to modify any control with children, including IF blocks, traditional assemblies, drivers (in process mode), sequences, and parallel blocks. - -#### Parameters - - - -| | | -|---|---| -| assemblyName | the full name of the assembly to modify | -| style | the style | -| width | the new width; ignored when <= 0 | -| height | the new height; ignored when <= 0 | +# setAssemblyStyle + + +abstract fun [setAssemblyStyle](set-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), style: [ModelCenter.AssemblyStyle](../-model-center/-assembly-style/index.md)) + +Set the visual style of an assembly. This method can be used to modify any control with children, including IF blocks, traditional assemblies, drivers (in process mode), sequences, and parallel blocks. + +#### Parameters + + + +| | | +|---|---| +| assemblyName | the full name of the assembly to modify | +| style | the style | + + +abstract fun [setAssemblyStyle](set-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), style: [ModelCenter.AssemblyStyle](../-model-center/-assembly-style/index.md), width: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), height: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + + Set the visual style of an assembly including (optionally) width and height. Style constants are defined above and in ModelCenter.odl in the ModelCenter project. + + Width and height are ignored for the model, elements to be collapsed, and for assemblies which are not data-driven. + + This method can be used to modify any control with children, including IF blocks, traditional assemblies, drivers (in process mode), sequences, and parallel blocks. + +#### Parameters + + + +| | | +|---|---| +| assemblyName | the full name of the assembly to modify | +| style | the style | +| width | the new width; ignored when <= 0 | +| height | the new height; ignored when <= 0 | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-icon-plug-in-frame.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-icon-plug-in-frame.md index c53a24ea45..04cf9092a4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-icon-plug-in-frame.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-icon-plug-in-frame.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[setIconPlugInFrame](set-icon-plug-in-frame.md) - -# setIconPlugInFrame - - -abstract fun [setIconPlugInFrame](set-icon-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), iconFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Sets the icon for the frame window which the java plugin is embedded in - -#### Parameters - - - -| | | -|---|---| -| hwnd | handle to the frame window CWnd | -| iconFile | string to the absolute location of the icon file | +# setIconPlugInFrame + + +abstract fun [setIconPlugInFrame](set-icon-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), iconFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Sets the icon for the frame window which the java plugin is embedded in + +#### Parameters + + + +| | | +|---|---| +| hwnd | handle to the frame window CWnd | +| iconFile | string to the absolute location of the icon file | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-login-callback.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-login-callback.md index a522bdc721..fe5820e772 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-login-callback.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-login-callback.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[setLoginCallback](set-login-callback.md) - -# setLoginCallback - - -abstract fun [setLoginCallback](set-login-callback.md)(callback: [ILoginCallback](../-i-login-callback/index.md)) - -Set the login callback to use - -#### Parameters - - - -| | | -|---|---| -| callback | callback to use | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setLoginCallback + + +abstract fun [setLoginCallback](set-login-callback.md)(callback: [ILoginCallback](../-i-login-callback/index.md)) + +Set the login callback to use + +#### Parameters + + + +| | | +|---|---| +| callback | callback to use | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-macro-script-language.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-macro-script-language.md index fcc6bb1316..5e8b312141 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-macro-script-language.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-macro-script-language.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[setMacroScriptLanguage](set-macro-script-language.md) - -# setMacroScriptLanguage - - -abstract fun [setMacroScriptLanguage](set-macro-script-language.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), language: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -set the script lancuage for a macro if the macro exists - -#### Parameters - - - -| | | -|---|---| -| macroName | the name of the macro | -| language | the macro script language | +# setMacroScriptLanguage + + +abstract fun [setMacroScriptLanguage](set-macro-script-language.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), language: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +set the script lancuage for a macro if the macro exists + +#### Parameters + + + +| | | +|---|---| +| macroName | the name of the macro | +| language | the macro script language | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-macro-script.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-macro-script.md index b80e640a10..46d87dcaee 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-macro-script.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-macro-script.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[setMacroScript](set-macro-script.md) - -# setMacroScript - - -abstract fun [setMacroScript](set-macro-script.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), script: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -set the script for a macro if the macro exists - -#### Parameters - - - -| | | -|---|---| -| macroName | the name of the macro | -| script | the macro script to display in the editor | +# setMacroScript + + +abstract fun [setMacroScript](set-macro-script.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), script: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +set the script for a macro if the macro exists + +#### Parameters + + + +| | | +|---|---| +| macroName | the name of the macro | +| script | the macro script to display in the editor | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-password.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-password.md index 62a267b20e..9640a3cd8a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-password.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-password.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[setPassword](set-password.md) - -# setPassword - - -abstract fun [setPassword](set-password.md)(password: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Sets the global default password combination in ModelCenter - -#### Parameters - - - -| | | -|---|---| -| password | the new global default password | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setPassword + + +abstract fun [setPassword](set-password.md)(password: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Sets the global default password combination in ModelCenter + +#### Parameters + + + +| | | +|---|---| +| password | the new global default password | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-preference.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-preference.md index f6b3c66233..c9638fc90a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-preference.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-preference.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[setPreference](set-preference.md) - -# setPreference - - -abstract fun [setPreference](set-preference.md)(prefName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Sets a preference - -#### Parameters - - - -| | | -|---|---| -| prefName | the name of the preference | -| value | the new preference value | +# setPreference + + +abstract fun [setPreference](set-preference.md)(prefName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Sets a preference + +#### Parameters + + + +| | | +|---|---| +| prefName | the name of the preference | +| value | the new preference value | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-run-only-mode.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-run-only-mode.md index 82b97c102e..e29860152d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-run-only-mode.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-run-only-mode.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[setRunOnlyMode](set-run-only-mode.md) - -# setRunOnlyMode - - -abstract fun [setRunOnlyMode](set-run-only-mode.md)(shouldBeInRunOnly: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Sets the status of ModelCenter being in Run-Only Mode to the specified value. - - Note: This function can only be called if it is the first function to be called on a new ModelCenter object; otherwise, it will throw an exception. This is to ensure that the correct ModelCenter license is checked out. - -#### Parameters - - - -| | | -|---|---| -| shouldBeInRunOnly | true if ModelCenter should be in Run-Only Mode; otherwise, false | +# setRunOnlyMode + + +abstract fun [setRunOnlyMode](set-run-only-mode.md)(shouldBeInRunOnly: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Sets the status of ModelCenter being in Run-Only Mode to the specified value. + + Note: This function can only be called if it is the first function to be called on a new ModelCenter object; otherwise, it will throw an exception. This is to ensure that the correct ModelCenter license is checked out. + +#### Parameters + + + +| | | +|---|---| +| shouldBeInRunOnly | true if ModelCenter should be in Run-Only Mode; otherwise, false | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-scheduler.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-scheduler.md index bee1ed4157..5ac8867839 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-scheduler.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-scheduler.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[setScheduler](set-scheduler.md) - -# setScheduler - - -abstract fun [setScheduler](set-scheduler.md)(scheduler: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Sets the appropriate schdeuler. Options are "forward", "backward", "mixed", and "script" - -#### Parameters - - - -| | | -|---|---| -| scheduler | the new scheduler | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setScheduler + + +abstract fun [setScheduler](set-scheduler.md)(scheduler: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Sets the appropriate schdeuler. Options are "forward", "backward", "mixed", and "script" + +#### Parameters + + + +| | | +|---|---| +| scheduler | the new scheduler | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-screen-updating.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-screen-updating.md index adcd093fc7..0e23ab565b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-screen-updating.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-screen-updating.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[setScreenUpdating](set-screen-updating.md) - -# setScreenUpdating - - -abstract fun [setScreenUpdating](set-screen-updating.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets a flag indicating if the ModelCenter window should update due to Model changes. If this function is called multiple times with the flag set to false, screen updating will not be turned back on again until an equal number of calls are made with the value equal to true. - -#### Parameters - - - -| | | -|---|---| -| flag | false to turn updating off, true to turn it on | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setScreenUpdating + + +abstract fun [setScreenUpdating](set-screen-updating.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets a flag indicating if the ModelCenter window should update due to Model changes. If this function is called multiple times with the flag set to false, screen updating will not be turned back on again until an equal number of calls are made with the value equal to true. + +#### Parameters + + + +| | | +|---|---| +| flag | false to turn updating off, true to turn it on | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-user-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-user-name.md index bffb903bcf..bf0ce6cbda 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-user-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-user-name.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[setUserName](set-user-name.md) - -# setUserName - - -abstract fun [setUserName](set-user-name.md)(username: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Sets the global default username combination in ModelCenter - -#### Parameters - - - -| | | -|---|---| -| username | the new global default username | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setUserName + + +abstract fun [setUserName](set-user-name.md)(username: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Sets the global default username combination in ModelCenter + +#### Parameters + + + +| | | +|---|---| +| username | the new global default username | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-value.md index a4eded929e..0084e9692d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-value.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[setValue](set-value.md) - -# setValue - - -abstract fun [setValue](set-value.md)(varName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the value for the specified variable - -#### Parameters - - - -| | | -|---|---| -| varName | the full variable name | -| value | the value to set the variable to | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setValue + + +abstract fun [setValue](set-value.md)(varName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the value for the specified variable + +#### Parameters + + + +| | | +|---|---| +| varName | the full variable name | +| value | the value to set the variable to | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-file-browse-dialog.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-file-browse-dialog.md index e3e3f86d3f..5ae4d30038 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-file-browse-dialog.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-file-browse-dialog.md @@ -1,54 +1,52 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[showFileBrowseDialog](show-file-browse-dialog.md) - -# showFileBrowseDialog - - -abstract fun [showFileBrowseDialog](show-file-browse-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Displays file selection dialog for loading and returns URL of selected file. - -#### Return - -URL of selected file, or null if none selected - -#### Parameters - - - -| | | -|---|---| -| title | title of dialog window | -| filters | array of file type filters, may be null | -| initialUri | initialUri to use in dialog, may be null | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -abstract fun [showFileBrowseDialog](show-file-browse-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Displays file selection dialog for loading and returns URL of selected file. - -#### Return - -URL of selected file, or null if none selected - -#### Parameters - - - -| | | -|---|---| -| title | title of dialog window | -| filters | array of file type filters, may be null | -| initialUri | initialUri to use in dialog, may be null | -| hwnd | the window handle to which to parent the dialog | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# showFileBrowseDialog + + +abstract fun [showFileBrowseDialog](show-file-browse-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Displays file selection dialog for loading and returns URL of selected file. + +#### Return + +URL of selected file, or null if none selected + +#### Parameters + + + +| | | +|---|---| +| title | title of dialog window | +| filters | array of file type filters, may be null | +| initialUri | initialUri to use in dialog, may be null | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +abstract fun [showFileBrowseDialog](show-file-browse-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Displays file selection dialog for loading and returns URL of selected file. + +#### Return + +URL of selected file, or null if none selected + +#### Parameters + + + +| | | +|---|---| +| title | title of dialog window | +| filters | array of file type filters, may be null | +| initialUri | initialUri to use in dialog, may be null | +| hwnd | the window handle to which to parent the dialog | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-file-save-dialog.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-file-save-dialog.md index 76067f039c..946da74965 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-file-save-dialog.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-file-save-dialog.md @@ -1,31 +1,29 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[showFileSaveDialog](show-file-save-dialog.md) - -# showFileSaveDialog - - -abstract fun [showFileSaveDialog](show-file-save-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), selectedFilter: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html)>, initialFileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Displays file selection dialog for saving and returns URL of selected file. - -#### Return - -URL of selected file, or null if none selected - -#### Parameters - - - -| | | -|---|---| -| title | title of dialog window | -| filters | array of file type filters, may be null | -| initialFileName | the file name to populate the dialog with initially | -| selectedFilter | the index of the filter selected by the dialog (inout) | -| initialUri | initialUri to use in dialog, may be null | -| hwnd | the window handle to which to parent the dialog | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# showFileSaveDialog + + +abstract fun [showFileSaveDialog](show-file-save-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), selectedFilter: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html)>, initialFileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Displays file selection dialog for saving and returns URL of selected file. + +#### Return + +URL of selected file, or null if none selected + +#### Parameters + + + +| | | +|---|---| +| title | title of dialog window | +| filters | array of file type filters, may be null | +| initialFileName | the file name to populate the dialog with initially | +| selectedFilter | the index of the filter selected by the dialog (inout) | +| initialUri | initialUri to use in dialog, may be null | +| hwnd | the window handle to which to parent the dialog | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-plug-in-frame.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-plug-in-frame.md index 70681be481..0cebbf7995 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-plug-in-frame.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-plug-in-frame.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[showPlugInFrame](show-plug-in-frame.md) - -# showPlugInFrame - - -abstract fun [showPlugInFrame](show-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -Shows the frame window which the java plugin is embedded in - -#### Parameters - - - -| | | -|---|---| -| hwnd | handle to the frame window CWnd | +# showPlugInFrame + + +abstract fun [showPlugInFrame](show-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +Shows the frame window which the java plugin is embedded in + +#### Parameters + + + +| | | +|---|---| +| hwnd | handle to the frame window CWnd | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/start-g-u-i-mode.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/start-g-u-i-mode.md index 448e5d678a..2c22be03e4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/start-g-u-i-mode.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/start-g-u-i-mode.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[startGUIMode](start-g-u-i-mode.md) - -# startGUIMode - - -abstract fun [startGUIMode](start-g-u-i-mode.md)(showDialogs: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -THIS FUNCTION IS A BETA CAPABILITY Normally when invoked via COM, ModelCenter is in "server" mode and it hides all GUI and dialogs. This method can be invoked immediately after instantiating the ModelCenter object to cause the GUI to be displayed. Calling this method at any other time than immediately after creating the ModelCenter object is NOT SUPPORTED. Strange behavior or even crashes will likely ensue if it is called at any other time. Once this method is invoked, ModelCenter may pop up GUI dialogs requiring user interation at any time. This means your script may hang indefinitely if a user is not there to click through. For example, if a component fails to load on model load, the user would be prompted with the failed component dialog and the loadModel() api function would hang until the user answered the dialog. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# startGUIMode + + +abstract fun [startGUIMode](start-g-u-i-mode.md)(showDialogs: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +THIS FUNCTION IS A BETA CAPABILITY Normally when invoked via COM, ModelCenter is in "server" mode and it hides all GUI and dialogs. This method can be invoked immediately after instantiating the ModelCenter object to cause the GUI to be displayed. Calling this method at any other time than immediately after creating the ModelCenter object is NOT SUPPORTED. Strange behavior or even crashes will likely ensue if it is called at any other time. Once this method is invoked, ModelCenter may pop up GUI dialogs requiring user interation at any time. This means your script may hang indefinitely if a user is not there to click through. For example, if a component fails to load on model load, the user would be prompted with the failed component dialog and the loadModel() api function would hang until the user answered the dialog. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/trade-study-end.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/trade-study-end.md index 4aa8530696..4b7f066140 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/trade-study-end.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/trade-study-end.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[tradeStudyEnd](trade-study-end.md) - -# tradeStudyEnd - - -abstract fun [tradeStudyEnd](trade-study-end.md)() - -lets ModelCenter know that a trade study is ending - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# tradeStudyEnd + + +abstract fun [tradeStudyEnd](trade-study-end.md)() + +lets ModelCenter know that a trade study is ending + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/trade-study-start.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/trade-study-start.md index 9e67d40a82..dc0c033507 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/trade-study-start.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-model-center/trade-study-start.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IModelCenter](index.md)/[tradeStudyStart](trade-study-start.md) - -# tradeStudyStart - - -abstract fun [tradeStudyStart](trade-study-start.md)() - -lets ModelCenter know that a trade study is beginning - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# tradeStudyStart + + +abstract fun [tradeStudyStart](trade-study-start.md)() + +lets ModelCenter know that a trade study is beginning + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-author.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-author.md index befc4407f7..49905d4df0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-author.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-author.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IPlugInMetaData](index.md)/[getAuthor](get-author.md) - -# getAuthor - - -abstract fun [getAuthor](get-author.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the Plug-In author - -#### Return - -the author - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# getAuthor + + +abstract fun [getAuthor](get-author.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the Plug-In author + +#### Return + +the author + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-description.md index 9495cccadb..997def52b7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-description.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IPlugInMetaData](index.md)/[getDescription](get-description.md) - -# getDescription - - -abstract fun [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the Plug-In description - -#### Return - -the description - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# getDescription + + +abstract fun [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the Plug-In description + +#### Return + +the description + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-help-u-r-l.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-help-u-r-l.md index a66751f9bf..0ea9cefe0d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-help-u-r-l.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-help-u-r-l.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IPlugInMetaData](index.md)/[getHelpURL](get-help-u-r-l.md) - -# getHelpURL - - -abstract fun [getHelpURL](get-help-u-r-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the Plug-In help URL - -#### Return - -the help URL - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# getHelpURL + + +abstract fun [getHelpURL](get-help-u-r-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the Plug-In help URL + +#### Return + +the help URL + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-icon-location.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-icon-location.md index a2093a00cf..1834da96ff 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-icon-location.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-icon-location.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IPlugInMetaData](index.md)/[getIconLocation](get-icon-location.md) - -# getIconLocation - - -abstract fun [getIconLocation](get-icon-location.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the Plug-In icon location - -#### Return - -the icon location - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# getIconLocation + + +abstract fun [getIconLocation](get-icon-location.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the Plug-In icon location + +#### Return + +the icon location + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-keywords.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-keywords.md index fbd36d9015..802811f470 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-keywords.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-keywords.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IPlugInMetaData](index.md)/[getKeywords](get-keywords.md) - -# getKeywords - - -abstract fun [getKeywords](get-keywords.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the Plug-In keywords - -#### Return - -the keywords - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# getKeywords + + +abstract fun [getKeywords](get-keywords.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the Plug-In keywords + +#### Return + +the keywords + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-version.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-version.md index cbfce2349c..8bbc9a66c5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-version.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-version.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IPlugInMetaData](index.md)/[getVersion](get-version.md) - -# getVersion - - -abstract fun [getVersion](get-version.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the Plug-In version - -#### Return - -the version - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# getVersion + + +abstract fun [getVersion](get-version.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the Plug-In version + +#### Return + +the version + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/index.md index f90044a4b7..3bb55e7c71 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/index.md @@ -1,19 +1,17 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IPlugInMetaData](index.md) - -# IPlugInMetaData - - -interface [IPlugInMetaData](index.md) - -This is the interface that must be implemented by all Java plug-in meta data objects for ModelCenter. - -## Functions - -| Name | Summary | -|---|---| -| [getAuthor](get-author.md) | abstract fun [getAuthor](get-author.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Plug-In author | -| [getDescription](get-description.md) | abstract fun [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Plug-In description | -| [getHelpURL](get-help-u-r-l.md) | abstract fun [getHelpURL](get-help-u-r-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Plug-In help URL | -| [getIconLocation](get-icon-location.md) | abstract fun [getIconLocation](get-icon-location.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Plug-In icon location | -| [getKeywords](get-keywords.md) | abstract fun [getKeywords](get-keywords.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Plug-In keywords | -| [getVersion](get-version.md) | abstract fun [getVersion](get-version.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Plug-In version | +# IPlugInMetaData + + +interface [IPlugInMetaData](index.md) + +This is the interface that must be implemented by all Java plug-in meta data objects for ModelCenter. + +## Functions + +| Name | Summary | +|---|---| +| [getAuthor](get-author.md) | abstract fun [getAuthor](get-author.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Plug-In author | +| [getDescription](get-description.md) | abstract fun [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Plug-In description | +| [getHelpURL](get-help-u-r-l.md) | abstract fun [getHelpURL](get-help-u-r-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Plug-In help URL | +| [getIconLocation](get-icon-location.md) | abstract fun [getIconLocation](get-icon-location.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Plug-In icon location | +| [getKeywords](get-keywords.md) | abstract fun [getKeywords](get-keywords.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Plug-In keywords | +| [getVersion](get-version.md) | abstract fun [getVersion](get-version.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Plug-In version | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/get-comparison-info-h-t-m-l-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/get-comparison-info-h-t-m-l-string.md index 34d1b18e19..65a081f473 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/get-comparison-info-h-t-m-l-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/get-comparison-info-h-t-m-l-string.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IRunDataAction](index.md)/[getComparisonInfoHTMLString](get-comparison-info-h-t-m-l-string.md) - -# getComparisonInfoHTMLString - - -abstract fun [getComparisonInfoHTMLString](get-comparison-info-h-t-m-l-string.md)(runIDs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)>, detailLevel: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -get HTML string to compare designs - -#### Return - -HTML string of the run information - -#### Parameters - - - -| | | -|---|---| -| runIDs | ids of the runs in the comparison list | - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# getComparisonInfoHTMLString + + +abstract fun [getComparisonInfoHTMLString](get-comparison-info-h-t-m-l-string.md)(runIDs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)>, detailLevel: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +get HTML string to compare designs + +#### Return + +HTML string of the run information + +#### Parameters + + + +| | | +|---|---| +| runIDs | ids of the runs in the comparison list | + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/get-run-info-h-t-m-l-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/get-run-info-h-t-m-l-string.md index e765dabe03..f84e8625b0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/get-run-info-h-t-m-l-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/get-run-info-h-t-m-l-string.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IRunDataAction](index.md)/[getRunInfoHTMLString](get-run-info-h-t-m-l-string.md) - -# getRunInfoHTMLString - - -abstract fun [getRunInfoHTMLString](get-run-info-h-t-m-l-string.md)(runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), detailLevel: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -get run info such as brush preference info - -#### Return - -HTML string of the run information - -#### Parameters - - - -| | | -|---|---| -| runID | runID | - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# getRunInfoHTMLString + + +abstract fun [getRunInfoHTMLString](get-run-info-h-t-m-l-string.md)(runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), detailLevel: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +get run info such as brush preference info + +#### Return + +HTML string of the run information + +#### Parameters + + + +| | | +|---|---| +| runID | runID | + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/index.md index f81b4a4075..5f17a89c33 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/index.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IRunDataAction](index.md) - -# IRunDataAction - - -interface [IRunDataAction](index.md) - -This is the interface to handle Design Viewer (geometry tooltip) events delegated to certain types of Data Explorer Plug-Ins such as Data Visualizer - -## Functions - -| Name | Summary | -|---|---| -| [getComparisonInfoHTMLString](get-comparison-info-h-t-m-l-string.md) | abstract fun [getComparisonInfoHTMLString](get-comparison-info-h-t-m-l-string.md)(runIDs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)>, detailLevel: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get HTML string to compare designs | -| [getRunInfoHTMLString](get-run-info-h-t-m-l-string.md) | abstract fun [getRunInfoHTMLString](get-run-info-h-t-m-l-string.md)(runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), detailLevel: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get run info such as brush preference info | -| [passHTMLEvent](pass-h-t-m-l-event.md) | abstract fun [passHTMLEvent](pass-h-t-m-l-event.md)(elementID: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), designViewerID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
pass HTML event to Data Visualizer Java codes | -| [updateHighlight](update-highlight.md) | abstract fun [updateHighlight](update-highlight.md)(runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), highlight: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
update highlighted design | +# IRunDataAction + + +interface [IRunDataAction](index.md) + +This is the interface to handle Design Viewer (geometry tooltip) events delegated to certain types of Data Explorer Plug-Ins such as Data Visualizer + +## Functions + +| Name | Summary | +|---|---| +| [getComparisonInfoHTMLString](get-comparison-info-h-t-m-l-string.md) | abstract fun [getComparisonInfoHTMLString](get-comparison-info-h-t-m-l-string.md)(runIDs: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)>, detailLevel: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get HTML string to compare designs | +| [getRunInfoHTMLString](get-run-info-h-t-m-l-string.md) | abstract fun [getRunInfoHTMLString](get-run-info-h-t-m-l-string.md)(runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), detailLevel: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get run info such as brush preference info | +| [passHTMLEvent](pass-h-t-m-l-event.md) | abstract fun [passHTMLEvent](pass-h-t-m-l-event.md)(elementID: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), designViewerID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
pass HTML event to Data Visualizer Java codes | +| [updateHighlight](update-highlight.md) | abstract fun [updateHighlight](update-highlight.md)(runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), highlight: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
update highlighted design | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/pass-h-t-m-l-event.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/pass-h-t-m-l-event.md index be7e41bf54..2d264315f8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/pass-h-t-m-l-event.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/pass-h-t-m-l-event.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IRunDataAction](index.md)/[passHTMLEvent](pass-h-t-m-l-event.md) - -# passHTMLEvent - - -abstract fun [passHTMLEvent](pass-h-t-m-l-event.md)(elementID: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), designViewerID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -pass HTML event to Data Visualizer Java codes - -#### Parameters - - - -| | | -|---|---| -| elementID | HTML element ID which the event belongs to | -| designViewerID | uniqueID of the design viewer | -| runID | runID | - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# passHTMLEvent + + +abstract fun [passHTMLEvent](pass-h-t-m-l-event.md)(elementID: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), designViewerID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +pass HTML event to Data Visualizer Java codes + +#### Parameters + + + +| | | +|---|---| +| elementID | HTML element ID which the event belongs to | +| designViewerID | uniqueID of the design viewer | +| runID | runID | + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/update-highlight.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/update-highlight.md index 681ebd9356..1fbbda8ed0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/update-highlight.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/update-highlight.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IRunDataAction](index.md)/[updateHighlight](update-highlight.md) - -# updateHighlight - - -abstract fun [updateHighlight](update-highlight.md)(runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), highlight: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -update highlighted design +# updateHighlight + + +abstract fun [updateHighlight](update-highlight.md)(runID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), highlight: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +update highlighted design diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/data-collector-created.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/data-collector-created.md index e7dc35214e..486daa0f2c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/data-collector-created.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/data-collector-created.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyCallback](index.md)/[dataCollectorCreated](data-collector-created.md) - -# dataCollectorCreated - - -abstract fun [dataCollectorCreated](data-collector-created.md)(tradeStudy: [TradeStudy2](../-trade-study2/index.md), dataCollector: [DataCollector](../-data-collector/index.md)) - -Called when the trade study creates a new data collector for it to use. The data collector should not be shown before being passed. - -#### Parameters - - - -| | | -|---|---| -| tradeStudy | the trade study associated with the data collector | -| dataCollector | the new data collector | +# dataCollectorCreated + + +abstract fun [dataCollectorCreated](data-collector-created.md)(tradeStudy: [TradeStudy2](../-trade-study2/index.md), dataCollector: [DataCollector](../-data-collector/index.md)) + +Called when the trade study creates a new data collector for it to use. The data collector should not be shown before being passed. + +#### Parameters + + + +| | | +|---|---| +| tradeStudy | the trade study associated with the data collector | +| dataCollector | the new data collector | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/index.md index 62d2a10e64..e48405ec03 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/index.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyCallback](index.md) - -# ITradeStudyCallback - - -interface [ITradeStudyCallback](index.md) - -This is the interface used to connect a trade study plug-in to a ModelCenter instance. - -## Functions - -| Name | Summary | -|---|---| -| [dataCollectorCreated](data-collector-created.md) | abstract fun [dataCollectorCreated](data-collector-created.md)(tradeStudy: [TradeStudy2](../-trade-study2/index.md), dataCollector: [DataCollector](../-data-collector/index.md))
Called when the trade study creates a new data collector for it to use. | -| [runEnded](run-ended.md) | abstract fun [runEnded](run-ended.md)(tradeStudy: [TradeStudy2](../-trade-study2/index.md))
Called when the trade study has completed it's run. | -| [runStarting](run-starting.md) | abstract fun [runStarting](run-starting.md)(tradeStudy: [TradeStudy2](../-trade-study2/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Called when the trade study is about to start running. | -| [tradeStudyClosed](trade-study-closed.md) | abstract fun [tradeStudyClosed](trade-study-closed.md)(tradeStudy: [TradeStudy2](../-trade-study2/index.md))
Called to signal that the trade study has closed. | +# ITradeStudyCallback + + +interface [ITradeStudyCallback](index.md) + +This is the interface used to connect a trade study plug-in to a ModelCenter instance. + +## Functions + +| Name | Summary | +|---|---| +| [dataCollectorCreated](data-collector-created.md) | abstract fun [dataCollectorCreated](data-collector-created.md)(tradeStudy: [TradeStudy2](../-trade-study2/index.md), dataCollector: [DataCollector](../-data-collector/index.md))
Called when the trade study creates a new data collector for it to use. | +| [runEnded](run-ended.md) | abstract fun [runEnded](run-ended.md)(tradeStudy: [TradeStudy2](../-trade-study2/index.md))
Called when the trade study has completed it's run. | +| [runStarting](run-starting.md) | abstract fun [runStarting](run-starting.md)(tradeStudy: [TradeStudy2](../-trade-study2/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Called when the trade study is about to start running. | +| [tradeStudyClosed](trade-study-closed.md) | abstract fun [tradeStudyClosed](trade-study-closed.md)(tradeStudy: [TradeStudy2](../-trade-study2/index.md))
Called to signal that the trade study has closed. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/run-ended.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/run-ended.md index 0f1dae1984..546fa1998d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/run-ended.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/run-ended.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyCallback](index.md)/[runEnded](run-ended.md) - -# runEnded - - -abstract fun [runEnded](run-ended.md)(tradeStudy: [TradeStudy2](../-trade-study2/index.md)) - -Called when the trade study has completed it's run. - -#### Parameters - - - -| | | -|---|---| -| tradeStudy | the trade study that has finished running | +# runEnded + + +abstract fun [runEnded](run-ended.md)(tradeStudy: [TradeStudy2](../-trade-study2/index.md)) + +Called when the trade study has completed it's run. + +#### Parameters + + + +| | | +|---|---| +| tradeStudy | the trade study that has finished running | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/run-starting.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/run-starting.md index e30218e636..2fa65fc856 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/run-starting.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/run-starting.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyCallback](index.md)/[runStarting](run-starting.md) - -# runStarting - - -abstract fun [runStarting](run-starting.md)(tradeStudy: [TradeStudy2](../-trade-study2/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Called when the trade study is about to start running. - -#### Return - -returns true if trade study is allowed to continue running otherwise false. - -#### Parameters - - - -| | | -|---|---| -| tradeStudy | the trade study asking to run. | +# runStarting + + +abstract fun [runStarting](run-starting.md)(tradeStudy: [TradeStudy2](../-trade-study2/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Called when the trade study is about to start running. + +#### Return + +returns true if trade study is allowed to continue running otherwise false. + +#### Parameters + + + +| | | +|---|---| +| tradeStudy | the trade study asking to run. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/trade-study-closed.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/trade-study-closed.md index ee0fe622ba..5903ff4f0e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/trade-study-closed.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/trade-study-closed.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyCallback](index.md)/[tradeStudyClosed](trade-study-closed.md) - -# tradeStudyClosed - - -abstract fun [tradeStudyClosed](trade-study-closed.md)(tradeStudy: [TradeStudy2](../-trade-study2/index.md)) - -Called to signal that the trade study has closed. - -#### Parameters - - - -| | | -|---|---| -| tradeStudy | the trade study that is closing | +# tradeStudyClosed + + +abstract fun [tradeStudyClosed](trade-study-closed.md)(tradeStudy: [TradeStudy2](../-trade-study2/index.md)) + +Called to signal that the trade study has closed. + +#### Parameters + + + +| | | +|---|---| +| tradeStudy | the trade study that is closing | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/construct.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/construct.md index 1123635643..f5ee25e890 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/construct.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/construct.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyPlugIn](index.md)/[construct](construct.md) - -# construct - - -abstract fun [construct](construct.md)(mc: [ModelCenter](../-model-center/index.md), atm: [AddToModel](../-add-to-model/index.md)) - -called when the plug-in is launched from ModelCenter - -#### Parameters - - - -| | | -|---|---| -| mc | the ModelCenter object | -| atm | the AddToModel API object | - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# construct + + +abstract fun [construct](construct.md)(mc: [ModelCenter](../-model-center/index.md), atm: [AddToModel](../-add-to-model/index.md)) + +called when the plug-in is launched from ModelCenter + +#### Parameters + + + +| | | +|---|---| +| mc | the ModelCenter object | +| atm | the AddToModel API object | + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/from-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/from-string.md index ba61b057c4..1d96a5628c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/from-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/from-string.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyPlugIn](index.md)/[fromString](from-string.md) - -# fromString - - -abstract fun [fromString](from-string.md)(state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Called to restore the state of a Plug-In. Should be able to restore the state from whatever string is returned by [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--). - -#### Parameters - - - -| | | -|---|---| -| state | the state string | - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# fromString + + +abstract fun [fromString](from-string.md)(state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Called to restore the state of a Plug-In. Should be able to restore the state from whatever string is returned by [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--). + +#### Parameters + + + +| | | +|---|---| +| state | the state string | + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/index.md index 07e9cc178e..24099861cd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/index.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyPlugIn](index.md) - -# ITradeStudyPlugIn - -interface [ITradeStudyPlugIn](index.md) - -This is the interface that must be implemented by all Java trade study plug-ins for ModelCenter. Please note that due to an issue in Java 8, we do not explicitly override [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) here, but you still need to implement it. - -#### Inheritors - -| | -|---| -| [ITradeStudyPlugIn2](../-i-trade-study-plug-in2/index.md) | -| [ITradeStudyPlugIn2](../-i-trade-study-plug-in2/index.md) | - -## Functions - -| Name | Summary | -|---|---| -| [construct](construct.md) | abstract fun [construct](construct.md)(mc: [ModelCenter](../-model-center/index.md), atm: [AddToModel](../-add-to-model/index.md))
called when the plug-in is launched from ModelCenter | -| [fromString](from-string.md) | abstract fun [fromString](from-string.md)(state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Called to restore the state of a Plug-In. | -| [show](show.md) | abstract fun [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
called to display the plug-in | +# ITradeStudyPlugIn + +interface [ITradeStudyPlugIn](index.md) + +This is the interface that must be implemented by all Java trade study plug-ins for ModelCenter. Please note that due to an issue in Java 8, we do not explicitly override [toString](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) here, but you still need to implement it. + +#### Inheritors + +| | +|---| +| [ITradeStudyPlugIn2](../-i-trade-study-plug-in2/index.md) | +| [ITradeStudyPlugIn2](../-i-trade-study-plug-in2/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [construct](construct.md) | abstract fun [construct](construct.md)(mc: [ModelCenter](../-model-center/index.md), atm: [AddToModel](../-add-to-model/index.md))
called when the plug-in is launched from ModelCenter | +| [fromString](from-string.md) | abstract fun [fromString](from-string.md)(state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Called to restore the state of a Plug-In. | +| [show](show.md) | abstract fun [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
called to display the plug-in | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/show.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/show.md index 14bc17d751..1eed09290e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/show.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/show.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyPlugIn](index.md)/[show](show.md) - -# show - - -abstract fun [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -called to display the plug-in - -#### Return - -false always - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# show + + +abstract fun [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +called to display the plug-in + +#### Return + +false always + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/add-analyzer-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/add-analyzer-variable.md index 977d9c374f..31268407ed 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/add-analyzer-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/add-analyzer-variable.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyPlugIn2](index.md)/[addAnalyzerVariable](add-analyzer-variable.md) - -# addAnalyzerVariable - - -abstract fun [addAnalyzerVariable](add-analyzer-variable.md)(formula: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), analyzerName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Call to add a variable from an analyzer product. If there are any analyzer variables, the plugin should only accept analyzer variables as trade study parameters. - -#### Parameters - - - -| | | -|---|---| -| formula | the formula of the variable or expression in the ModelCenter model | -| analyzerName | the name of the variable used by the analyzer product; if not specified, the formula is used instead. The plugin should only display and accept analyzer names. | +# addAnalyzerVariable + + +abstract fun [addAnalyzerVariable](add-analyzer-variable.md)(formula: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), analyzerName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Call to add a variable from an analyzer product. If there are any analyzer variables, the plugin should only accept analyzer variables as trade study parameters. + +#### Parameters + + + +| | | +|---|---| +| formula | the formula of the variable or expression in the ModelCenter model | +| analyzerName | the name of the variable used by the analyzer product; if not specified, the formula is used instead. The plugin should only display and accept analyzer names. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/clear-analyzer-variables.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/clear-analyzer-variables.md index c630ca8d15..8d4dc53b0b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/clear-analyzer-variables.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/clear-analyzer-variables.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyPlugIn2](index.md)/[clearAnalyzerVariables](clear-analyzer-variables.md) - -# clearAnalyzerVariables - - -abstract fun [clearAnalyzerVariables](clear-analyzer-variables.md)() - -Remove all analyzer variables. +# clearAnalyzerVariables + + +abstract fun [clearAnalyzerVariables](clear-analyzer-variables.md)() + +Remove all analyzer variables. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/get-save-all-analyzer-variables.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/get-save-all-analyzer-variables.md index 5c3f192ab5..861a638bfc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/get-save-all-analyzer-variables.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/get-save-all-analyzer-variables.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyPlugIn2](index.md)/[getSaveAllAnalyzerVariables](get-save-all-analyzer-variables.md) - -# getSaveAllAnalyzerVariables - - -abstract fun [getSaveAllAnalyzerVariables](get-save-all-analyzer-variables.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Gets whether all analyzer variables are saved in the data history when the trade study is run. Only affects variables added using [addAnalyzerVariable](add-analyzer-variable.md), otherwise the global ModelCenter setting is used (as per usual). The default is false. +# getSaveAllAnalyzerVariables + + +abstract fun [getSaveAllAnalyzerVariables](get-save-all-analyzer-variables.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Gets whether all analyzer variables are saved in the data history when the trade study is run. Only affects variables added using [addAnalyzerVariable](add-analyzer-variable.md), otherwise the global ModelCenter setting is used (as per usual). The default is false. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/get-trade-study-callback.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/get-trade-study-callback.md index 66e4b56b1c..03c79b1a91 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/get-trade-study-callback.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/get-trade-study-callback.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyPlugIn2](index.md)/[getTradeStudyCallback](get-trade-study-callback.md) - -# getTradeStudyCallback - - -abstract fun [getTradeStudyCallback](get-trade-study-callback.md)(): [ITradeStudyCallback](../-i-trade-study-callback/index.md) - -Gets the trade study call back object. - -#### Throws - -| | | -|---|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | if an error occurs. | +# getTradeStudyCallback + + +abstract fun [getTradeStudyCallback](get-trade-study-callback.md)(): [ITradeStudyCallback](../-i-trade-study-callback/index.md) + +Gets the trade study call back object. + +#### Throws + +| | | +|---|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | if an error occurs. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/index.md index 912b095d2a..5d5d145f57 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/index.md @@ -1,29 +1,27 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyPlugIn2](index.md) - -# ITradeStudyPlugIn2 - -interface [ITradeStudyPlugIn2](index.md) : [ITradeStudyPlugIn](../-i-trade-study-plug-in/index.md) - -This is the interface that must be implemented by all Java trade study plug-ins for ModelCenter that can be used with OEM Analyzer tools. - -#### Inheritors - -| | -|---| -| [ITradeStudyPlugIn3](../-i-trade-study-plug-in3/index.md) | -| [ITradeStudyPlugIn3](../-i-trade-study-plug-in3/index.md) | - -## Functions - -| Name | Summary | -|---|---| -| [addAnalyzerVariable](add-analyzer-variable.md) | abstract fun [addAnalyzerVariable](add-analyzer-variable.md)(formula: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), analyzerName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Call to add a variable from an analyzer product. | -| [clearAnalyzerVariables](clear-analyzer-variables.md) | abstract fun [clearAnalyzerVariables](clear-analyzer-variables.md)()
Remove all analyzer variables. | -| [construct](../-i-trade-study-plug-in/construct.md) | abstract fun [construct](../-i-trade-study-plug-in/construct.md)(mc: [ModelCenter](../-model-center/index.md), atm: [AddToModel](../-add-to-model/index.md))
called when the plug-in is launched from ModelCenter | -| [fromString](../-i-trade-study-plug-in/from-string.md) | abstract fun [fromString](../-i-trade-study-plug-in/from-string.md)(state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Called to restore the state of a Plug-In. | -| [getSaveAllAnalyzerVariables](get-save-all-analyzer-variables.md) | abstract fun [getSaveAllAnalyzerVariables](get-save-all-analyzer-variables.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether all analyzer variables are saved in the data history when the trade study is run. | -| [getTradeStudyCallback](get-trade-study-callback.md) | abstract fun [getTradeStudyCallback](get-trade-study-callback.md)(): [ITradeStudyCallback](../-i-trade-study-callback/index.md)
Gets the trade study call back object. | -| [onEnd](on-end.md) | abstract fun [onEnd](on-end.md)()
Called when the plug-in is about to be deleted. | -| [setSaveAllAnalyzerVariables](set-save-all-analyzer-variables.md) | abstract fun [setSaveAllAnalyzerVariables](set-save-all-analyzer-variables.md)(saveAll: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets whether all analyzer variables are saved in the data history when the trade study is run. | -| [setTradeStudyCallback](set-trade-study-callback.md) | abstract fun [setTradeStudyCallback](set-trade-study-callback.md)(tcb: [ITradeStudyCallback](../-i-trade-study-callback/index.md))
Sets the trade study call back object. | -| [show](../-i-trade-study-plug-in/show.md) | abstract fun [show](../-i-trade-study-plug-in/show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
called to display the plug-in | +# ITradeStudyPlugIn2 + +interface [ITradeStudyPlugIn2](index.md) : [ITradeStudyPlugIn](../-i-trade-study-plug-in/index.md) + +This is the interface that must be implemented by all Java trade study plug-ins for ModelCenter that can be used with OEM Analyzer tools. + +#### Inheritors + +| | +|---| +| [ITradeStudyPlugIn3](../-i-trade-study-plug-in3/index.md) | +| [ITradeStudyPlugIn3](../-i-trade-study-plug-in3/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [addAnalyzerVariable](add-analyzer-variable.md) | abstract fun [addAnalyzerVariable](add-analyzer-variable.md)(formula: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), analyzerName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Call to add a variable from an analyzer product. | +| [clearAnalyzerVariables](clear-analyzer-variables.md) | abstract fun [clearAnalyzerVariables](clear-analyzer-variables.md)()
Remove all analyzer variables. | +| [construct](../-i-trade-study-plug-in/construct.md) | abstract fun [construct](../-i-trade-study-plug-in/construct.md)(mc: [ModelCenter](../-model-center/index.md), atm: [AddToModel](../-add-to-model/index.md))
called when the plug-in is launched from ModelCenter | +| [fromString](../-i-trade-study-plug-in/from-string.md) | abstract fun [fromString](../-i-trade-study-plug-in/from-string.md)(state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Called to restore the state of a Plug-In. | +| [getSaveAllAnalyzerVariables](get-save-all-analyzer-variables.md) | abstract fun [getSaveAllAnalyzerVariables](get-save-all-analyzer-variables.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether all analyzer variables are saved in the data history when the trade study is run. | +| [getTradeStudyCallback](get-trade-study-callback.md) | abstract fun [getTradeStudyCallback](get-trade-study-callback.md)(): [ITradeStudyCallback](../-i-trade-study-callback/index.md)
Gets the trade study call back object. | +| [onEnd](on-end.md) | abstract fun [onEnd](on-end.md)()
Called when the plug-in is about to be deleted. | +| [setSaveAllAnalyzerVariables](set-save-all-analyzer-variables.md) | abstract fun [setSaveAllAnalyzerVariables](set-save-all-analyzer-variables.md)(saveAll: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets whether all analyzer variables are saved in the data history when the trade study is run. | +| [setTradeStudyCallback](set-trade-study-callback.md) | abstract fun [setTradeStudyCallback](set-trade-study-callback.md)(tcb: [ITradeStudyCallback](../-i-trade-study-callback/index.md))
Sets the trade study call back object. | +| [show](../-i-trade-study-plug-in/show.md) | abstract fun [show](../-i-trade-study-plug-in/show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
called to display the plug-in | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/on-end.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/on-end.md index 02165204ca..b110dc1f64 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/on-end.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/on-end.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyPlugIn2](index.md)/[onEnd](on-end.md) - -# onEnd - - -abstract fun [onEnd](on-end.md)() - -Called when the plug-in is about to be deleted. Informs the Plug-In to do any necessary clean up. - -#### Throws - -| | | -|---|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | thrown if an error occurs | +# onEnd + + +abstract fun [onEnd](on-end.md)() + +Called when the plug-in is about to be deleted. Informs the Plug-In to do any necessary clean up. + +#### Throws + +| | | +|---|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | thrown if an error occurs | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/set-save-all-analyzer-variables.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/set-save-all-analyzer-variables.md index 3713e8931c..059c02b89c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/set-save-all-analyzer-variables.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/set-save-all-analyzer-variables.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyPlugIn2](index.md)/[setSaveAllAnalyzerVariables](set-save-all-analyzer-variables.md) - -# setSaveAllAnalyzerVariables - - -abstract fun [setSaveAllAnalyzerVariables](set-save-all-analyzer-variables.md)(saveAll: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Sets whether all analyzer variables are saved in the data history when the trade study is run. Only affects variables added using [addAnalyzerVariable](add-analyzer-variable.md), otherwise the global ModelCenter setting is used (as per usual). The default is false. NOTE: not fully supported in MC 10.2 - you can (and should) set this value as appropriate but setting to true may not have an effect until all of the requisite functionality is added. +# setSaveAllAnalyzerVariables + + +abstract fun [setSaveAllAnalyzerVariables](set-save-all-analyzer-variables.md)(saveAll: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Sets whether all analyzer variables are saved in the data history when the trade study is run. Only affects variables added using [addAnalyzerVariable](add-analyzer-variable.md), otherwise the global ModelCenter setting is used (as per usual). The default is false. NOTE: not fully supported in MC 10.2 - you can (and should) set this value as appropriate but setting to true may not have an effect until all of the requisite functionality is added. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/set-trade-study-callback.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/set-trade-study-callback.md index dabbd09401..ed237ebcb6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/set-trade-study-callback.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/set-trade-study-callback.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyPlugIn2](index.md)/[setTradeStudyCallback](set-trade-study-callback.md) - -# setTradeStudyCallback - - -abstract fun [setTradeStudyCallback](set-trade-study-callback.md)(tcb: [ITradeStudyCallback](../-i-trade-study-callback/index.md)) - -Sets the trade study call back object. - -#### Parameters - - - -| | | -|---|---| -| tcb | the trade study callback | - -#### Throws - -| | | -|---|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | if an error occurs. | +# setTradeStudyCallback + + +abstract fun [setTradeStudyCallback](set-trade-study-callback.md)(tcb: [ITradeStudyCallback](../-i-trade-study-callback/index.md)) + +Sets the trade study call back object. + +#### Parameters + + + +| | | +|---|---| +| tcb | the trade study callback | + +#### Throws + +| | | +|---|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | if an error occurs. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in3/get-job-manager.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in3/get-job-manager.md index 720acf5a67..2bc54bbee7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in3/get-job-manager.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in3/get-job-manager.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyPlugIn3](index.md)/[getJobManager](get-job-manager.md) - -# getJobManager - - -abstract fun [getJobManager](get-job-manager.md)(): [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md) - -Get the job manager object; null if none. - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | on error | +# getJobManager + + +abstract fun [getJobManager](get-job-manager.md)(): [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md) + +Get the job manager object; null if none. + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | on error | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in3/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in3/index.md index 4313dbd919..d171d6e056 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in3/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in3/index.md @@ -1,29 +1,27 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyPlugIn3](index.md) - -# ITradeStudyPlugIn3 - - -interface [ITradeStudyPlugIn3](index.md) : [ITradeStudyPlugIn2](../-i-trade-study-plug-in2/index.md) - -Trade Study Plug-In 3 - -#### Author - -Dave - -## Functions - -| Name | Summary | -|---|---| -| [addAnalyzerVariable](../-i-trade-study-plug-in2/add-analyzer-variable.md) | abstract fun [addAnalyzerVariable](../-i-trade-study-plug-in2/add-analyzer-variable.md)(formula: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), analyzerName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Call to add a variable from an analyzer product. | -| [clearAnalyzerVariables](../-i-trade-study-plug-in2/clear-analyzer-variables.md) | abstract fun [clearAnalyzerVariables](../-i-trade-study-plug-in2/clear-analyzer-variables.md)()
Remove all analyzer variables. | -| [construct](../-i-trade-study-plug-in/construct.md) | abstract fun [construct](../-i-trade-study-plug-in/construct.md)(mc: [ModelCenter](../-model-center/index.md), atm: [AddToModel](../-add-to-model/index.md))
called when the plug-in is launched from ModelCenter | -| [fromString](../-i-trade-study-plug-in/from-string.md) | abstract fun [fromString](../-i-trade-study-plug-in/from-string.md)(state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Called to restore the state of a Plug-In. | -| [getJobManager](get-job-manager.md) | abstract fun [getJobManager](get-job-manager.md)(): [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md)
Get the job manager object; null if none. | -| [getSaveAllAnalyzerVariables](../-i-trade-study-plug-in2/get-save-all-analyzer-variables.md) | abstract fun [getSaveAllAnalyzerVariables](../-i-trade-study-plug-in2/get-save-all-analyzer-variables.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether all analyzer variables are saved in the data history when the trade study is run. | -| [getTradeStudyCallback](../-i-trade-study-plug-in2/get-trade-study-callback.md) | abstract fun [getTradeStudyCallback](../-i-trade-study-plug-in2/get-trade-study-callback.md)(): [ITradeStudyCallback](../-i-trade-study-callback/index.md)
Gets the trade study call back object. | -| [onEnd](../-i-trade-study-plug-in2/on-end.md) | abstract fun [onEnd](../-i-trade-study-plug-in2/on-end.md)()
Called when the plug-in is about to be deleted. | -| [setJobManager](set-job-manager.md) | abstract fun [setJobManager](set-job-manager.md)(jobManager: [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md))
Set the job manager object; null if none. | -| [setSaveAllAnalyzerVariables](../-i-trade-study-plug-in2/set-save-all-analyzer-variables.md) | abstract fun [setSaveAllAnalyzerVariables](../-i-trade-study-plug-in2/set-save-all-analyzer-variables.md)(saveAll: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets whether all analyzer variables are saved in the data history when the trade study is run. | -| [setTradeStudyCallback](../-i-trade-study-plug-in2/set-trade-study-callback.md) | abstract fun [setTradeStudyCallback](../-i-trade-study-plug-in2/set-trade-study-callback.md)(tcb: [ITradeStudyCallback](../-i-trade-study-callback/index.md))
Sets the trade study call back object. | -| [show](../-i-trade-study-plug-in/show.md) | abstract fun [show](../-i-trade-study-plug-in/show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
called to display the plug-in | +# ITradeStudyPlugIn3 + + +interface [ITradeStudyPlugIn3](index.md) : [ITradeStudyPlugIn2](../-i-trade-study-plug-in2/index.md) + +Trade Study Plug-In 3 + +#### Author + +Dave + +## Functions + +| Name | Summary | +|---|---| +| [addAnalyzerVariable](../-i-trade-study-plug-in2/add-analyzer-variable.md) | abstract fun [addAnalyzerVariable](../-i-trade-study-plug-in2/add-analyzer-variable.md)(formula: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), analyzerName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Call to add a variable from an analyzer product. | +| [clearAnalyzerVariables](../-i-trade-study-plug-in2/clear-analyzer-variables.md) | abstract fun [clearAnalyzerVariables](../-i-trade-study-plug-in2/clear-analyzer-variables.md)()
Remove all analyzer variables. | +| [construct](../-i-trade-study-plug-in/construct.md) | abstract fun [construct](../-i-trade-study-plug-in/construct.md)(mc: [ModelCenter](../-model-center/index.md), atm: [AddToModel](../-add-to-model/index.md))
called when the plug-in is launched from ModelCenter | +| [fromString](../-i-trade-study-plug-in/from-string.md) | abstract fun [fromString](../-i-trade-study-plug-in/from-string.md)(state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Called to restore the state of a Plug-In. | +| [getJobManager](get-job-manager.md) | abstract fun [getJobManager](get-job-manager.md)(): [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md)
Get the job manager object; null if none. | +| [getSaveAllAnalyzerVariables](../-i-trade-study-plug-in2/get-save-all-analyzer-variables.md) | abstract fun [getSaveAllAnalyzerVariables](../-i-trade-study-plug-in2/get-save-all-analyzer-variables.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether all analyzer variables are saved in the data history when the trade study is run. | +| [getTradeStudyCallback](../-i-trade-study-plug-in2/get-trade-study-callback.md) | abstract fun [getTradeStudyCallback](../-i-trade-study-plug-in2/get-trade-study-callback.md)(): [ITradeStudyCallback](../-i-trade-study-callback/index.md)
Gets the trade study call back object. | +| [onEnd](../-i-trade-study-plug-in2/on-end.md) | abstract fun [onEnd](../-i-trade-study-plug-in2/on-end.md)()
Called when the plug-in is about to be deleted. | +| [setJobManager](set-job-manager.md) | abstract fun [setJobManager](set-job-manager.md)(jobManager: [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md))
Set the job manager object; null if none. | +| [setSaveAllAnalyzerVariables](../-i-trade-study-plug-in2/set-save-all-analyzer-variables.md) | abstract fun [setSaveAllAnalyzerVariables](../-i-trade-study-plug-in2/set-save-all-analyzer-variables.md)(saveAll: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets whether all analyzer variables are saved in the data history when the trade study is run. | +| [setTradeStudyCallback](../-i-trade-study-plug-in2/set-trade-study-callback.md) | abstract fun [setTradeStudyCallback](../-i-trade-study-plug-in2/set-trade-study-callback.md)(tcb: [ITradeStudyCallback](../-i-trade-study-callback/index.md))
Sets the trade study call back object. | +| [show](../-i-trade-study-plug-in/show.md) | abstract fun [show](../-i-trade-study-plug-in/show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
called to display the plug-in | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in3/set-job-manager.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in3/set-job-manager.md index eb0a15b566..fd7dc5b4ed 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in3/set-job-manager.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in3/set-job-manager.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudyPlugIn3](index.md)/[setJobManager](set-job-manager.md) - -# setJobManager - - -abstract fun [setJobManager](set-job-manager.md)(jobManager: [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md)) - -Set the job manager object; null if none. - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | on error | +# setJobManager + + +abstract fun [setJobManager](set-job-manager.md)(jobManager: [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md)) + +Set the job manager object; null if none. + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | on error | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-num-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-num-runs.md index 630b7f216e..39202c86cf 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-num-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-num-runs.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobInfo](index.md)/[getNumRuns](get-num-runs.md) - -# getNumRuns - - -abstract fun [getNumRuns](get-num-runs.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -Get the number of runs. +# getNumRuns + + +abstract fun [getNumRuns](get-num-runs.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Get the number of runs. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-num-variables.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-num-variables.md index fbbb3af07d..b4591e1b7a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-num-variables.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-num-variables.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobInfo](index.md)/[getNumVariables](get-num-variables.md) - -# getNumVariables - - -abstract fun [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -Get the number of variables. +# getNumVariables + + +abstract fun [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Get the number of variables. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-variable-display-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-variable-display-name.md index beb1102232..6d71f6a0ab 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-variable-display-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-variable-display-name.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobInfo](index.md)/[getVariableDisplayName](get-variable-display-name.md) - -# getVariableDisplayName - - -abstract fun [getVariableDisplayName](get-variable-display-name.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Get the display name for the variable with the specified index. - -#### Return - -the equation - -#### Parameters - - - -| | | -|---|---| -| index | the index | - -#### Throws - -| | | -|---|---| -| [IndexOutOfBoundsException](https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html) | if the index is not valid | +# getVariableDisplayName + + +abstract fun [getVariableDisplayName](get-variable-display-name.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Get the display name for the variable with the specified index. + +#### Return + +the equation + +#### Parameters + + + +| | | +|---|---| +| index | the index | + +#### Throws + +| | | +|---|---| +| [IndexOutOfBoundsException](https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html) | if the index is not valid | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-variable-equation.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-variable-equation.md index c123855f46..ac900a4c65 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-variable-equation.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-variable-equation.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobInfo](index.md)/[getVariableEquation](get-variable-equation.md) - -# getVariableEquation - - -abstract fun [getVariableEquation](get-variable-equation.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Get the equation for the variable with the specified index. - -#### Return - -the equation - -#### Parameters - - - -| | | -|---|---| -| index | the index | - -#### Throws - -| | | -|---|---| -| [IndexOutOfBoundsException](https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html) | if the index is not valid | +# getVariableEquation + + +abstract fun [getVariableEquation](get-variable-equation.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Get the equation for the variable with the specified index. + +#### Return + +the equation + +#### Parameters + + + +| | | +|---|---| +| index | the index | + +#### Throws + +| | | +|---|---| +| [IndexOutOfBoundsException](https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html) | if the index is not valid | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/index.md index d0beb1d810..8de382e37e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/index.md @@ -1,31 +1,29 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobInfo](index.md) - -# ITradeStudy3JobInfo - -interface [ITradeStudy3JobInfo](index.md) - -Base interface for ITradeStudy3 job info and results - -#### Author - -Dave - -#### Inheritors - -| | -|---| -| [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md) | -| [ITradeStudy3JobResult](../-i-trade-study3-job-result/index.md) | -| [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md) | -| [ITradeStudy3JobResult](../-i-trade-study3-job-result/index.md) | - -## Functions - -| Name | Summary | -|---|---| -| [getNumRuns](get-num-runs.md) | abstract fun [getNumRuns](get-num-runs.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get the number of runs. | -| [getNumVariables](get-num-variables.md) | abstract fun [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get the number of variables. | -| [getVariableDisplayName](get-variable-display-name.md) | abstract fun [getVariableDisplayName](get-variable-display-name.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the display name for the variable with the specified index. | -| [getVariableEquation](get-variable-equation.md) | abstract fun [getVariableEquation](get-variable-equation.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the equation for the variable with the specified index. | -| [isDesignVariable](is-design-variable.md) | abstract fun [isDesignVariable](is-design-variable.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is the specified variable a design variable? | -| [isInput](is-input.md) | abstract fun [isInput](is-input.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is the specified variable an input? | +# ITradeStudy3JobInfo + +interface [ITradeStudy3JobInfo](index.md) + +Base interface for ITradeStudy3 job info and results + +#### Author + +Dave + +#### Inheritors + +| | +|---| +| [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md) | +| [ITradeStudy3JobResult](../-i-trade-study3-job-result/index.md) | +| [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md) | +| [ITradeStudy3JobResult](../-i-trade-study3-job-result/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [getNumRuns](get-num-runs.md) | abstract fun [getNumRuns](get-num-runs.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get the number of runs. | +| [getNumVariables](get-num-variables.md) | abstract fun [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get the number of variables. | +| [getVariableDisplayName](get-variable-display-name.md) | abstract fun [getVariableDisplayName](get-variable-display-name.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the display name for the variable with the specified index. | +| [getVariableEquation](get-variable-equation.md) | abstract fun [getVariableEquation](get-variable-equation.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the equation for the variable with the specified index. | +| [isDesignVariable](is-design-variable.md) | abstract fun [isDesignVariable](is-design-variable.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is the specified variable a design variable? | +| [isInput](is-input.md) | abstract fun [isInput](is-input.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is the specified variable an input? | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/is-design-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/is-design-variable.md index 965d766820..0e2ee6aae2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/is-design-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/is-design-variable.md @@ -1,27 +1,25 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobInfo](index.md)/[isDesignVariable](is-design-variable.md) - -# isDesignVariable - - -abstract fun [isDesignVariable](is-design-variable.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Is the specified variable a design variable? - -#### Return - -true if yes, false if no - -#### Parameters - - - -| | | -|---|---| -| which | the name or index of the variable to get | - -#### Throws - -| | | -|---|---| -| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the name is not valid | -| [IndexOutOfBoundsException](https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html) | if an index is invalid | +# isDesignVariable + + +abstract fun [isDesignVariable](is-design-variable.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Is the specified variable a design variable? + +#### Return + +true if yes, false if no + +#### Parameters + + + +| | | +|---|---| +| which | the name or index of the variable to get | + +#### Throws + +| | | +|---|---| +| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the name is not valid | +| [IndexOutOfBoundsException](https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html) | if an index is invalid | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/is-input.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/is-input.md index 3571145d21..444a11e8c6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/is-input.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/is-input.md @@ -1,27 +1,25 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobInfo](index.md)/[isInput](is-input.md) - -# isInput - - -abstract fun [isInput](is-input.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Is the specified variable an input? - -#### Return - -true if yes, false if no - -#### Parameters - - - -| | | -|---|---| -| which | the name or index of the variable to get | - -#### Throws - -| | | -|---|---| -| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the name is not valid | -| [IndexOutOfBoundsException](https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html) | if an index is invalid | +# isInput + + +abstract fun [isInput](is-input.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Is the specified variable an input? + +#### Return + +true if yes, false if no + +#### Parameters + + + +| | | +|---|---| +| which | the name or index of the variable to get | + +#### Throws + +| | | +|---|---| +| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the name is not valid | +| [IndexOutOfBoundsException](https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html) | if an index is invalid | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/add-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/add-variable.md index bf90c382e0..423593fab4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/add-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/add-variable.md @@ -1,25 +1,23 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md)/[addVariable](add-variable.md) - -# addVariable - - -abstract fun [addVariable](add-variable.md)(equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), displayName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isInput: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Add a variable. - -#### Parameters - - - -| | | -|---|---| -| equation | the equation | -| displayName | the display name | -| isInput | whether the variable is an input | - -#### Throws - -| | | -|---|---| -| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the arguments are not valid | -| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if a variable cannot be added right now | +# addVariable + + +abstract fun [addVariable](add-variable.md)(equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), displayName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isInput: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Add a variable. + +#### Parameters + + + +| | | +|---|---| +| equation | the equation | +| displayName | the display name | +| isInput | whether the variable is an input | + +#### Throws + +| | | +|---|---| +| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the arguments are not valid | +| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if a variable cannot be added right now | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/can-new-job.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/can-new-job.md index a6ff98a7cf..169e8fdcf3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/can-new-job.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/can-new-job.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md)/[canNewJob](can-new-job.md) - -# canNewJob - - -abstract fun [canNewJob](can-new-job.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Get whether a new job could be started now. - -#### Return - -whether a job can be started +# canNewJob + + +abstract fun [canNewJob](can-new-job.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Get whether a new job could be started now. + +#### Return + +whether a job can be started diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/clear.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/clear.md index 95d3a44a83..152e6e7225 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/clear.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/clear.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md)/[clear](clear.md) - -# clear - - -abstract fun [clear](clear.md)() - -Clear the job manager. Removes all variables. - -#### Throws - -| | | -|---|---| -| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if the job manager cannot currently be cleared | +# clear + + +abstract fun [clear](clear.md)() + +Clear the job manager. Removes all variables. + +#### Throws + +| | | +|---|---| +| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if the job manager cannot currently be cleared | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-data-history.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-data-history.md index f0dbdd385d..73d9e41262 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-data-history.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-data-history.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md)/[getDataHistory](get-data-history.md) - -# getDataHistory - - -abstract fun [getDataHistory](get-data-history.md)(): [DataHistory](../-data-history/index.md) - -Get the data history associated with this job manager. +# getDataHistory + + +abstract fun [getDataHistory](get-data-history.md)(): [DataHistory](../-data-history/index.md) + +Get the data history associated with this job manager. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-meta-data-provider.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-meta-data-provider.md index a5d6d4f0e2..419950255a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-meta-data-provider.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-meta-data-provider.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md)/[getMetaDataProvider](get-meta-data-provider.md) - -# getMetaDataProvider - - -abstract fun [getMetaDataProvider](get-meta-data-provider.md)(): [IVariableMetaDataProvider](../-i-variable-meta-data-provider/index.md) - -Get the variable metadata provider. - -#### Return - -the metadata provider +# getMetaDataProvider + + +abstract fun [getMetaDataProvider](get-meta-data-provider.md)(): [IVariableMetaDataProvider](../-i-variable-meta-data-provider/index.md) + +Get the variable metadata provider. + +#### Return + +the metadata provider diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-num-threads.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-num-threads.md index e17a72cd5a..09957ded37 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-num-threads.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-num-threads.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md)/[getNumThreads](get-num-threads.md) - -# getNumThreads - - -abstract fun [getNumThreads](get-num-threads.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -Get the number of threads that should be used for running in parallel; this is only a hint. - -#### Return - -the number of threads +# getNumThreads + + +abstract fun [getNumThreads](get-num-threads.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Get the number of threads that should be used for running in parallel; this is only a hint. + +#### Return + +the number of threads diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-run-in-parallel.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-run-in-parallel.md index 1d79356d32..6add09bf3d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-run-in-parallel.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-run-in-parallel.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md)/[getRunInParallel](get-run-in-parallel.md) - -# getRunInParallel - - -abstract fun [getRunInParallel](get-run-in-parallel.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Get whether runs should be in parallel; this is only a hint. - -#### Return - -whether runs should be run in parallel +# getRunInParallel + + +abstract fun [getRunInParallel](get-run-in-parallel.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Get whether runs should be in parallel; this is only a hint. + +#### Return + +whether runs should be run in parallel diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-supports-parallel-execution.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-supports-parallel-execution.md index 0fb6291ecb..37610a889d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-supports-parallel-execution.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-supports-parallel-execution.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md)/[getSupportsParallelExecution](get-supports-parallel-execution.md) - -# getSupportsParallelExecution - - -abstract fun [getSupportsParallelExecution](get-supports-parallel-execution.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Get whether this job manager supports parallel execution. If not, numThreads and runInParallel are ignored. - -#### Return - -whether parallel execution is supported +# getSupportsParallelExecution + + +abstract fun [getSupportsParallelExecution](get-supports-parallel-execution.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Get whether this job manager supports parallel execution. If not, numThreads and runInParallel are ignored. + +#### Return + +whether parallel execution is supported diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-validate-all.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-validate-all.md index 98e11700ac..d7496696e3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-validate-all.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-validate-all.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md)/[getValidateAll](get-validate-all.md) - -# getValidateAll - - -abstract fun [getValidateAll](get-validate-all.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Get whether all outputs will be validated. - -#### Return - -true if yes, false if no +# getValidateAll + + +abstract fun [getValidateAll](get-validate-all.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Get whether all outputs will be validated. + +#### Return + +true if yes, false if no diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/index.md index 86c210dfdb..1a534c5f64 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/index.md @@ -1,41 +1,39 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md) - -# ITradeStudy3JobManager - - -interface [ITradeStudy3JobManager](index.md) : [ITradeStudy3JobInfo](../-i-trade-study3-job-info/index.md) - -Job manager for ITradeStudyPlugIn3 - -#### Author - -Dave - -## Functions - -| Name | Summary | -|---|---| -| [addVariable](add-variable.md) | abstract fun [addVariable](add-variable.md)(equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), displayName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isInput: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Add a variable. | -| [canNewJob](can-new-job.md) | abstract fun [canNewJob](can-new-job.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Get whether a new job could be started now. | -| [clear](clear.md) | abstract fun [clear](clear.md)()
Clear the job manager. | -| [getDataHistory](get-data-history.md) | abstract fun [getDataHistory](get-data-history.md)(): [DataHistory](../-data-history/index.md)
Get the data history associated with this job manager. | -| [getMetaDataProvider](get-meta-data-provider.md) | abstract fun [getMetaDataProvider](get-meta-data-provider.md)(): [IVariableMetaDataProvider](../-i-variable-meta-data-provider/index.md)
Get the variable metadata provider. | -| [getNumRuns](../-i-trade-study3-job-info/get-num-runs.md) | abstract fun [getNumRuns](../-i-trade-study3-job-info/get-num-runs.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get the number of runs. | -| [getNumThreads](get-num-threads.md) | abstract fun [getNumThreads](get-num-threads.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get the number of threads that should be used for running in parallel; this is only a hint. | -| [getNumVariables](../-i-trade-study3-job-info/get-num-variables.md) | abstract fun [getNumVariables](../-i-trade-study3-job-info/get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get the number of variables. | -| [getRunInParallel](get-run-in-parallel.md) | abstract fun [getRunInParallel](get-run-in-parallel.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Get whether runs should be in parallel; this is only a hint. | -| [getSupportsParallelExecution](get-supports-parallel-execution.md) | abstract fun [getSupportsParallelExecution](get-supports-parallel-execution.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Get whether this job manager supports parallel execution. | -| [getValidateAll](get-validate-all.md) | abstract fun [getValidateAll](get-validate-all.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Get whether all outputs will be validated. | -| [getVariableDisplayName](../-i-trade-study3-job-info/get-variable-display-name.md) | abstract fun [getVariableDisplayName](../-i-trade-study3-job-info/get-variable-display-name.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the display name for the variable with the specified index. | -| [getVariableEquation](../-i-trade-study3-job-info/get-variable-equation.md) | abstract fun [getVariableEquation](../-i-trade-study3-job-info/get-variable-equation.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the equation for the variable with the specified index. | -| [isDesignVariable](../-i-trade-study3-job-info/is-design-variable.md) | abstract fun [isDesignVariable](../-i-trade-study3-job-info/is-design-variable.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is the specified variable a design variable? | -| [isInput](../-i-trade-study3-job-info/is-input.md) | abstract fun [isInput](../-i-trade-study3-job-info/is-input.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is the specified variable an input? | -| [newJob](new-job.md) | abstract fun [newJob](new-job.md)(numRuns: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Start setting up a new job. | -| [runJobAsync](run-job-async.md) | abstract fun [runJobAsync](run-job-async.md)(): [ITradeStudy3JobResult](../-i-trade-study3-job-result/index.md)
Start the job. | -| [setDataHistory](set-data-history.md) | abstract fun [setDataHistory](set-data-history.md)(dataHistory: [DataHistory](../-data-history/index.md))
Set the data history associated with this job manager. | -| [setInput](set-input.md) | abstract fun [setInput](set-input.md)(runIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
Set an input. | -| [setNumThreads](set-num-threads.md) | abstract fun [setNumThreads](set-num-threads.md)(numThreads: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Get the number of threads that should be used for running in parallel; this is only a hint. | -| [setRunInParallel](set-run-in-parallel.md) | abstract fun [setRunInParallel](set-run-in-parallel.md)(runInParallel: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether runs should be in parallel; this is only a hint. | -| [setRunInputs](set-run-inputs.md) | abstract fun [setRunInputs](set-run-inputs.md)(runIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, which: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>)
Set some/all of the inputs for a given run. | -| [setValidateAll](set-validate-all.md) | abstract fun [setValidateAll](set-validate-all.md)(validateAll: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Get whether all outputs will be validated. | -| [setVariableInputs](set-variable-inputs.md) | abstract fun [setVariableInputs](set-variable-inputs.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, runIndices: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>)
Set some/all inputs for a particular variable, across runs. | +# ITradeStudy3JobManager + + +interface [ITradeStudy3JobManager](index.md) : [ITradeStudy3JobInfo](../-i-trade-study3-job-info/index.md) + +Job manager for ITradeStudyPlugIn3 + +#### Author + +Dave + +## Functions + +| Name | Summary | +|---|---| +| [addVariable](add-variable.md) | abstract fun [addVariable](add-variable.md)(equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), displayName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isInput: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Add a variable. | +| [canNewJob](can-new-job.md) | abstract fun [canNewJob](can-new-job.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Get whether a new job could be started now. | +| [clear](clear.md) | abstract fun [clear](clear.md)()
Clear the job manager. | +| [getDataHistory](get-data-history.md) | abstract fun [getDataHistory](get-data-history.md)(): [DataHistory](../-data-history/index.md)
Get the data history associated with this job manager. | +| [getMetaDataProvider](get-meta-data-provider.md) | abstract fun [getMetaDataProvider](get-meta-data-provider.md)(): [IVariableMetaDataProvider](../-i-variable-meta-data-provider/index.md)
Get the variable metadata provider. | +| [getNumRuns](../-i-trade-study3-job-info/get-num-runs.md) | abstract fun [getNumRuns](../-i-trade-study3-job-info/get-num-runs.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get the number of runs. | +| [getNumThreads](get-num-threads.md) | abstract fun [getNumThreads](get-num-threads.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get the number of threads that should be used for running in parallel; this is only a hint. | +| [getNumVariables](../-i-trade-study3-job-info/get-num-variables.md) | abstract fun [getNumVariables](../-i-trade-study3-job-info/get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get the number of variables. | +| [getRunInParallel](get-run-in-parallel.md) | abstract fun [getRunInParallel](get-run-in-parallel.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Get whether runs should be in parallel; this is only a hint. | +| [getSupportsParallelExecution](get-supports-parallel-execution.md) | abstract fun [getSupportsParallelExecution](get-supports-parallel-execution.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Get whether this job manager supports parallel execution. | +| [getValidateAll](get-validate-all.md) | abstract fun [getValidateAll](get-validate-all.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Get whether all outputs will be validated. | +| [getVariableDisplayName](../-i-trade-study3-job-info/get-variable-display-name.md) | abstract fun [getVariableDisplayName](../-i-trade-study3-job-info/get-variable-display-name.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the display name for the variable with the specified index. | +| [getVariableEquation](../-i-trade-study3-job-info/get-variable-equation.md) | abstract fun [getVariableEquation](../-i-trade-study3-job-info/get-variable-equation.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the equation for the variable with the specified index. | +| [isDesignVariable](../-i-trade-study3-job-info/is-design-variable.md) | abstract fun [isDesignVariable](../-i-trade-study3-job-info/is-design-variable.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is the specified variable a design variable? | +| [isInput](../-i-trade-study3-job-info/is-input.md) | abstract fun [isInput](../-i-trade-study3-job-info/is-input.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is the specified variable an input? | +| [newJob](new-job.md) | abstract fun [newJob](new-job.md)(numRuns: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Start setting up a new job. | +| [runJobAsync](run-job-async.md) | abstract fun [runJobAsync](run-job-async.md)(): [ITradeStudy3JobResult](../-i-trade-study3-job-result/index.md)
Start the job. | +| [setDataHistory](set-data-history.md) | abstract fun [setDataHistory](set-data-history.md)(dataHistory: [DataHistory](../-data-history/index.md))
Set the data history associated with this job manager. | +| [setInput](set-input.md) | abstract fun [setInput](set-input.md)(runIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
Set an input. | +| [setNumThreads](set-num-threads.md) | abstract fun [setNumThreads](set-num-threads.md)(numThreads: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Get the number of threads that should be used for running in parallel; this is only a hint. | +| [setRunInParallel](set-run-in-parallel.md) | abstract fun [setRunInParallel](set-run-in-parallel.md)(runInParallel: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether runs should be in parallel; this is only a hint. | +| [setRunInputs](set-run-inputs.md) | abstract fun [setRunInputs](set-run-inputs.md)(runIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, which: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>)
Set some/all of the inputs for a given run. | +| [setValidateAll](set-validate-all.md) | abstract fun [setValidateAll](set-validate-all.md)(validateAll: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Get whether all outputs will be validated. | +| [setVariableInputs](set-variable-inputs.md) | abstract fun [setVariableInputs](set-variable-inputs.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, runIndices: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>)
Set some/all inputs for a particular variable, across runs. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/new-job.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/new-job.md index 2376e7443c..f6100ca50d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/new-job.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/new-job.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md)/[newJob](new-job.md) - -# newJob - - -abstract fun [newJob](new-job.md)(numRuns: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -Start setting up a new job. - -#### Parameters - - - -| | | -|---|---| -| numRuns | the number of runs to use | - -#### Throws - -| | | -|---|---| -| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if a new job cannot be started right now | -| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the number of runs is not valid | +# newJob + + +abstract fun [newJob](new-job.md)(numRuns: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +Start setting up a new job. + +#### Parameters + + + +| | | +|---|---| +| numRuns | the number of runs to use | + +#### Throws + +| | | +|---|---| +| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if a new job cannot be started right now | +| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the number of runs is not valid | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/run-job-async.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/run-job-async.md index e1d0f8dd68..974e24224e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/run-job-async.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/run-job-async.md @@ -1,19 +1,17 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md)/[runJobAsync](run-job-async.md) - -# runJobAsync - - -abstract fun [runJobAsync](run-job-async.md)(): [ITradeStudy3JobResult](../-i-trade-study3-job-result/index.md) - -Start the job. - -#### Return - -the job result - -#### Throws - -| | | -|---|---| -| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if the run cannot be started right now | -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | on other error | +# runJobAsync + + +abstract fun [runJobAsync](run-job-async.md)(): [ITradeStudy3JobResult](../-i-trade-study3-job-result/index.md) + +Start the job. + +#### Return + +the job result + +#### Throws + +| | | +|---|---| +| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if the run cannot be started right now | +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | on other error | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-data-history.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-data-history.md index 1a13431f6b..81f6406cf7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-data-history.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-data-history.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md)/[setDataHistory](set-data-history.md) - -# setDataHistory - - -abstract fun [setDataHistory](set-data-history.md)(dataHistory: [DataHistory](../-data-history/index.md)) - -Set the data history associated with this job manager. - -#### Parameters - - - -| | | -|---|---| -| dataHistory | the data history | - -#### Throws - -| | | -|---|---| -| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if the job manager is busy or the history cannot be set | +# setDataHistory + + +abstract fun [setDataHistory](set-data-history.md)(dataHistory: [DataHistory](../-data-history/index.md)) + +Set the data history associated with this job manager. + +#### Parameters + + + +| | | +|---|---| +| dataHistory | the data history | + +#### Throws + +| | | +|---|---| +| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if the job manager is busy or the history cannot be set | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-input.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-input.md index 53a9599880..8fcd2c988c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-input.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-input.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md)/[setInput](set-input.md) - -# setInput - - -abstract fun [setInput](set-input.md)(runIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)) - -Set an input. - -#### Parameters - - - -| | | -|---|---| -| runIndex | the run index | -| which | the variable to set (index or name) | -| value | the value to set | - -#### Throws - -| | | -|---|---| -| [IndexOutOfBoundsException](https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html) | if the indices are not valid | -| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the arguments are otherwise illegal | -| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if an input cannot be set currently | +# setInput + + +abstract fun [setInput](set-input.md)(runIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)) + +Set an input. + +#### Parameters + + + +| | | +|---|---| +| runIndex | the run index | +| which | the variable to set (index or name) | +| value | the value to set | + +#### Throws + +| | | +|---|---| +| [IndexOutOfBoundsException](https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html) | if the indices are not valid | +| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the arguments are otherwise illegal | +| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if an input cannot be set currently | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-num-threads.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-num-threads.md index b6c92f12ac..f9949d7f4b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-num-threads.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-num-threads.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md)/[setNumThreads](set-num-threads.md) - -# setNumThreads - - -abstract fun [setNumThreads](set-num-threads.md)(numThreads: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -Get the number of threads that should be used for running in parallel; this is only a hint. - -#### Parameters - - - -| | | -|---|---| -| numThreads | the number of threads | - -#### Throws - -| | | -|---|---| -| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the number of threads is invalid | -| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if the value cannot currently be set | +# setNumThreads + + +abstract fun [setNumThreads](set-num-threads.md)(numThreads: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +Get the number of threads that should be used for running in parallel; this is only a hint. + +#### Parameters + + + +| | | +|---|---| +| numThreads | the number of threads | + +#### Throws + +| | | +|---|---| +| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the number of threads is invalid | +| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if the value cannot currently be set | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-run-in-parallel.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-run-in-parallel.md index 541526f462..b69d7b70f9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-run-in-parallel.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-run-in-parallel.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md)/[setRunInParallel](set-run-in-parallel.md) - -# setRunInParallel - - -abstract fun [setRunInParallel](set-run-in-parallel.md)(runInParallel: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Set whether runs should be in parallel; this is only a hint. - -#### Parameters - - - -| | | -|---|---| -| runInParallel | whether runs should be run in parallel | - -#### Throws - -| | | -|---|---| -| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if the value cannot be set currently | +# setRunInParallel + + +abstract fun [setRunInParallel](set-run-in-parallel.md)(runInParallel: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Set whether runs should be in parallel; this is only a hint. + +#### Parameters + + + +| | | +|---|---| +| runInParallel | whether runs should be run in parallel | + +#### Throws + +| | | +|---|---| +| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if the value cannot be set currently | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-run-inputs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-run-inputs.md index 0bdbbd3ad7..a3a5fef1cc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-run-inputs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-run-inputs.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md)/[setRunInputs](set-run-inputs.md) - -# setRunInputs - - -abstract fun [setRunInputs](set-run-inputs.md)(runIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, which: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>) - -Set some/all of the inputs for a given run. - -#### Parameters - - - -| | | -|---|---| -| runIndex | the run index | -| values | the values to set | -| which | which variables to set (indices or names), null for all | - -#### Throws - -| | | -|---|---| -| [IndexOutOfBoundsException](https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html) | if the indices are not valid | -| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the arguments are otherwise illegal | -| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if an input cannot be set currently | +# setRunInputs + + +abstract fun [setRunInputs](set-run-inputs.md)(runIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, which: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>) + +Set some/all of the inputs for a given run. + +#### Parameters + + + +| | | +|---|---| +| runIndex | the run index | +| values | the values to set | +| which | which variables to set (indices or names), null for all | + +#### Throws + +| | | +|---|---| +| [IndexOutOfBoundsException](https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html) | if the indices are not valid | +| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the arguments are otherwise illegal | +| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if an input cannot be set currently | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-validate-all.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-validate-all.md index 85990db281..46e07bcfc3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-validate-all.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-validate-all.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md)/[setValidateAll](set-validate-all.md) - -# setValidateAll - - -abstract fun [setValidateAll](set-validate-all.md)(validateAll: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Get whether all outputs will be validated. - -#### Parameters - - - -| | | -|---|---| -| validateAll | whether to validate | - -#### Throws - -| | | -|---|---| -| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if the value cannot be set currently | +# setValidateAll + + +abstract fun [setValidateAll](set-validate-all.md)(validateAll: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Get whether all outputs will be validated. + +#### Parameters + + + +| | | +|---|---| +| validateAll | whether to validate | + +#### Throws + +| | | +|---|---| +| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if the value cannot be set currently | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-variable-inputs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-variable-inputs.md index 04b456f2b3..d9e4b30747 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-variable-inputs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-variable-inputs.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobManager](index.md)/[setVariableInputs](set-variable-inputs.md) - -# setVariableInputs - - -abstract fun [setVariableInputs](set-variable-inputs.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, runIndices: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>) - -Set some/all inputs for a particular variable, across runs. - -#### Parameters - - - -| | | -|---|---| -| which | the variable to set (index or name) | -| values | the values to set | -| runIndices | the indices of the runs to set values for; if null, sets all | - -#### Throws - -| | | -|---|---| -| [IndexOutOfBoundsException](https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html) | if the indices are not valid | -| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the arguments are otherwise illegal | -| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if an input cannot be set currently | +# setVariableInputs + + +abstract fun [setVariableInputs](set-variable-inputs.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>, runIndices: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>) + +Set some/all inputs for a particular variable, across runs. + +#### Parameters + + + +| | | +|---|---| +| which | the variable to set (index or name) | +| values | the values to set | +| runIndices | the indices of the runs to set values for; if null, sets all | + +#### Throws + +| | | +|---|---| +| [IndexOutOfBoundsException](https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html) | if the indices are not valid | +| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the arguments are otherwise illegal | +| [IllegalStateException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) | if an input cannot be set currently | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/cancel-async.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/cancel-async.md index b5dca1d1a6..c026f1c820 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/cancel-async.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/cancel-async.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobResult](index.md)/[cancelAsync](cancel-async.md) - -# cancelAsync - - -abstract fun [cancelAsync](cancel-async.md)() - -Cancel the operation asynchronously. +# cancelAsync + + +abstract fun [cancelAsync](cancel-async.md)() + +Cancel the operation asynchronously. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/get-data-history.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/get-data-history.md index 2a9b10d40e..947dc53928 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/get-data-history.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/get-data-history.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobResult](index.md)/[getDataHistory](get-data-history.md) - -# getDataHistory - - -abstract fun [getDataHistory](get-data-history.md)(): [DataHistory](../-data-history/index.md) - -Get the data history being used. +# getDataHistory + + +abstract fun [getDataHistory](get-data-history.md)(): [DataHistory](../-data-history/index.md) + +Get the data history being used. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/index.md index 88df93d738..28feb730bc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/index.md @@ -1,28 +1,26 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobResult](index.md) - -# ITradeStudy3JobResult - - -interface [ITradeStudy3JobResult](index.md) : [ITradeStudy3JobInfo](../-i-trade-study3-job-info/index.md) - -Result of executing a job. - -#### Author - -Dave - -## Functions - -| Name | Summary | -|---|---| -| [cancelAsync](cancel-async.md) | abstract fun [cancelAsync](cancel-async.md)()
Cancel the operation asynchronously. | -| [getDataHistory](get-data-history.md) | abstract fun [getDataHistory](get-data-history.md)(): [DataHistory](../-data-history/index.md)
Get the data history being used. | -| [getNumRuns](../-i-trade-study3-job-info/get-num-runs.md) | abstract fun [getNumRuns](../-i-trade-study3-job-info/get-num-runs.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get the number of runs. | -| [getNumVariables](../-i-trade-study3-job-info/get-num-variables.md) | abstract fun [getNumVariables](../-i-trade-study3-job-info/get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get the number of variables. | -| [getVariableDisplayName](../-i-trade-study3-job-info/get-variable-display-name.md) | abstract fun [getVariableDisplayName](../-i-trade-study3-job-info/get-variable-display-name.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the display name for the variable with the specified index. | -| [getVariableEquation](../-i-trade-study3-job-info/get-variable-equation.md) | abstract fun [getVariableEquation](../-i-trade-study3-job-info/get-variable-equation.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the equation for the variable with the specified index. | -| [isCanceled](is-canceled.md) | abstract fun [isCanceled](is-canceled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Get whether the job has been canceled. | -| [isDesignVariable](../-i-trade-study3-job-info/is-design-variable.md) | abstract fun [isDesignVariable](../-i-trade-study3-job-info/is-design-variable.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is the specified variable a design variable? | -| [isInput](../-i-trade-study3-job-info/is-input.md) | abstract fun [isInput](../-i-trade-study3-job-info/is-input.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is the specified variable an input? | -| [isRunning](is-running.md) | abstract fun [isRunning](is-running.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Get whether the job is still running. | -| [waitForCompletion](wait-for-completion.md) | abstract fun [waitForCompletion](wait-for-completion.md)()
Wait for the operation to terminate. | +# ITradeStudy3JobResult + + +interface [ITradeStudy3JobResult](index.md) : [ITradeStudy3JobInfo](../-i-trade-study3-job-info/index.md) + +Result of executing a job. + +#### Author + +Dave + +## Functions + +| Name | Summary | +|---|---| +| [cancelAsync](cancel-async.md) | abstract fun [cancelAsync](cancel-async.md)()
Cancel the operation asynchronously. | +| [getDataHistory](get-data-history.md) | abstract fun [getDataHistory](get-data-history.md)(): [DataHistory](../-data-history/index.md)
Get the data history being used. | +| [getNumRuns](../-i-trade-study3-job-info/get-num-runs.md) | abstract fun [getNumRuns](../-i-trade-study3-job-info/get-num-runs.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get the number of runs. | +| [getNumVariables](../-i-trade-study3-job-info/get-num-variables.md) | abstract fun [getNumVariables](../-i-trade-study3-job-info/get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Get the number of variables. | +| [getVariableDisplayName](../-i-trade-study3-job-info/get-variable-display-name.md) | abstract fun [getVariableDisplayName](../-i-trade-study3-job-info/get-variable-display-name.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the display name for the variable with the specified index. | +| [getVariableEquation](../-i-trade-study3-job-info/get-variable-equation.md) | abstract fun [getVariableEquation](../-i-trade-study3-job-info/get-variable-equation.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Get the equation for the variable with the specified index. | +| [isCanceled](is-canceled.md) | abstract fun [isCanceled](is-canceled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Get whether the job has been canceled. | +| [isDesignVariable](../-i-trade-study3-job-info/is-design-variable.md) | abstract fun [isDesignVariable](../-i-trade-study3-job-info/is-design-variable.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is the specified variable a design variable? | +| [isInput](../-i-trade-study3-job-info/is-input.md) | abstract fun [isInput](../-i-trade-study3-job-info/is-input.md)(which: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is the specified variable an input? | +| [isRunning](is-running.md) | abstract fun [isRunning](is-running.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Get whether the job is still running. | +| [waitForCompletion](wait-for-completion.md) | abstract fun [waitForCompletion](wait-for-completion.md)()
Wait for the operation to terminate. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/is-canceled.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/is-canceled.md index af495cc93a..cf03496f68 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/is-canceled.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/is-canceled.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobResult](index.md)/[isCanceled](is-canceled.md) - -# isCanceled - - -abstract fun [isCanceled](is-canceled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Get whether the job has been canceled. +# isCanceled + + +abstract fun [isCanceled](is-canceled.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Get whether the job has been canceled. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/is-running.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/is-running.md index 64495b98f1..4c81e624df 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/is-running.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/is-running.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobResult](index.md)/[isRunning](is-running.md) - -# isRunning - - -abstract fun [isRunning](is-running.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Get whether the job is still running. +# isRunning + + +abstract fun [isRunning](is-running.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Get whether the job is still running. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/wait-for-completion.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/wait-for-completion.md index be15a5d268..f00ec6e071 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/wait-for-completion.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/wait-for-completion.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ITradeStudy3JobResult](index.md)/[waitForCompletion](wait-for-completion.md) - -# waitForCompletion - - -abstract fun [waitForCompletion](wait-for-completion.md)() - -Wait for the operation to terminate. - -#### Throws - -| | | -|---|---| -| [InterruptedException](https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html) | if the current thread is interrupted | +# waitForCompletion + + +abstract fun [waitForCompletion](wait-for-completion.md)() + +Wait for the operation to terminate. + +#### Throws + +| | | +|---|---| +| [InterruptedException](https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html) | if the current thread is interrupted | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-group.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-group.md index 33a9c7cb5b..f838fc593d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-group.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-group.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IVariableHolder](index.md)/[getGroup](get-group.md) - -# getGroup - - -abstract fun [getGroup](get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](../-group/index.md) - -gets the specified group - -#### Return - -the specified group - -#### Parameters - - - -| | | -|---|---| -| index | the group index (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -abstract fun [getGroup](get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](../-group/index.md) - -gets the specified group - -#### Return - -the specified group - -#### Parameters - - - -| | | -|---|---| -| name | the variable name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getGroup + + +abstract fun [getGroup](get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](../-group/index.md) + +gets the specified group + +#### Return + +the specified group + +#### Parameters + + + +| | | +|---|---| +| index | the group index (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +abstract fun [getGroup](get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](../-group/index.md) + +gets the specified group + +#### Return + +the specified group + +#### Parameters + + + +| | | +|---|---| +| name | the variable name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-num-groups.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-num-groups.md index 719b7fc798..af04ca3cfc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-num-groups.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-num-groups.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IVariableHolder](index.md)/[getNumGroups](get-num-groups.md) - -# getNumGroups - - -abstract fun [getNumGroups](get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -get the number of groups stored in this object - -#### Return - -the number of stored groups - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumGroups + + +abstract fun [getNumGroups](get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +get the number of groups stored in this object + +#### Return + +the number of stored groups + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-num-variables.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-num-variables.md index e0b043b6ff..d452d1c0c2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-num-variables.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-num-variables.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IVariableHolder](index.md)/[getNumVariables](get-num-variables.md) - -# getNumVariables - - -abstract fun [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -get the number of variables stored in this object - -#### Return - -the number of stored variables - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumVariables + + +abstract fun [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +get the number of variables stored in this object + +#### Return + +the number of stored variables + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-variable.md index 67cc9bfd81..acb70de326 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-variable.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IVariableHolder](index.md)/[getVariable](get-variable.md) - -# getVariable - - -abstract fun [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md) - -gets the specified variable - -#### Return - -the specified variable - -#### Parameters - - - -| | | -|---|---| -| index | the variable index (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -abstract fun [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) - -gets the specified variable - -#### Return - -the specified variable - -#### Parameters - - - -| | | -|---|---| -| name | the variable name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getVariable + + +abstract fun [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md) + +gets the specified variable + +#### Return + +the specified variable + +#### Parameters + + + +| | | +|---|---| +| index | the variable index (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +abstract fun [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) + +gets the specified variable + +#### Return + +the specified variable + +#### Parameters + + + +| | | +|---|---| +| name | the variable name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/index.md index 007f64565b..913db4c005 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/index.md @@ -1,33 +1,31 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IVariableHolder](index.md) - -# IVariableHolder - -interface [IVariableHolder](index.md) : [IHolder](../-i-holder/index.md) - -This is an interface for ModelCenter components - -#### Author - -Woyak, 10-01 - -#### Inheritors - -| | -|---| -| [Assembly](../-assembly/index.md) | -| [Component](../-component/index.md) | -| [Group](../-group/index.md) | -| [Assembly](../-assembly/index.md) | -| [Component](../-component/index.md) | -| [Group](../-group/index.md) | - -## Functions - -| Name | Summary | -|---|---| -| [getFullName](../-i-holder/get-full-name.md) | abstract fun [getFullName](../-i-holder/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the full name of the current object, e.g. | -| [getGroup](get-group.md) | abstract fun [getGroup](get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](../-group/index.md)
abstract fun [getGroup](get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](../-group/index.md)
gets the specified group | -| [getName](../-i-holder/get-name.md) | abstract fun [getName](../-i-holder/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the current object, e.g. | -| [getNumGroups](get-num-groups.md) | abstract fun [getNumGroups](get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of groups stored in this object | -| [getNumVariables](get-num-variables.md) | abstract fun [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of variables stored in this object | -| [getVariable](get-variable.md) | abstract fun [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
abstract fun [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
gets the specified variable | +# IVariableHolder + +interface [IVariableHolder](index.md) : [IHolder](../-i-holder/index.md) + +This is an interface for ModelCenter components + +#### Author + +Woyak, 10-01 + +#### Inheritors + +| | +|---| +| [Assembly](../-assembly/index.md) | +| [Component](../-component/index.md) | +| [Group](../-group/index.md) | +| [Assembly](../-assembly/index.md) | +| [Component](../-component/index.md) | +| [Group](../-group/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [getFullName](../-i-holder/get-full-name.md) | abstract fun [getFullName](../-i-holder/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the full name of the current object, e.g. | +| [getGroup](get-group.md) | abstract fun [getGroup](get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](../-group/index.md)
abstract fun [getGroup](get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](../-group/index.md)
gets the specified group | +| [getName](../-i-holder/get-name.md) | abstract fun [getName](../-i-holder/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the current object, e.g. | +| [getNumGroups](get-num-groups.md) | abstract fun [getNumGroups](get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of groups stored in this object | +| [getNumVariables](get-num-variables.md) | abstract fun [getNumVariables](get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of variables stored in this object | +| [getVariable](get-variable.md) | abstract fun [getVariable](get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
abstract fun [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
gets the specified variable | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-meta-data-provider/get-all-variable-meta-data.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-meta-data-provider/get-all-variable-meta-data.md index 35a7688d6b..d7e54aa950 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-meta-data-provider/get-all-variable-meta-data.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-meta-data-provider/get-all-variable-meta-data.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IVariableMetaDataProvider](index.md)/[getAllVariableMetaData](get-all-variable-meta-data.md) - -# getAllVariableMetaData - - -abstract fun [getAllVariableMetaData](get-all-variable-meta-data.md)(path: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DHVariable](../-d-h-variable/index.md)> - -Get the metadata of all variables within a specified path. - -#### Return - -the variable metadatas; will be released (do not re-use) - -#### Parameters - - - -| | | -|---|---| -| path | the path to retrieve variables for | - -#### Throws - -| | | -|---|---| -| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the path does not exist | +# getAllVariableMetaData + + +abstract fun [getAllVariableMetaData](get-all-variable-meta-data.md)(path: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DHVariable](../-d-h-variable/index.md)> + +Get the metadata of all variables within a specified path. + +#### Return + +the variable metadatas; will be released (do not re-use) + +#### Parameters + + + +| | | +|---|---| +| path | the path to retrieve variables for | + +#### Throws + +| | | +|---|---| +| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the path does not exist | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-meta-data-provider/get-variable-meta-data.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-meta-data-provider/get-variable-meta-data.md index 874507bef7..fa0073aaf9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-meta-data-provider/get-variable-meta-data.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-meta-data-provider/get-variable-meta-data.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IVariableMetaDataProvider](index.md)/[getVariableMetaData](get-variable-meta-data.md) - -# getVariableMetaData - - -abstract fun [getVariableMetaData](get-variable-meta-data.md)(fullName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md) - -Get the metadata of a variable. - -#### Return - -the variable metadata; will be released (do not re-use) - -#### Parameters - - - -| | | -|---|---| -| fullName | the full name/path of the variable | - -#### Throws - -| | | -|---|---| -| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the variable does not exist | +# getVariableMetaData + + +abstract fun [getVariableMetaData](get-variable-meta-data.md)(fullName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md) + +Get the metadata of a variable. + +#### Return + +the variable metadata; will be released (do not re-use) + +#### Parameters + + + +| | | +|---|---| +| fullName | the full name/path of the variable | + +#### Throws + +| | | +|---|---| +| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if the variable does not exist | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-meta-data-provider/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-meta-data-provider/index.md index 757b21decc..4b6f50a56e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-meta-data-provider/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-i-variable-meta-data-provider/index.md @@ -1,19 +1,17 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IVariableMetaDataProvider](index.md) - -# IVariableMetaDataProvider - - -interface [IVariableMetaDataProvider](index.md) - -Base interface for ITradeStudy3 job info and results - -#### Author - -Dave - -## Functions - -| Name | Summary | -|---|---| -| [getAllVariableMetaData](get-all-variable-meta-data.md) | abstract fun [getAllVariableMetaData](get-all-variable-meta-data.md)(path: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DHVariable](../-d-h-variable/index.md)>
Get the metadata of all variables within a specified path. | -| [getVariableMetaData](get-variable-meta-data.md) | abstract fun [getVariableMetaData](get-variable-meta-data.md)(fullName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md)
Get the metadata of a variable. | +# IVariableMetaDataProvider + + +interface [IVariableMetaDataProvider](index.md) + +Base interface for ITradeStudy3 job info and results + +#### Author + +Dave + +## Functions + +| Name | Summary | +|---|---| +| [getAllVariableMetaData](get-all-variable-meta-data.md) | abstract fun [getAllVariableMetaData](get-all-variable-meta-data.md)(path: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DHVariable](../-d-h-variable/index.md)>
Get the metadata of all variables within a specified path. | +| [getVariableMetaData](get-variable-meta-data.md) | abstract fun [getVariableMetaData](get-variable-meta-data.md)(fullName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md)
Get the metadata of a variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-branch-condition.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-branch-condition.md index bf161abc69..18f6217ada 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-branch-condition.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-branch-condition.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IfComponent](index.md)/[getBranchCondition](get-branch-condition.md) - -# getBranchCondition - - -public [getBranchCondition](get-branch-condition.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the branch condition - -#### Return - -the branch condition - -#### Parameters - - - -| | | -|---|---| -| index | of the branch | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getBranchCondition + + +public [getBranchCondition](get-branch-condition.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the branch condition + +#### Return + +the branch condition + +#### Parameters + + + +| | | +|---|---| +| index | of the branch | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-branch-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-branch-name.md index 65e7897959..cf6fb90b31 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-branch-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-branch-name.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IfComponent](index.md)/[getBranchName](get-branch-name.md) - -# getBranchName - - -public [getBranchName](get-branch-name.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -returns the name of the branch - -#### Return - -name of the branch - -#### Parameters - - - -| | | -|---|---| -| index | of the branch | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getBranchName + + +public [getBranchName](get-branch-name.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +returns the name of the branch + +#### Return + +name of the branch + +#### Parameters + + + +| | | +|---|---| +| index | of the branch | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-exclusive.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-exclusive.md index a71223a40f..5b3edbe6c7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-exclusive.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-exclusive.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IfComponent](index.md)/[getExclusive](get-exclusive.md) - -# getExclusive - - -public [getExclusive](get-exclusive.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -returns the if exclusive mode - -#### Return - -is exclusive mode - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getExclusive + + +public [getExclusive](get-exclusive.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +returns the if exclusive mode + +#### Return + +is exclusive mode + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-num-branches.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-num-branches.md index c29d063224..3b1d0cfee1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-num-branches.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-num-branches.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IfComponent](index.md)/[getNumBranches](get-num-branches.md) - -# getNumBranches - - -public [getNumBranches](get-num-branches.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -gets the number of branches - -#### Return - -the number of branches - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumBranches + + +public [getNumBranches](get-num-branches.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +gets the number of branches + +#### Return + +the number of branches + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-run-last-branch-by-default.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-run-last-branch-by-default.md index dc61430aa7..b12f203180 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-run-last-branch-by-default.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/get-run-last-branch-by-default.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IfComponent](index.md)/[getRunLastBranchByDefault](get-run-last-branch-by-default.md) - -# getRunLastBranchByDefault - - -public [getRunLastBranchByDefault](get-run-last-branch-by-default.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -returns the run last branch by default flag - -#### Return - -true if the last component branch is run by default--false otherwise - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getRunLastBranchByDefault + + +public [getRunLastBranchByDefault](get-run-last-branch-by-default.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +returns the run last branch by default flag + +#### Return + +true if the last component branch is run by default--false otherwise + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/index.md index 083b9a3b21..2f784ce6eb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/index.md @@ -1,69 +1,67 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IfComponent](index.md) - -# IfComponent - - -public class [IfComponent](index.md) : [Component](../-component/index.md) - -This is the wrapper class that handles the native COM calls to an IfComponent object. - -#### Author - -jdaley, 4-09 - -## Properties - -| Name | Summary | -|---|---| -| [COMPONENT_TYPE_ASSEMBLY](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md) | val [COMPONENT_TYPE_ASSEMBLY](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Assembly" | -| [COMPONENT_TYPE_COMPONENT](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md) | val [COMPONENT_TYPE_COMPONENT](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Component" | -| [COMPONENT_TYPE_EMPTY](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md) | val [COMPONENT_TYPE_EMPTY](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Empty" | -| [COMPONENT_TYPE_FOR_EACH](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md) | val [~~COMPONENT_TYPE_FOR_EACH~~](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ForEach" | -| [COMPONENT_TYPE_IF](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md) | val [COMPONENT_TYPE_IF](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "If" | -| [COMPONENT_TYPE_LOOP](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md) | val [COMPONENT_TYPE_LOOP](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Loop" | -| [COMPONENT_TYPE_PARALLEL](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md) | val [COMPONENT_TYPE_PARALLEL](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Parallel" | -| [COMPONENT_TYPE_SCRIPTCOMPONENT](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md) | val [COMPONENT_TYPE_SCRIPTCOMPONENT](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ScriptComponent" | -| [COMPONENT_TYPE_SEQUENCE](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md) | val [COMPONENT_TYPE_SEQUENCE](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Sequence" | - -## Functions - -| Name | Summary | -|---|---| -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [downloadValues](../-component/download-values.md) | public [downloadValues](../-component/download-values.md)()
downloads the component's variable values from Analysis Server, if it's an Analysis Server component | -| [getAssociatedFiles](../-component/get-associated-files.md) | public [getAssociatedFiles](../-component/get-associated-files.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
gets the associated files of the component | -| [getBranchCondition](get-branch-condition.md) | public [getBranchCondition](get-branch-condition.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the branch condition | -| [getBranchName](get-branch-name.md) | public [getBranchName](get-branch-name.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
returns the name of the branch | -| [getExclusive](get-exclusive.md) | public [getExclusive](get-exclusive.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
returns the if exclusive mode | -| [getFullName](../-component/get-full-name.md) | public [getFullName](../-component/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the full name of the current object, e.g. | -| [getGroup](../-component/get-group.md) | public [getGroup](../-component/get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](../-group/index.md)
public [getGroup](../-component/get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](../-group/index.md)
gets the specified group | -| [getIndexInParent](../-component/get-index-in-parent.md) | public [getIndexInParent](../-component/get-index-in-parent.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the index of the component in its parent assembly. | -| [getMetadata](../-component/get-metadata.md) | public [getMetadata](../-component/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](../-component/get-name.md) | public [getName](../-component/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the current object, e.g. | -| [getNumBranches](get-num-branches.md) | public [getNumBranches](get-num-branches.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the number of branches | -| [getNumGroups](../-component/get-num-groups.md) | public [getNumGroups](../-component/get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of groups stored in this object | -| [getNumVariables](../-component/get-num-variables.md) | public [getNumVariables](../-component/get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of variables stored in this object | -| [getParentAssembly](../-component/get-parent-assembly.md) | public [getParentAssembly](../-component/get-parent-assembly.md)(): [Assembly](../-assembly/index.md)
gets the parent assembly of this component (fails if this is the model/root assembly) | -| [getPositionX](../-component/get-position-x.md) | public [getPositionX](../-component/get-position-x.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the X co-ordinate value of the current object, | -| [getPositionY](../-component/get-position-y.md) | public [getPositionY](../-component/get-position-y.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the Y co-ordinate value of the current object, | -| [getRunLastBranchByDefault](get-run-last-branch-by-default.md) | public [getRunLastBranchByDefault](get-run-last-branch-by-default.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
returns the run last branch by default flag | -| [getSource](../-component/get-source.md) | public [getSource](../-component/get-source.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the server path for the component, e.g. | -| [getType](../-component/get-type.md) | public [getType](../-component/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the type of the component: COMPONENT_TYPE_COMPONENT = "Component" COMPONENT_TYPE_SCRIPTCOMPONENT = "ScriptComponent" COMPONENT_TYPE_ASSEMBLY = "Assembly" COMPONENT_TYPE_SEQUENCE = "Sequence" COMPONENT_TYPE_IF = "If" COMPONENT_TYPE_PARALLEL = "Parallel" COMPONENT_TYPE_EMPTY = "Empty" COMPONENT_TYPE_FOR_EACH = "ForEach" | -| [getUserData](../-component/get-user-data.md) | public [getUserData](../-component/get-user-data.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Get user data of the component. | -| [getVariable](../-component/get-variable.md) | public [getVariable](../-component/get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
gets the specified variable
public [getVariable](../-component/get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
gets the specified variable. | -| [invalidate](../-component/invalidate.md) | public [invalidate](../-component/invalidate.md)()
causes the component to be invalidated | -| [invokeMethod](../-component/invoke-method.md) | public [invokeMethod](../-component/invoke-method.md)(method: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
invokes a method of the Component | -| [reconnect](../-component/reconnect.md) | public [reconnect](../-component/reconnect.md)()
reconnects the component | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [rename](../-component/rename.md) | public [rename](../-component/rename.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Rename the component | -| [renameBranch](rename-branch.md) | public [renameBranch](rename-branch.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
renames the branch to the given name | -| [run](../-component/run.md) | public [run](../-component/run.md)()
causes the component to run | -| [setAssociatedFiles](../-component/set-associated-files.md) | public [setAssociatedFiles](../-component/set-associated-files.md)(val: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>)
sets the associated files of the component | -| [setBranchCondition](set-branch-condition.md) | public [setBranchCondition](set-branch-condition.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), condition: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the branch condition | -| [setExclusive](set-exclusive.md) | public [setExclusive](set-exclusive.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the if exclusive mode | -| [setMetadata](../-component/set-metadata.md) | public [setMetadata](../-component/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a component | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setRunLastBranchByDefault](set-run-last-branch-by-default.md) | public [setRunLastBranchByDefault](set-run-last-branch-by-default.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the run last branch by default flag | -| [setUserData](../-component/set-user-data.md) | public [setUserData](../-component/set-user-data.md)(val: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
Set user data of the Component | -| [show](../-component/show.md) | public [show](../-component/show.md)()
Show the GUI form associated with the component, if any. | +# IfComponent + + +public class [IfComponent](index.md) : [Component](../-component/index.md) + +This is the wrapper class that handles the native COM calls to an IfComponent object. + +#### Author + +jdaley, 4-09 + +## Properties + +| Name | Summary | +|---|---| +| [COMPONENT_TYPE_ASSEMBLY](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md) | val [COMPONENT_TYPE_ASSEMBLY](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Assembly" | +| [COMPONENT_TYPE_COMPONENT](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md) | val [COMPONENT_TYPE_COMPONENT](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Component" | +| [COMPONENT_TYPE_EMPTY](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md) | val [COMPONENT_TYPE_EMPTY](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Empty" | +| [COMPONENT_TYPE_FOR_EACH](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md) | val [~~COMPONENT_TYPE_FOR_EACH~~](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ForEach" | +| [COMPONENT_TYPE_IF](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md) | val [COMPONENT_TYPE_IF](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "If" | +| [COMPONENT_TYPE_LOOP](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md) | val [COMPONENT_TYPE_LOOP](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Loop" | +| [COMPONENT_TYPE_PARALLEL](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md) | val [COMPONENT_TYPE_PARALLEL](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Parallel" | +| [COMPONENT_TYPE_SCRIPTCOMPONENT](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md) | val [COMPONENT_TYPE_SCRIPTCOMPONENT](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ScriptComponent" | +| [COMPONENT_TYPE_SEQUENCE](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md) | val [COMPONENT_TYPE_SEQUENCE](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Sequence" | + +## Functions + +| Name | Summary | +|---|---| +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [downloadValues](../-component/download-values.md) | public [downloadValues](../-component/download-values.md)()
downloads the component's variable values from Analysis Server, if it's an Analysis Server component | +| [getAssociatedFiles](../-component/get-associated-files.md) | public [getAssociatedFiles](../-component/get-associated-files.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
gets the associated files of the component | +| [getBranchCondition](get-branch-condition.md) | public [getBranchCondition](get-branch-condition.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the branch condition | +| [getBranchName](get-branch-name.md) | public [getBranchName](get-branch-name.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
returns the name of the branch | +| [getExclusive](get-exclusive.md) | public [getExclusive](get-exclusive.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
returns the if exclusive mode | +| [getFullName](../-component/get-full-name.md) | public [getFullName](../-component/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the full name of the current object, e.g. | +| [getGroup](../-component/get-group.md) | public [getGroup](../-component/get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](../-group/index.md)
public [getGroup](../-component/get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](../-group/index.md)
gets the specified group | +| [getIndexInParent](../-component/get-index-in-parent.md) | public [getIndexInParent](../-component/get-index-in-parent.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the index of the component in its parent assembly. | +| [getMetadata](../-component/get-metadata.md) | public [getMetadata](../-component/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](../-component/get-name.md) | public [getName](../-component/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the current object, e.g. | +| [getNumBranches](get-num-branches.md) | public [getNumBranches](get-num-branches.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the number of branches | +| [getNumGroups](../-component/get-num-groups.md) | public [getNumGroups](../-component/get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of groups stored in this object | +| [getNumVariables](../-component/get-num-variables.md) | public [getNumVariables](../-component/get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of variables stored in this object | +| [getParentAssembly](../-component/get-parent-assembly.md) | public [getParentAssembly](../-component/get-parent-assembly.md)(): [Assembly](../-assembly/index.md)
gets the parent assembly of this component (fails if this is the model/root assembly) | +| [getPositionX](../-component/get-position-x.md) | public [getPositionX](../-component/get-position-x.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the X co-ordinate value of the current object, | +| [getPositionY](../-component/get-position-y.md) | public [getPositionY](../-component/get-position-y.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the Y co-ordinate value of the current object, | +| [getRunLastBranchByDefault](get-run-last-branch-by-default.md) | public [getRunLastBranchByDefault](get-run-last-branch-by-default.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
returns the run last branch by default flag | +| [getSource](../-component/get-source.md) | public [getSource](../-component/get-source.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the server path for the component, e.g. | +| [getType](../-component/get-type.md) | public [getType](../-component/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the type of the component: COMPONENT_TYPE_COMPONENT = "Component" COMPONENT_TYPE_SCRIPTCOMPONENT = "ScriptComponent" COMPONENT_TYPE_ASSEMBLY = "Assembly" COMPONENT_TYPE_SEQUENCE = "Sequence" COMPONENT_TYPE_IF = "If" COMPONENT_TYPE_PARALLEL = "Parallel" COMPONENT_TYPE_EMPTY = "Empty" COMPONENT_TYPE_FOR_EACH = "ForEach" | +| [getUserData](../-component/get-user-data.md) | public [getUserData](../-component/get-user-data.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Get user data of the component. | +| [getVariable](../-component/get-variable.md) | public [getVariable](../-component/get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
gets the specified variable
public [getVariable](../-component/get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
gets the specified variable. | +| [invalidate](../-component/invalidate.md) | public [invalidate](../-component/invalidate.md)()
causes the component to be invalidated | +| [invokeMethod](../-component/invoke-method.md) | public [invokeMethod](../-component/invoke-method.md)(method: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
invokes a method of the Component | +| [reconnect](../-component/reconnect.md) | public [reconnect](../-component/reconnect.md)()
reconnects the component | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [rename](../-component/rename.md) | public [rename](../-component/rename.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Rename the component | +| [renameBranch](rename-branch.md) | public [renameBranch](rename-branch.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
renames the branch to the given name | +| [run](../-component/run.md) | public [run](../-component/run.md)()
causes the component to run | +| [setAssociatedFiles](../-component/set-associated-files.md) | public [setAssociatedFiles](../-component/set-associated-files.md)(val: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>)
sets the associated files of the component | +| [setBranchCondition](set-branch-condition.md) | public [setBranchCondition](set-branch-condition.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), condition: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the branch condition | +| [setExclusive](set-exclusive.md) | public [setExclusive](set-exclusive.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the if exclusive mode | +| [setMetadata](../-component/set-metadata.md) | public [setMetadata](../-component/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a component | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setRunLastBranchByDefault](set-run-last-branch-by-default.md) | public [setRunLastBranchByDefault](set-run-last-branch-by-default.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the run last branch by default flag | +| [setUserData](../-component/set-user-data.md) | public [setUserData](../-component/set-user-data.md)(val: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
Set user data of the Component | +| [show](../-component/show.md) | public [show](../-component/show.md)()
Show the GUI form associated with the component, if any. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/rename-branch.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/rename-branch.md index 4d8fdd6d18..a24d34e49a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/rename-branch.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/rename-branch.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IfComponent](index.md)/[renameBranch](rename-branch.md) - -# renameBranch - - -public [renameBranch](rename-branch.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -renames the branch to the given name - -#### Parameters - - - -| | | -|---|---| -| index | of the branch | -| name | new name for the branch | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# renameBranch + + +public [renameBranch](rename-branch.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +renames the branch to the given name + +#### Parameters + + + +| | | +|---|---| +| index | of the branch | +| name | new name for the branch | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/set-branch-condition.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/set-branch-condition.md index c271a0c550..9bea69fb5f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/set-branch-condition.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/set-branch-condition.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IfComponent](index.md)/[setBranchCondition](set-branch-condition.md) - -# setBranchCondition - - -public [setBranchCondition](set-branch-condition.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), condition: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the branch condition - -#### Parameters - - - -| | | -|---|---| -| index | of the branch | -| condition | condition | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setBranchCondition + + +public [setBranchCondition](set-branch-condition.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), condition: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the branch condition + +#### Parameters + + + +| | | +|---|---| +| index | of the branch | +| condition | condition | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/set-exclusive.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/set-exclusive.md index dd9effe711..5891cbc0da 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/set-exclusive.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/set-exclusive.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IfComponent](index.md)/[setExclusive](set-exclusive.md) - -# setExclusive - - -public [setExclusive](set-exclusive.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets the if exclusive mode - -#### Parameters - - - -| | | -|---|---| -| flag | boolean exclusive mode | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setExclusive + + +public [setExclusive](set-exclusive.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets the if exclusive mode + +#### Parameters + + + +| | | +|---|---| +| flag | boolean exclusive mode | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/set-run-last-branch-by-default.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/set-run-last-branch-by-default.md index 9f13736a68..152a3201ae 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/set-run-last-branch-by-default.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-if-component/set-run-last-branch-by-default.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IfComponent](index.md)/[setRunLastBranchByDefault](set-run-last-branch-by-default.md) - -# setRunLastBranchByDefault - - -public [setRunLastBranchByDefault](set-run-last-branch-by-default.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets the run last branch by default flag - -#### Parameters - - - -| | | -|---|---| -| flag | run last branch by default | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setRunLastBranchByDefault + + +public [setRunLastBranchByDefault](set-run-last-branch-by-default.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets the run last branch by default flag + +#### Parameters + + + +| | | +|---|---| +| flag | run last branch by default | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/clear-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/clear-lower-bound.md index 7ef1a6be6a..eec4e15997 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/clear-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/clear-lower-bound.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[clearLowerBound](clear-lower-bound.md) - -# clearLowerBound - - -public [clearLowerBound](clear-lower-bound.md)() - -clears the lower bound - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# clearLowerBound + + +public [clearLowerBound](clear-lower-bound.md)() + +clears the lower bound + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/clear-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/clear-upper-bound.md index 6271e87728..58a34514ce 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/clear-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/clear-upper-bound.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[clearUpperBound](clear-upper-bound.md) - -# clearUpperBound - - -public [clearUpperBound](clear-upper-bound.md)() - -clears the upper bound - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# clearUpperBound + + +public [clearUpperBound](clear-upper-bound.md)() + +clears the upper bound + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/from-formatted-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/from-formatted-string.md index 1476f5b302..2fcc649cad 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/from-formatted-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/from-formatted-string.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[fromFormattedString](from-formatted-string.md) - -# fromFormattedString - - -public [fromFormattedString](from-formatted-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value for the variable from a formatted string - -#### Parameters - - - -| | | -|---|---| -| value | the formatted value | -| index | the array element to set (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# fromFormattedString + + +public [fromFormattedString](from-formatted-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value for the variable from a formatted string + +#### Parameters + + + +| | | +|---|---| +| value | the formatted value | +| index | the array element to set (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-description.md index 35d6d5e7ab..f0c010045f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-description.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[getDescription](get-description.md) - -# getDescription - - -public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the description for the variable - -#### Return - -the description of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDescription + + +public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the description for the variable + +#### Return + +the description of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-enum-aliases.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-enum-aliases.md index 521095ad4f..2c0d029f18 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-enum-aliases.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-enum-aliases.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[getEnumAliases](get-enum-aliases.md) - -# getEnumAliases - - -public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the enumerated aliases for the variable - -#### Return - -a comma separated list of enumerated aliases - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEnumAliases + + +public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the enumerated aliases for the variable + +#### Return + +a comma separated list of enumerated aliases + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-enum-values.md index a348518ed0..f3b1305238 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-enum-values.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[getEnumValues](get-enum-values.md) - -# getEnumValues - - -public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the enumerated values for the variable - -#### Return - -a comma separated list of enumerated values - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEnumValues + + +public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the enumerated values for the variable + +#### Return + +a comma separated list of enumerated values + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-format.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-format.md index 31e9b67d1b..195bcb2135 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-format.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-format.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[getFormat](get-format.md) - -# getFormat - - -public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the format for the variable - -#### Return - -the format of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getFormat + + +public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the format for the variable + +#### Return + +the format of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-lower-bound.md index c683f63574..b3e31c7485 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-lower-bound.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[getLowerBound](get-lower-bound.md) - -# getLowerBound - - -public [getLowerBound](get-lower-bound.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the lower bound for the variable - -#### Return - -the lower bound of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getLowerBound + + +public [getLowerBound](get-lower-bound.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the lower bound for the variable + +#### Return + +the lower bound of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-units.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-units.md index ebd905f947..0befe9e2da 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-units.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-units.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[getUnits](get-units.md) - -# getUnits - - -public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the units for the variable - -#### Return - -the units of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getUnits + + +public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the units for the variable + +#### Return + +the units of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-upper-bound.md index b4e967cbcd..ea3b1e012b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-upper-bound.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[getUpperBound](get-upper-bound.md) - -# getUpperBound - - -public [getUpperBound](get-upper-bound.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the upper bound for the variable - -#### Return - -the upper bound of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getUpperBound + + +public [getUpperBound](get-upper-bound.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the upper bound for the variable + +#### Return + +the upper bound of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md index b29efd93cc..43dd08a465 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md @@ -1,301 +1,299 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[getValueAbsolute](get-value-absolute.md) - -# getValueAbsolute - - -public [getValueAbsolute](get-value-absolute.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| index | index in string form, i.e. [1][2][3] | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | -| d10 | index in the 10th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValueAbsolute + + +public [getValueAbsolute](get-value-absolute.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| index | index in string form, i.e. [1][2][3] | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | +| d10 | index in the 10th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md index 4806e7c408..1cccbd8073 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md @@ -1,301 +1,299 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[getValue](get-value.md) - -# getValue - - -public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| index | index in string form, i.e. [1][2][3] | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | -| d10 | index in the 10th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValue + + +public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| index | index in string form, i.e. [1][2][3] | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | +| d10 | index in the 10th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/has-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/has-lower-bound.md index 2d000f9edd..8b9d0bb2ea 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/has-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/has-lower-bound.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[hasLowerBound](has-lower-bound.md) - -# hasLowerBound - - -public [hasLowerBound](has-lower-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -indicates whether a lower bound exists or not - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# hasLowerBound + + +public [hasLowerBound](has-lower-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +indicates whether a lower bound exists or not + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/has-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/has-upper-bound.md index 6a50493208..2e270b28d8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/has-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/has-upper-bound.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[hasUpperBound](has-upper-bound.md) - -# hasUpperBound - - -public [hasUpperBound](has-upper-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -indicates whether an upper bound exists or not - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# hasUpperBound + + +public [hasUpperBound](has-upper-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +indicates whether an upper bound exists or not + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/index.md index 4a9da9dbb8..3b4b0295a7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/index.md @@ -1,78 +1,76 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md) - -# IntegerArray - - -public class [IntegerArray](index.md) : [Array](../-array/index.md) - -An array type class for ModelCenter - -#### Author - -Woyak, 9/2001 - -## Functions - -| Name | Summary | -|---|---| -| [clearLowerBound](clear-lower-bound.md) | public [clearLowerBound](clear-lower-bound.md)()
clears the lower bound | -| [clearUpperBound](clear-upper-bound.md) | public [clearUpperBound](clear-upper-bound.md)()
clears the upper bound | -| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromFormattedString](from-formatted-string.md) | public [fromFormattedString](from-formatted-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value for the variable from a formatted string | -| [fromString](../-array/from-string.md) | public [fromString](../-array/from-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value for the variable from a string
public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | -| [getAutoSize](../-array/get-auto-size.md) | public [getAutoSize](../-array/get-auto-size.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the autoSize flag. | -| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | -| [getDimensions](../-array/get-dimensions.md) | public [getDimensions](../-array/get-dimensions.md)(): [Variant](../-variant/index.md)
gets the dimensions of an array | -| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | -| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | -| [getEnumAliases](get-enum-aliases.md) | public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated aliases for the variable | -| [getEnumValues](get-enum-values.md) | public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated values for the variable | -| [getFormat](get-format.md) | public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the format for the variable | -| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | -| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | -| [getLength](../-array/get-length.md) | public [getLength](../-array/get-length.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getLength](../-array/get-length.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | -| [getLowerBound](get-lower-bound.md) | public [getLowerBound](get-lower-bound.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the lower bound for the variable | -| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | -| [getNumDimensions](../-array/get-num-dimensions.md) | public [getNumDimensions](../-array/get-num-dimensions.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of dimensions | -| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | -| [getSize](../-array/get-size.md) | public [getSize](../-array/get-size.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getSize](../-array/get-size.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | -| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | -| [getUnits](get-units.md) | public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the units for the variable | -| [getUpperBound](get-upper-bound.md) | public [getUpperBound](get-upper-bound.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the upper bound for the variable | -| [getValue](get-value.md) | public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the value of the variable at a specific location | -| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the value of the variable at a specific location without validating. | -| [hasLowerBound](has-lower-bound.md) | public [hasLowerBound](has-lower-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates whether a lower bound exists or not | -| [hasUpperBound](has-upper-bound.md) | public [hasUpperBound](has-upper-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates whether an upper bound exists or not | -| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | -| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | -| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | -| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | -| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | -| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setAutoSize](../-array/set-auto-size.md) | public [setAutoSize](../-array/set-auto-size.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the autoSize flag. | -| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | -| [setDimensions](../-array/set-dimensions.md) | public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the dimensions of the array | -| [setEnumAliases](set-enum-aliases.md) | public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated aliases for the variable. | -| [setEnumValues](set-enum-values.md) | public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated values for the variable | -| [setFormat](set-format.md) | public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the format for the variable | -| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | -| [setLength](../-array/set-length.md) | public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | -| [setLowerBound](set-lower-bound.md) | public [setLowerBound](set-lower-bound.md)(bound: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the lower bound for the variable | -| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | -| [setNumDimensions](../-array/set-num-dimensions.md) | public [setNumDimensions](../-array/set-num-dimensions.md)(num: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the number of dimensions | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setSize](../-array/set-size.md) | public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | -| [setUnits](set-units.md) | public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the units for the variable | -| [setUpperBound](set-upper-bound.md) | public [setUpperBound](set-upper-bound.md)(bound: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the upper bound for the variable | -| [setValue](set-value.md) | public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value of the variable at a specific location | -| [toFormattedString](to-formatted-string.md) | public [toFormattedString](to-formatted-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a formatted string representation. | -| [toFormattedStringAbsolute](to-formatted-string-absolute.md) | public [toFormattedStringAbsolute](to-formatted-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a formatted string representation. | -| [toString](../-array/to-string.md) | public [toString](../-array/to-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [toStringAbsolute](../-array/to-string-absolute.md) | public [toStringAbsolute](../-array/to-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | +# IntegerArray + + +public class [IntegerArray](index.md) : [Array](../-array/index.md) + +An array type class for ModelCenter + +#### Author + +Woyak, 9/2001 + +## Functions + +| Name | Summary | +|---|---| +| [clearLowerBound](clear-lower-bound.md) | public [clearLowerBound](clear-lower-bound.md)()
clears the lower bound | +| [clearUpperBound](clear-upper-bound.md) | public [clearUpperBound](clear-upper-bound.md)()
clears the upper bound | +| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromFormattedString](from-formatted-string.md) | public [fromFormattedString](from-formatted-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value for the variable from a formatted string | +| [fromString](../-array/from-string.md) | public [fromString](../-array/from-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value for the variable from a string
public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | +| [getAutoSize](../-array/get-auto-size.md) | public [getAutoSize](../-array/get-auto-size.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the autoSize flag. | +| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | +| [getDimensions](../-array/get-dimensions.md) | public [getDimensions](../-array/get-dimensions.md)(): [Variant](../-variant/index.md)
gets the dimensions of an array | +| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | +| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | +| [getEnumAliases](get-enum-aliases.md) | public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated aliases for the variable | +| [getEnumValues](get-enum-values.md) | public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated values for the variable | +| [getFormat](get-format.md) | public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the format for the variable | +| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | +| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | +| [getLength](../-array/get-length.md) | public [getLength](../-array/get-length.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getLength](../-array/get-length.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | +| [getLowerBound](get-lower-bound.md) | public [getLowerBound](get-lower-bound.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the lower bound for the variable | +| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | +| [getNumDimensions](../-array/get-num-dimensions.md) | public [getNumDimensions](../-array/get-num-dimensions.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of dimensions | +| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | +| [getSize](../-array/get-size.md) | public [getSize](../-array/get-size.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getSize](../-array/get-size.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | +| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | +| [getUnits](get-units.md) | public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the units for the variable | +| [getUpperBound](get-upper-bound.md) | public [getUpperBound](get-upper-bound.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the upper bound for the variable | +| [getValue](get-value.md) | public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the value of the variable at a specific location | +| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the value of the variable at a specific location without validating. | +| [hasLowerBound](has-lower-bound.md) | public [hasLowerBound](has-lower-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates whether a lower bound exists or not | +| [hasUpperBound](has-upper-bound.md) | public [hasUpperBound](has-upper-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates whether an upper bound exists or not | +| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | +| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | +| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | +| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | +| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | +| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setAutoSize](../-array/set-auto-size.md) | public [setAutoSize](../-array/set-auto-size.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the autoSize flag. | +| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | +| [setDimensions](../-array/set-dimensions.md) | public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the dimensions of the array | +| [setEnumAliases](set-enum-aliases.md) | public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated aliases for the variable. | +| [setEnumValues](set-enum-values.md) | public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated values for the variable | +| [setFormat](set-format.md) | public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the format for the variable | +| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | +| [setLength](../-array/set-length.md) | public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | +| [setLowerBound](set-lower-bound.md) | public [setLowerBound](set-lower-bound.md)(bound: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the lower bound for the variable | +| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | +| [setNumDimensions](../-array/set-num-dimensions.md) | public [setNumDimensions](../-array/set-num-dimensions.md)(num: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the number of dimensions | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setSize](../-array/set-size.md) | public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | +| [setUnits](set-units.md) | public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the units for the variable | +| [setUpperBound](set-upper-bound.md) | public [setUpperBound](set-upper-bound.md)(bound: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the upper bound for the variable | +| [setValue](set-value.md) | public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value of the variable at a specific location | +| [toFormattedString](to-formatted-string.md) | public [toFormattedString](to-formatted-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a formatted string representation. | +| [toFormattedStringAbsolute](to-formatted-string-absolute.md) | public [toFormattedStringAbsolute](to-formatted-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a formatted string representation. | +| [toString](../-array/to-string.md) | public [toString](../-array/to-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [toStringAbsolute](../-array/to-string-absolute.md) | public [toStringAbsolute](../-array/to-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-description.md index 02a8d7ec5a..0147b158ab 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-description.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[setDescription](set-description.md) - -# setDescription - - -public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the description for the variable - -#### Parameters - - - -| | | -|---|---| -| description | the description of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDescription + + +public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the description for the variable + +#### Parameters + + + +| | | +|---|---| +| description | the description of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-enum-aliases.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-enum-aliases.md index fb79a0abce..6539bf2c47 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-enum-aliases.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-enum-aliases.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[setEnumAliases](set-enum-aliases.md) - -# setEnumAliases - - -public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the enumerated aliases for the variable. If specified, the enumerated aliases are alias values for enumerated values. For example, if the enumerated values are set to "1,2,3", and the enumerated aliases are set to "one,two,three", then calling fromString( "three" ) will result in the value being set to 3. - -#### Parameters - - - -| | | -|---|---| -| enumAliases | a comma separated list of enumerated aliases | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setEnumAliases + + +public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the enumerated aliases for the variable. If specified, the enumerated aliases are alias values for enumerated values. For example, if the enumerated values are set to "1,2,3", and the enumerated aliases are set to "one,two,three", then calling fromString( "three" ) will result in the value being set to 3. + +#### Parameters + + + +| | | +|---|---| +| enumAliases | a comma separated list of enumerated aliases | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-enum-values.md index a21d117fc9..cd284612b6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-enum-values.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[setEnumValues](set-enum-values.md) - -# setEnumValues - - -public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the enumerated values for the variable - -#### Parameters - - - -| | | -|---|---| -| enumValues | a comma separated list of values | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setEnumValues + + +public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the enumerated values for the variable + +#### Parameters + + + +| | | +|---|---| +| enumValues | a comma separated list of values | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-format.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-format.md index 8ea65244aa..0cd6f3cda5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-format.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-format.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[setFormat](set-format.md) - -# setFormat - - -public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the format for the variable - -#### Parameters - - - -| | | -|---|---| -| format | the format of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setFormat + + +public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the format for the variable + +#### Parameters + + + +| | | +|---|---| +| format | the format of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-lower-bound.md index bfe4d4a7a2..4efd215460 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-lower-bound.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[setLowerBound](set-lower-bound.md) - -# setLowerBound - - -public [setLowerBound](set-lower-bound.md)(bound: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the lower bound for the variable - -#### Parameters - - - -| | | -|---|---| -| bound | the lower bound for the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setLowerBound + + +public [setLowerBound](set-lower-bound.md)(bound: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the lower bound for the variable + +#### Parameters + + + +| | | +|---|---| +| bound | the lower bound for the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-units.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-units.md index 0fc6693178..7a54f80014 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-units.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-units.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[setUnits](set-units.md) - -# setUnits - - -public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the units for the variable - -#### Parameters - - - -| | | -|---|---| -| units | the units of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setUnits + + +public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the units for the variable + +#### Parameters + + + +| | | +|---|---| +| units | the units of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-upper-bound.md index 14ef2f27b6..e0dbe6ec08 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-upper-bound.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[setUpperBound](set-upper-bound.md) - -# setUpperBound - - -public [setUpperBound](set-upper-bound.md)(bound: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the upper bound for the variable - -#### Parameters - - - -| | | -|---|---| -| bound | the upper bound of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setUpperBound + + +public [setUpperBound](set-upper-bound.md)(bound: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the upper bound for the variable + +#### Parameters + + + +| | | +|---|---| +| bound | the upper bound of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md index 830617caee..09625bd899 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md @@ -1,268 +1,266 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[setValue](set-value.md) - -# setValue - - -public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| index | index in string form, i.e. [1][2][3] | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | -| d10 | index in the 10th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setValue + + +public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| index | index in string form, i.e. [1][2][3] | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | +| d10 | index in the 10th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/to-formatted-string-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/to-formatted-string-absolute.md index 8602462957..4d967fea42 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/to-formatted-string-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/to-formatted-string-absolute.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[toFormattedStringAbsolute](to-formatted-string-absolute.md) - -# toFormattedStringAbsolute - - -public [toFormattedStringAbsolute](to-formatted-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -converts the variable value to a formatted string representation. If the variable is not currently valid, it is NOT validated. - -#### Return - -the string value of the formatted variable - -#### Parameters - - - -| | | -|---|---| -| index | the array element to get (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toFormattedStringAbsolute + + +public [toFormattedStringAbsolute](to-formatted-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +converts the variable value to a formatted string representation. If the variable is not currently valid, it is NOT validated. + +#### Return + +the string value of the formatted variable + +#### Parameters + + + +| | | +|---|---| +| index | the array element to get (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/to-formatted-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/to-formatted-string.md index 8596bc1232..3c8ed092a6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/to-formatted-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-array/to-formatted-string.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerArray](index.md)/[toFormattedString](to-formatted-string.md) - -# toFormattedString - - -public [toFormattedString](to-formatted-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -converts the variable value to a formatted string representation. If the variable is not currently valid, it is first validated. - -#### Return - -the string value of the formatted variable - -#### Parameters - - - -| | | -|---|---| -| index | the array element to get (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toFormattedString + + +public [toFormattedString](to-formatted-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +converts the variable value to a formatted string representation. If the variable is not currently valid, it is first validated. + +#### Return + +the string value of the formatted variable + +#### Parameters + + + +| | | +|---|---| +| index | the array element to get (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/clear-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/clear-lower-bound.md index e95a9c7e5f..eec4e15997 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/clear-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/clear-lower-bound.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[clearLowerBound](clear-lower-bound.md) - -# clearLowerBound - - -public [clearLowerBound](clear-lower-bound.md)() - -clears the lower bound - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# clearLowerBound + + +public [clearLowerBound](clear-lower-bound.md)() + +clears the lower bound + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/clear-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/clear-upper-bound.md index 7745d9dd46..58a34514ce 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/clear-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/clear-upper-bound.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[clearUpperBound](clear-upper-bound.md) - -# clearUpperBound - - -public [clearUpperBound](clear-upper-bound.md)() - -clears the upper bound - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# clearUpperBound + + +public [clearUpperBound](clear-upper-bound.md)() + +clears the upper bound + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/from-formatted-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/from-formatted-string.md index 9e37aa5cce..6720e8f0ed 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/from-formatted-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/from-formatted-string.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[fromFormattedString](from-formatted-string.md) - -# fromFormattedString - - -public [fromFormattedString](from-formatted-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the value for the variable from a formatted string - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# fromFormattedString + + +public [fromFormattedString](from-formatted-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the value for the variable from a formatted string + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-description.md index aa6d16f0ee..f0c010045f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-description.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[getDescription](get-description.md) - -# getDescription - - -public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the description for the variable - -#### Return - -the description of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDescription + + +public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the description for the variable + +#### Return + +the description of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-enum-aliases.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-enum-aliases.md index 46e1401ea3..2c0d029f18 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-enum-aliases.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-enum-aliases.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[getEnumAliases](get-enum-aliases.md) - -# getEnumAliases - - -public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the enumerated aliases for the variable - -#### Return - -a comma separated list of enumerated aliases - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEnumAliases + + +public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the enumerated aliases for the variable + +#### Return + +a comma separated list of enumerated aliases + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-enum-values.md index 4d5415b0f7..f3b1305238 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-enum-values.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[getEnumValues](get-enum-values.md) - -# getEnumValues - - -public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the enumerated values for the variable - -#### Return - -a comma separated list of enumerated values - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEnumValues + + +public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the enumerated values for the variable + +#### Return + +a comma separated list of enumerated values + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-format.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-format.md index 50942d8d66..195bcb2135 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-format.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-format.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[getFormat](get-format.md) - -# getFormat - - -public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the format for the variable - -#### Return - -the format of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getFormat + + +public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the format for the variable + +#### Return + +the format of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-lower-bound.md index 719e747c44..b3e31c7485 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-lower-bound.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[getLowerBound](get-lower-bound.md) - -# getLowerBound - - -public [getLowerBound](get-lower-bound.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the lower bound for the variable - -#### Return - -the lower bound of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getLowerBound + + +public [getLowerBound](get-lower-bound.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the lower bound for the variable + +#### Return + +the lower bound of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-units.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-units.md index 8868490344..0befe9e2da 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-units.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-units.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[getUnits](get-units.md) - -# getUnits - - -public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the units for the variable - -#### Return - -the units of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getUnits + + +public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the units for the variable + +#### Return + +the units of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-upper-bound.md index e675ffaef2..ea3b1e012b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-upper-bound.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[getUpperBound](get-upper-bound.md) - -# getUpperBound - - -public [getUpperBound](get-upper-bound.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the upper bound for the variable - -#### Return - -the upper bound of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getUpperBound + + +public [getUpperBound](get-upper-bound.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the upper bound for the variable + +#### Return + +the upper bound of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-value-absolute.md index 0c48caaddb..800c62f16c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-value-absolute.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[getValueAbsolute](get-value-absolute.md) - -# getValueAbsolute - - -public [getValueAbsolute](get-value-absolute.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable without validating it - -#### Return - -the value of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValueAbsolute + + +public [getValueAbsolute](get-value-absolute.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable without validating it + +#### Return + +the value of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-value.md index 58a5e3e596..09acbcfbf3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-value.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[getValue](get-value.md) - -# getValue - - -public [getValue](get-value.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -gets the value of the variable - -#### Return - -the value of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValue + + +public [getValue](get-value.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +gets the value of the variable + +#### Return + +the value of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/has-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/has-lower-bound.md index de56d8b79d..8b9d0bb2ea 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/has-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/has-lower-bound.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[hasLowerBound](has-lower-bound.md) - -# hasLowerBound - - -public [hasLowerBound](has-lower-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -indicates whether a lower bound exists or not - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# hasLowerBound + + +public [hasLowerBound](has-lower-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +indicates whether a lower bound exists or not + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/has-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/has-upper-bound.md index d34b2125a5..2e270b28d8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/has-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/has-upper-bound.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[hasUpperBound](has-upper-bound.md) - -# hasUpperBound - - -public [hasUpperBound](has-upper-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -indicates whether an upper bound exists or not - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# hasUpperBound + + +public [hasUpperBound](has-upper-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +indicates whether an upper bound exists or not + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/index.md index 66c8158aa9..8839e8dff5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/index.md @@ -1,68 +1,66 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md) - -# IntegerVariable - - -public class [IntegerVariable](index.md) : [Variable](../-variable/index.md) - -A variable type class for ModelCenter - -#### Author - -Woyak, 9/2001 - -## Functions - -| Name | Summary | -|---|---| -| [clearLowerBound](clear-lower-bound.md) | public [clearLowerBound](clear-lower-bound.md)()
clears the lower bound | -| [clearUpperBound](clear-upper-bound.md) | public [clearUpperBound](clear-upper-bound.md)()
clears the upper bound | -| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromFormattedString](from-formatted-string.md) | public [fromFormattedString](from-formatted-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value for the variable from a formatted string | -| [fromString](../-variable/from-string.md) | public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | -| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | -| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | -| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | -| [getEnumAliases](get-enum-aliases.md) | public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated aliases for the variable | -| [getEnumValues](get-enum-values.md) | public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated values for the variable | -| [getFormat](get-format.md) | public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the format for the variable | -| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | -| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | -| [getLowerBound](get-lower-bound.md) | public [getLowerBound](get-lower-bound.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the lower bound for the variable | -| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | -| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | -| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | -| [getUnits](get-units.md) | public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the units for the variable | -| [getUpperBound](get-upper-bound.md) | public [getUpperBound](get-upper-bound.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the upper bound for the variable | -| [getValue](get-value.md) | public [getValue](get-value.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the value of the variable | -| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the value of the variable without validating it | -| [hasLowerBound](has-lower-bound.md) | public [hasLowerBound](has-lower-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates whether a lower bound exists or not | -| [hasUpperBound](has-upper-bound.md) | public [hasUpperBound](has-upper-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates whether an upper bound exists or not | -| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | -| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | -| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | -| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | -| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | -| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | -| [setEnumAliases](set-enum-aliases.md) | public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated aliases for the variable. | -| [setEnumValues](set-enum-values.md) | public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated values for the variable | -| [setFormat](set-format.md) | public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the format for the variable | -| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | -| [setLowerBound](set-lower-bound.md) | public [setLowerBound](set-lower-bound.md)(bound: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the lower bound for the variable | -| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setUnits](set-units.md) | public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the units for the variable | -| [setUpperBound](set-upper-bound.md) | public [setUpperBound](set-upper-bound.md)(bound: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the upper bound for the variable | -| [setValue](set-value.md) | public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value of the variable | -| [toFormattedString](to-formatted-string.md) | public [toFormattedString](to-formatted-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a formatted string representation. | -| [toFormattedStringAbsolute](to-formatted-string-absolute.md) | public [toFormattedStringAbsolute](to-formatted-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a formatted string representation. | -| [toString](../-variable/to-string.md) | public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [toStringAbsolute](../-variable/to-string-absolute.md) | public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | +# IntegerVariable + + +public class [IntegerVariable](index.md) : [Variable](../-variable/index.md) + +A variable type class for ModelCenter + +#### Author + +Woyak, 9/2001 + +## Functions + +| Name | Summary | +|---|---| +| [clearLowerBound](clear-lower-bound.md) | public [clearLowerBound](clear-lower-bound.md)()
clears the lower bound | +| [clearUpperBound](clear-upper-bound.md) | public [clearUpperBound](clear-upper-bound.md)()
clears the upper bound | +| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromFormattedString](from-formatted-string.md) | public [fromFormattedString](from-formatted-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value for the variable from a formatted string | +| [fromString](../-variable/from-string.md) | public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | +| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | +| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | +| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | +| [getEnumAliases](get-enum-aliases.md) | public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated aliases for the variable | +| [getEnumValues](get-enum-values.md) | public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated values for the variable | +| [getFormat](get-format.md) | public [getFormat](get-format.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the format for the variable | +| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | +| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | +| [getLowerBound](get-lower-bound.md) | public [getLowerBound](get-lower-bound.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the lower bound for the variable | +| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | +| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | +| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | +| [getUnits](get-units.md) | public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the units for the variable | +| [getUpperBound](get-upper-bound.md) | public [getUpperBound](get-upper-bound.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the upper bound for the variable | +| [getValue](get-value.md) | public [getValue](get-value.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the value of the variable | +| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the value of the variable without validating it | +| [hasLowerBound](has-lower-bound.md) | public [hasLowerBound](has-lower-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates whether a lower bound exists or not | +| [hasUpperBound](has-upper-bound.md) | public [hasUpperBound](has-upper-bound.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates whether an upper bound exists or not | +| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | +| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | +| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | +| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | +| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | +| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | +| [setEnumAliases](set-enum-aliases.md) | public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated aliases for the variable. | +| [setEnumValues](set-enum-values.md) | public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated values for the variable | +| [setFormat](set-format.md) | public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the format for the variable | +| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | +| [setLowerBound](set-lower-bound.md) | public [setLowerBound](set-lower-bound.md)(bound: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the lower bound for the variable | +| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setUnits](set-units.md) | public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the units for the variable | +| [setUpperBound](set-upper-bound.md) | public [setUpperBound](set-upper-bound.md)(bound: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the upper bound for the variable | +| [setValue](set-value.md) | public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value of the variable | +| [toFormattedString](to-formatted-string.md) | public [toFormattedString](to-formatted-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a formatted string representation. | +| [toFormattedStringAbsolute](to-formatted-string-absolute.md) | public [toFormattedStringAbsolute](to-formatted-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a formatted string representation. | +| [toString](../-variable/to-string.md) | public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [toStringAbsolute](../-variable/to-string-absolute.md) | public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-description.md index 6b90f5901f..0147b158ab 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-description.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[setDescription](set-description.md) - -# setDescription - - -public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the description for the variable - -#### Parameters - - - -| | | -|---|---| -| description | the description of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDescription + + +public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the description for the variable + +#### Parameters + + + +| | | +|---|---| +| description | the description of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-enum-aliases.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-enum-aliases.md index 8e31af7f23..6539bf2c47 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-enum-aliases.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-enum-aliases.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[setEnumAliases](set-enum-aliases.md) - -# setEnumAliases - - -public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the enumerated aliases for the variable. If specified, the enumerated aliases are alias values for enumerated values. For example, if the enumerated values are set to "1,2,3", and the enumerated aliases are set to "one,two,three", then calling fromString( "three" ) will result in the value being set to 3. - -#### Parameters - - - -| | | -|---|---| -| enumAliases | a comma separated list of enumerated aliases | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setEnumAliases + + +public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the enumerated aliases for the variable. If specified, the enumerated aliases are alias values for enumerated values. For example, if the enumerated values are set to "1,2,3", and the enumerated aliases are set to "one,two,three", then calling fromString( "three" ) will result in the value being set to 3. + +#### Parameters + + + +| | | +|---|---| +| enumAliases | a comma separated list of enumerated aliases | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-enum-values.md index 894b6d4900..cd284612b6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-enum-values.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[setEnumValues](set-enum-values.md) - -# setEnumValues - - -public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the enumerated values for the variable - -#### Parameters - - - -| | | -|---|---| -| enumValues | a comma separated list of values | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setEnumValues + + +public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the enumerated values for the variable + +#### Parameters + + + +| | | +|---|---| +| enumValues | a comma separated list of values | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-format.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-format.md index bafd4941af..0cd6f3cda5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-format.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-format.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[setFormat](set-format.md) - -# setFormat - - -public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the format for the variable - -#### Parameters - - - -| | | -|---|---| -| format | the format of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setFormat + + +public [setFormat](set-format.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the format for the variable + +#### Parameters + + + +| | | +|---|---| +| format | the format of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-lower-bound.md index d1a5b684a2..4efd215460 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-lower-bound.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[setLowerBound](set-lower-bound.md) - -# setLowerBound - - -public [setLowerBound](set-lower-bound.md)(bound: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the lower bound for the variable - -#### Parameters - - - -| | | -|---|---| -| bound | the lower bound for the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setLowerBound + + +public [setLowerBound](set-lower-bound.md)(bound: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the lower bound for the variable + +#### Parameters + + + +| | | +|---|---| +| bound | the lower bound for the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-units.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-units.md index 26c7de3cec..7a54f80014 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-units.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-units.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[setUnits](set-units.md) - -# setUnits - - -public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the units for the variable - -#### Parameters - - - -| | | -|---|---| -| units | the units of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setUnits + + +public [setUnits](set-units.md)(units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the units for the variable + +#### Parameters + + + +| | | +|---|---| +| units | the units of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-upper-bound.md index d6cfe9be07..e0dbe6ec08 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-upper-bound.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[setUpperBound](set-upper-bound.md) - -# setUpperBound - - -public [setUpperBound](set-upper-bound.md)(bound: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the upper bound for the variable - -#### Parameters - - - -| | | -|---|---| -| bound | the upper bound of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setUpperBound + + +public [setUpperBound](set-upper-bound.md)(bound: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the upper bound for the variable + +#### Parameters + + + +| | | +|---|---| +| bound | the upper bound of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-value.md index 21e5ffe845..e36c2c660d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-value.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[setValue](set-value.md) - -# setValue - - -public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setValue + + +public [setValue](set-value.md)(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/to-formatted-string-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/to-formatted-string-absolute.md index 0943bf6fbc..3fd5739b79 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/to-formatted-string-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/to-formatted-string-absolute.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[toFormattedStringAbsolute](to-formatted-string-absolute.md) - -# toFormattedStringAbsolute - - -public [toFormattedStringAbsolute](to-formatted-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -converts the variable value to a formatted string representation. If the variable is not currently valid, it is NOT validated. - -#### Return - -the formatted string value of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toFormattedStringAbsolute + + +public [toFormattedStringAbsolute](to-formatted-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +converts the variable value to a formatted string representation. If the variable is not currently valid, it is NOT validated. + +#### Return + +the formatted string value of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/to-formatted-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/to-formatted-string.md index a3192ca999..b182641b22 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/to-formatted-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-integer-variable/to-formatted-string.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[IntegerVariable](index.md)/[toFormattedString](to-formatted-string.md) - -# toFormattedString - - -public [toFormattedString](to-formatted-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -converts the variable value to a formatted string representation. If the variable is not currently valid, it is first validated. - -#### Return - -the formatted string value of the variable - -#### Throws - -| | | -|---|---| -| [RuntimeException](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html) | thrown if an error occurs while trying to validate or retrieve the value of the variable. Note that this is a run time exception because Object.toString() cannot be overridden to throw an exception. | +# toFormattedString + + +public [toFormattedString](to-formatted-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +converts the variable value to a formatted string representation. If the variable is not currently valid, it is first validated. + +#### Return + +the formatted string value of the variable + +#### Throws + +| | | +|---|---| +| [RuntimeException](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html) | thrown if an error occurs while trying to validate or retrieve the value of the variable. Note that this is a run time exception because Object.toString() cannot be overridden to throw an exception. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/-java-object-repository.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/-java-object-repository.md index 6af7adb47d..619a64f051 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/-java-object-repository.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/-java-object-repository.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JavaObjectRepository](index.md)/[JavaObjectRepository](-java-object-repository.md) - -# JavaObjectRepository - - -constructor() +# JavaObjectRepository + + +constructor() diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/get-run-data-action.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/get-run-data-action.md index e76ab4edf9..8b45892a4b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/get-run-data-action.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/get-run-data-action.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JavaObjectRepository](index.md)/[getRunDataAction](get-run-data-action.md) - -# getRunDataAction - - -public [getRunDataAction](get-run-data-action.md)(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [IRunDataAction](../-i-run-data-action/index.md) - -Retrieves a global Java object that implements IRunDataAction Note that we assume that there is only one instance of it stored. - -#### Return - -The stored object (null if the object doesn't exist) - -#### Parameters - - - -| | | -|---|---| -| id | A unique identifier used to distinguish between objects with the same key. This is usually the unique DataHistory ID. | +# getRunDataAction + + +public [getRunDataAction](get-run-data-action.md)(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [IRunDataAction](../-i-run-data-action/index.md) + +Retrieves a global Java object that implements IRunDataAction Note that we assume that there is only one instance of it stored. + +#### Return + +The stored object (null if the object doesn't exist) + +#### Parameters + + + +| | | +|---|---| +| id | A unique identifier used to distinguish between objects with the same key. This is usually the unique DataHistory ID. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/get.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/get.md index d5114b74de..f415fd3df3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/get.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/get.md @@ -1,21 +1,19 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JavaObjectRepository](index.md)/[get](get.md) - -# get - - -public [get](get.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -Retrieves a global Java object previously stored using set() - -#### Return - -The stored object (null if the object doesn't exist) - -#### Parameters - - - -| | | -|---|---| -| key | Identifier used to identify the object | -| id | A unique identifier used to distinguish between objects with the same key. This is usually the unique DataHistory ID. | +# get + + +public [get](get.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Retrieves a global Java object previously stored using set() + +#### Return + +The stored object (null if the object doesn't exist) + +#### Parameters + + + +| | | +|---|---| +| key | Identifier used to identify the object | +| id | A unique identifier used to distinguish between objects with the same key. This is usually the unique DataHistory ID. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/index.md index dd722c6a32..488aafd130 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/index.md @@ -1,21 +1,19 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JavaObjectRepository](index.md) - -# JavaObjectRepository - - -public class [JavaObjectRepository](index.md) - -## Constructors - -| | | -|---|---| -| [JavaObjectRepository](-java-object-repository.md) | constructor() | - -## Functions - -| Name | Summary | -|---|---| -| [get](get.md) | public [get](get.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Retrieves a global Java object previously stored using set() | -| [getRunDataAction](get-run-data-action.md) | public [getRunDataAction](get-run-data-action.md)(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [IRunDataAction](../-i-run-data-action/index.md)
Retrieves a global Java object that implements IRunDataAction Note that we assume that there is only one instance of it stored. | -| [put](put.md) | public [put](put.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), obj: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Store a global Java object. | -| [release](release.md) | public [release](release.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Removes the global Java object associated with the specified ID and name | +# JavaObjectRepository + + +public class [JavaObjectRepository](index.md) + +## Constructors + +| | | +|---|---| +| [JavaObjectRepository](-java-object-repository.md) | constructor() | + +## Functions + +| Name | Summary | +|---|---| +| [get](get.md) | public [get](get.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Retrieves a global Java object previously stored using set() | +| [getRunDataAction](get-run-data-action.md) | public [getRunDataAction](get-run-data-action.md)(id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [IRunDataAction](../-i-run-data-action/index.md)
Retrieves a global Java object that implements IRunDataAction Note that we assume that there is only one instance of it stored. | +| [put](put.md) | public [put](put.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), obj: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Store a global Java object. | +| [release](release.md) | public [release](release.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Removes the global Java object associated with the specified ID and name | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/put.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/put.md index d37e814709..9f7adb4396 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/put.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/put.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JavaObjectRepository](index.md)/[put](put.md) - -# put - - -public [put](put.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), obj: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -Store a global Java object. Can be used to share an object between different Java Data Explorer Plug-Ins. - -#### Parameters - - - -| | | -|---|---| -| key | Identifier an arbitrary string used to identify the object | -| obj | The object | -| id | A unique identifier used to distinguish between objects with the same key. This is usually the unique DataHistory ID. | +# put + + +public [put](put.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), obj: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +Store a global Java object. Can be used to share an object between different Java Data Explorer Plug-Ins. + +#### Parameters + + + +| | | +|---|---| +| key | Identifier an arbitrary string used to identify the object | +| obj | The object | +| id | A unique identifier used to distinguish between objects with the same key. This is usually the unique DataHistory ID. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/release.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/release.md index 15cb1a3750..89f8221efb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/release.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/release.md @@ -1,27 +1,25 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JavaObjectRepository](index.md)/[release](release.md) - -# release - - -public [release](release.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -Removes the global Java object associated with the specified ID and name - -#### Return - -the new reference counter - -#### Parameters - - - -| | | -|---|---| -| key | Identifier used to identify the object | -| id | A unique identifier used to distinguish between objects with the same key. This is usually the unique DataHistory ID. | - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# release + + +public [release](release.md)(key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), id: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Removes the global Java object associated with the specified ID and name + +#### Return + +the new reference counter + +#### Parameters + + + +| | | +|---|---| +| key | Identifier used to identify the object | +| id | A unique identifier used to distinguish between objects with the same key. This is usually the unique DataHistory ID. | + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/add-input.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/add-input.md index 2e2c37bcd9..214a8e02d5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/add-input.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/add-input.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[addInput](add-input.md) - -# addInput - - -public [addInput](add-input.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -adds an input to the Job Table - -#### Parameters - - - -| | | -|---|---| -| name | the variable name | -| label | the label for the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addInput + + +public [addInput](add-input.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +adds an input to the Job Table + +#### Parameters + + + +| | | +|---|---| +| name | the variable name | +| label | the label for the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/add-output.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/add-output.md index c1de4f2d22..7be2bb28bf 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/add-output.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/add-output.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[addOutput](add-output.md) - -# addOutput - - -public [addOutput](add-output.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -adds an output to the Job Table - -#### Parameters - - - -| | | -|---|---| -| name | the variable name | -| label | the label for the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addOutput + + +public [addOutput](add-output.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +adds an output to the Job Table + +#### Parameters + + + +| | | +|---|---| +| name | the variable name | +| label | the label for the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/add-rerun.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/add-rerun.md index 126e16e391..88fb85b1b9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/add-rerun.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/add-rerun.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[addRerun](add-rerun.md) - -# addRerun - - -public [addRerun](add-rerun.md)(runNum: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -designates a given run already in an associated Data Collector to be rerun when submit() is called. NOTE: calling this function should not be used in tandem with addInput(), setInput(), or addOutput() calls. - -#### Parameters - - - -| | | -|---|---| -| runNum | a run in the Data Collector to rerun (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addRerun + + +public [addRerun](add-rerun.md)(runNum: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +designates a given run already in an associated Data Collector to be rerun when submit() is called. NOTE: calling this function should not be used in tandem with addInput(), setInput(), or addOutput() calls. + +#### Parameters + + + +| | | +|---|---| +| runNum | a run in the Data Collector to rerun (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/clear-cache.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/clear-cache.md index f52232a548..64fe1e81fa 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/clear-cache.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/clear-cache.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[clearCache](clear-cache.md) - -# clearCache - - -public [clearCache](clear-cache.md)() - -Clears cache structures - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# clearCache + + +public [clearCache](clear-cache.md)() + +Clears cache structures + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/enable-cache.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/enable-cache.md index fc23ec1c5f..a025a0c4ae 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/enable-cache.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/enable-cache.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[enableCache](enable-cache.md) - -# enableCache - - -public [enableCache](enable-cache.md)(enable: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Enables or disables cache completely. Cache is cleared when disabled and cannot be reused when enabled again. - -#### Return - -were we previously reading from the cache? - -#### Parameters - - - -| | | -|---|---| -| enable | indicates if cache should be enabled or disabled | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# enableCache + + +public [enableCache](enable-cache.md)(enable: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Enables or disables cache completely. Cache is cleared when disabled and cannot be reused when enabled again. + +#### Return + +were we previously reading from the cache? + +#### Parameters + + + +| | | +|---|---| +| enable | indicates if cache should be enabled or disabled | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-input-label.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-input-label.md index 17faa3c444..df58cafeca 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-input-label.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-input-label.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[getInputLabel](get-input-label.md) - -# getInputLabel - - -public [getInputLabel](get-input-label.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the name of an input variable - -#### Return - -the name of the variable - -#### Parameters - - - -| | | -|---|---| -| index | the variable index | +# getInputLabel + + +public [getInputLabel](get-input-label.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the name of an input variable + +#### Return + +the name of the variable + +#### Parameters + + + +| | | +|---|---| +| index | the variable index | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-input.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-input.md index 33305486be..bfc56877c7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-input.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-input.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[getInput](get-input.md) - -# getInput - - -public [getInput](get-input.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the name of an input variable - -#### Return - -the name of the variable - -#### Parameters - - - -| | | -|---|---| -| index | the variable index | +# getInput + + +public [getInput](get-input.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the name of an input variable + +#### Return + +the name of the variable + +#### Parameters + + + +| | | +|---|---| +| index | the variable index | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-inputs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-inputs.md index 83618213ce..52f19bbb1c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-inputs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-inputs.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[getNumInputs](get-num-inputs.md) - -# getNumInputs - - -public [getNumInputs](get-num-inputs.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -gets the number of input variables - -#### Return - -the number of input variables +# getNumInputs + + +public [getNumInputs](get-num-inputs.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +gets the number of input variables + +#### Return + +the number of input variables diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-outputs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-outputs.md index 80e7c7956d..656ba9ad07 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-outputs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-outputs.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[getNumOutputs](get-num-outputs.md) - -# getNumOutputs - - -public [getNumOutputs](get-num-outputs.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -gets the number of output variables - -#### Return - -the number of output variables +# getNumOutputs + + +public [getNumOutputs](get-num-outputs.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +gets the number of output variables + +#### Return + +the number of output variables diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-runs.md index ef252873b3..4c45c54f89 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-runs.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[getNumRuns](get-num-runs.md) - -# getNumRuns - - -public [getNumRuns](get-num-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -get number of runs - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumRuns + + +public [getNumRuns](get-num-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +get number of runs + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-threads.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-threads.md index e189c87d50..d16135a806 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-threads.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-threads.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[getNumThreads](get-num-threads.md) - -# getNumThreads - - -public [getNumThreads](get-num-threads.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -Gets the number of threads to be used when processing a job in parallel - -#### Return - -the number of threads to use +# getNumThreads + + +public [getNumThreads](get-num-threads.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Gets the number of threads to be used when processing a job in parallel + +#### Return + +the number of threads to use diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-output-label.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-output-label.md index ac1cf5b5c3..41f2c9dcf5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-output-label.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-output-label.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[getOutputLabel](get-output-label.md) - -# getOutputLabel - - -public [getOutputLabel](get-output-label.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the name of an input variable - -#### Return - -the name of the variable - -#### Parameters - - - -| | | -|---|---| -| index | the variable index | +# getOutputLabel + + +public [getOutputLabel](get-output-label.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the name of an input variable + +#### Return + +the name of the variable + +#### Parameters + + + +| | | +|---|---| +| index | the variable index | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-output.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-output.md index 4885be2898..7a43cf5136 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-output.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-output.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[getOutput](get-output.md) - -# getOutput - - -public [getOutput](get-output.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the name of an output variable - -#### Return - -the name of the variable - -#### Parameters - - - -| | | -|---|---| -| index | the variable index | +# getOutput + + +public [getOutput](get-output.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the name of an output variable + +#### Return + +the name of the variable + +#### Parameters + + + +| | | +|---|---| +| index | the variable index | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-run-in-parallel.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-run-in-parallel.md index b665c4380a..08629c9152 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-run-in-parallel.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-run-in-parallel.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[getRunInParallel](get-run-in-parallel.md) - -# getRunInParallel - - -public [getRunInParallel](get-run-in-parallel.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Determines whether or not the jobs are to be ran in parallel - -#### Return - -true if the jobs are to be ran in parallel, false otherwise +# getRunInParallel + + +public [getRunInParallel](get-run-in-parallel.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Determines whether or not the jobs are to be ran in parallel + +#### Return + +true if the jobs are to be ran in parallel, false otherwise diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-run-index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-run-index.md index cdf8ea0c70..cf0df357fb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-run-index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-run-index.md @@ -1,27 +1,25 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[getRunIndex](get-run-index.md) - -# getRunIndex - - -public [getRunIndex](get-run-index.md)(names: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -Returns Data Explorer Run Index for the given design from the cache (Only works if cache is enabled.) - -#### Return - -index of design in design explorer if design found else -1 - -#### Parameters - - - -| | | -|---|---| -| names | design variable names | -| values | design values corresponding to names | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getRunIndex + + +public [getRunIndex](get-run-index.md)(names: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Returns Data Explorer Run Index for the given design from the cache (Only works if cache is enabled.) + +#### Return + +index of design in design explorer if design found else -1 + +#### Parameters + + + +| | | +|---|---| +| names | design variable names | +| values | design values corresponding to names | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-validate-all.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-validate-all.md index faef0a1d67..ba206a896e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-validate-all.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-validate-all.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[getValidateAll](get-validate-all.md) - -# getValidateAll - - -public [getValidateAll](get-validate-all.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -return the validate all flag - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValidateAll + + +public [getValidateAll](get-validate-all.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +return the validate all flag + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/halt.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/halt.md index 7ce2579518..36926086ec 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/halt.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/halt.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[halt](halt.md) - -# halt - - -public [halt](halt.md)(halt: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -halts the trade study - -#### Parameters - - - -| | | -|---|---| -| halt | do we halt? | +# halt + + +public [halt](halt.md)(halt: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +halts the trade study + +#### Parameters + + + +| | | +|---|---| +| halt | do we halt? | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/index.md index b5ae5f7027..cd9611ff2b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/index.md @@ -1,47 +1,45 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md) - -# JobManager - - -public class [JobManager](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -This is the wrapper class that handles the native COM calls to a JobManager object. The class is used by Java plug-ins to ModelCenter. - -#### Author - -Woyak, 9-01 - -## Functions - -| Name | Summary | -|---|---| -| [addInput](add-input.md) | public [addInput](add-input.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
adds an input to the Job Table | -| [addOutput](add-output.md) | public [addOutput](add-output.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
adds an output to the Job Table | -| [addRerun](add-rerun.md) | public [addRerun](add-rerun.md)(runNum: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
designates a given run already in an associated Data Collector to be rerun when submit() is called. | -| [clearCache](clear-cache.md) | public [clearCache](clear-cache.md)()
Clears cache structures | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [enableCache](enable-cache.md) | public [enableCache](enable-cache.md)(enable: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Enables or disables cache completely. | -| [getInput](get-input.md) | public [getInput](get-input.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of an input variable | -| [getInputLabel](get-input-label.md) | public [getInputLabel](get-input-label.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of an input variable | -| [getNumInputs](get-num-inputs.md) | public [getNumInputs](get-num-inputs.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the number of input variables | -| [getNumOutputs](get-num-outputs.md) | public [getNumOutputs](get-num-outputs.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the number of output variables | -| [getNumRuns](get-num-runs.md) | public [getNumRuns](get-num-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
get number of runs | -| [getNumThreads](get-num-threads.md) | public [getNumThreads](get-num-threads.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the number of threads to be used when processing a job in parallel | -| [getOutput](get-output.md) | public [getOutput](get-output.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of an output variable | -| [getOutputLabel](get-output-label.md) | public [getOutputLabel](get-output-label.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of an input variable | -| [getRunIndex](get-run-index.md) | public [getRunIndex](get-run-index.md)(names: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns Data Explorer Run Index for the given design from the cache (Only works if cache is enabled. | -| [getRunInParallel](get-run-in-parallel.md) | public [getRunInParallel](get-run-in-parallel.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determines whether or not the jobs are to be ran in parallel | -| [getValidateAll](get-validate-all.md) | public [getValidateAll](get-validate-all.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
return the validate all flag | -| [halt](halt.md) | public [halt](halt.md)(halt: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
halts the trade study | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [resume](resume.md) | public [resume](resume.md)(dh: [DataHistory](../-data-history/index.md))
Pick up from the last checkpoint in a data history. | -| [setCustomMetadata](set-custom-metadata.md) | public [setCustomMetadata](set-custom-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Add custom metadata to a variable. | -| [setInput](set-input.md) | public [setInput](set-input.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets a given input to a given value for a given run | -| [setNumRuns](set-num-runs.md) | public [setNumRuns](set-num-runs.md)(numRuns: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
get number of runs | -| [setNumThreads](set-num-threads.md) | public [setNumThreads](set-num-threads.md)(numThreads: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Sets the number of threads to be used when processing a job in parallel | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setRunInParallel](set-run-in-parallel.md) | public [setRunInParallel](set-run-in-parallel.md)(runInParallel: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Tells the job manager whether or not to run the jobs in parallel | -| [setValidateAll](set-validate-all.md) | public [setValidateAll](set-validate-all.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
set the validate all flag | -| [submit](submit.md) | public [submit](submit.md)(dc: [DataCollector](../-data-collector/index.md))
public [submit](submit.md)(dc: [DataCollector](../-data-collector/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [submit](submit.md)(dc: [DataCollector](../-data-collector/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fireAndForget: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
start solving the defined table of runs
public [submit](submit.md)(de: [DataExplorer](../-data-explorer/index.md))
public [submit](submit.md)(dh: [DataHistory](../-data-history/index.md))
public [submit](submit.md)(de: [DataExplorer](../-data-explorer/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [submit](submit.md)(dh: [DataHistory](../-data-history/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [submit](submit.md)(de: [DataExplorer](../-data-explorer/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fireAndForget: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
public [submit](submit.md)(dh: [DataHistory](../-data-history/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fireAndForget: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
start solving the defined table of runs. | -| [waitForJobCompletion](wait-for-job-completion.md) | public [waitForJobCompletion](wait-for-job-completion.md)()
wait for the current job to complete before continuing | +# JobManager + + +public class [JobManager](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +This is the wrapper class that handles the native COM calls to a JobManager object. The class is used by Java plug-ins to ModelCenter. + +#### Author + +Woyak, 9-01 + +## Functions + +| Name | Summary | +|---|---| +| [addInput](add-input.md) | public [addInput](add-input.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
adds an input to the Job Table | +| [addOutput](add-output.md) | public [addOutput](add-output.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), label: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
adds an output to the Job Table | +| [addRerun](add-rerun.md) | public [addRerun](add-rerun.md)(runNum: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
designates a given run already in an associated Data Collector to be rerun when submit() is called. | +| [clearCache](clear-cache.md) | public [clearCache](clear-cache.md)()
Clears cache structures | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [enableCache](enable-cache.md) | public [enableCache](enable-cache.md)(enable: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Enables or disables cache completely. | +| [getInput](get-input.md) | public [getInput](get-input.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of an input variable | +| [getInputLabel](get-input-label.md) | public [getInputLabel](get-input-label.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of an input variable | +| [getNumInputs](get-num-inputs.md) | public [getNumInputs](get-num-inputs.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the number of input variables | +| [getNumOutputs](get-num-outputs.md) | public [getNumOutputs](get-num-outputs.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the number of output variables | +| [getNumRuns](get-num-runs.md) | public [getNumRuns](get-num-runs.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
get number of runs | +| [getNumThreads](get-num-threads.md) | public [getNumThreads](get-num-threads.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the number of threads to be used when processing a job in parallel | +| [getOutput](get-output.md) | public [getOutput](get-output.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of an output variable | +| [getOutputLabel](get-output-label.md) | public [getOutputLabel](get-output-label.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of an input variable | +| [getRunIndex](get-run-index.md) | public [getRunIndex](get-run-index.md)(names: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, values: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Returns Data Explorer Run Index for the given design from the cache (Only works if cache is enabled. | +| [getRunInParallel](get-run-in-parallel.md) | public [getRunInParallel](get-run-in-parallel.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determines whether or not the jobs are to be ran in parallel | +| [getValidateAll](get-validate-all.md) | public [getValidateAll](get-validate-all.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
return the validate all flag | +| [halt](halt.md) | public [halt](halt.md)(halt: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
halts the trade study | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [resume](resume.md) | public [resume](resume.md)(dh: [DataHistory](../-data-history/index.md))
Pick up from the last checkpoint in a data history. | +| [setCustomMetadata](set-custom-metadata.md) | public [setCustomMetadata](set-custom-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Add custom metadata to a variable. | +| [setInput](set-input.md) | public [setInput](set-input.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets a given input to a given value for a given run | +| [setNumRuns](set-num-runs.md) | public [setNumRuns](set-num-runs.md)(numRuns: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
get number of runs | +| [setNumThreads](set-num-threads.md) | public [setNumThreads](set-num-threads.md)(numThreads: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Sets the number of threads to be used when processing a job in parallel | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setRunInParallel](set-run-in-parallel.md) | public [setRunInParallel](set-run-in-parallel.md)(runInParallel: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Tells the job manager whether or not to run the jobs in parallel | +| [setValidateAll](set-validate-all.md) | public [setValidateAll](set-validate-all.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
set the validate all flag | +| [submit](submit.md) | public [submit](submit.md)(dc: [DataCollector](../-data-collector/index.md))
public [submit](submit.md)(dc: [DataCollector](../-data-collector/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [submit](submit.md)(dc: [DataCollector](../-data-collector/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fireAndForget: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
start solving the defined table of runs
public [submit](submit.md)(de: [DataExplorer](../-data-explorer/index.md))
public [submit](submit.md)(dh: [DataHistory](../-data-history/index.md))
public [submit](submit.md)(de: [DataExplorer](../-data-explorer/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [submit](submit.md)(dh: [DataHistory](../-data-history/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [submit](submit.md)(de: [DataExplorer](../-data-explorer/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fireAndForget: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
public [submit](submit.md)(dh: [DataHistory](../-data-history/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fireAndForget: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
start solving the defined table of runs. | +| [waitForJobCompletion](wait-for-job-completion.md) | public [waitForJobCompletion](wait-for-job-completion.md)()
wait for the current job to complete before continuing | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/resume.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/resume.md index 51711538fd..03129eb968 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/resume.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/resume.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[resume](resume.md) - -# resume - - -public [resume](resume.md)(dh: [DataHistory](../-data-history/index.md)) - -Pick up from the last checkpoint in a data history. If you subsequently pass a data collector, data explorer, or data history to submit(), you should be sure to pass one with the same data history or all restored runs will be lost. - -#### Parameters - - - -| | | -|---|---| -| dh | the Data History to restore from; if null uses the current data history; if non-null this becomes the current data history; you may pass a data explorer or data collector instead | +# resume + + +public [resume](resume.md)(dh: [DataHistory](../-data-history/index.md)) + +Pick up from the last checkpoint in a data history. If you subsequently pass a data collector, data explorer, or data history to submit(), you should be sure to pass one with the same data history or all restored runs will be lost. + +#### Parameters + + + +| | | +|---|---| +| dh | the Data History to restore from; if null uses the current data history; if non-null this becomes the current data history; you may pass a data explorer or data collector instead | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-custom-metadata.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-custom-metadata.md index 1bb9224cd1..1848af3e3d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-custom-metadata.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-custom-metadata.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[setCustomMetadata](set-custom-metadata.md) - -# setCustomMetadata - - -public [setCustomMetadata](set-custom-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Add custom metadata to a variable. - -#### Parameters - - - -| | | -|---|---| -| name | variable name. | -| key | the key of the metadata to add | -| value | the value of the metadata to add. | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setCustomMetadata + + +public [setCustomMetadata](set-custom-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), key: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Add custom metadata to a variable. + +#### Parameters + + + +| | | +|---|---| +| name | variable name. | +| key | the key of the metadata to add | +| value | the value of the metadata to add. | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-input.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-input.md index 2201ededfa..ea01ab3cea 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-input.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-input.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[setInput](set-input.md) - -# setInput - - -public [setInput](set-input.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets a given input to a given value for a given run - -#### Parameters - - - -| | | -|---|---| -| run | the run number (0-based index) | -| name | the variable name | -| value | the value for the specified variable to run for this specified run. | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setInput + + +public [setInput](set-input.md)(run: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets a given input to a given value for a given run + +#### Parameters + + + +| | | +|---|---| +| run | the run number (0-based index) | +| name | the variable name | +| value | the value for the specified variable to run for this specified run. | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-num-runs.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-num-runs.md index 637a120442..60437f6673 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-num-runs.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-num-runs.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[setNumRuns](set-num-runs.md) - -# setNumRuns - - -public [setNumRuns](set-num-runs.md)(numRuns: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -get number of runs - -#### Parameters - - - -| | | -|---|---| -| numRuns | number of runs | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setNumRuns + + +public [setNumRuns](set-num-runs.md)(numRuns: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +get number of runs + +#### Parameters + + + +| | | +|---|---| +| numRuns | number of runs | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-num-threads.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-num-threads.md index 6a674998df..8810317faf 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-num-threads.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-num-threads.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[setNumThreads](set-num-threads.md) - -# setNumThreads - - -public [setNumThreads](set-num-threads.md)(numThreads: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -Sets the number of threads to be used when processing a job in parallel - -#### Parameters - - - -| | | -|---|---| -| numThreads | the number of threads to be used | +# setNumThreads + + +public [setNumThreads](set-num-threads.md)(numThreads: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +Sets the number of threads to be used when processing a job in parallel + +#### Parameters + + + +| | | +|---|---| +| numThreads | the number of threads to be used | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-run-in-parallel.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-run-in-parallel.md index c8ae52ffb5..3e0e73c6a6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-run-in-parallel.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-run-in-parallel.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[setRunInParallel](set-run-in-parallel.md) - -# setRunInParallel - - -public [setRunInParallel](set-run-in-parallel.md)(runInParallel: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Tells the job manager whether or not to run the jobs in parallel - -#### Parameters - - - -| | | -|---|---| -| runInParallel | true if the jobs are to be ran in parallel, false otherwise | +# setRunInParallel + + +public [setRunInParallel](set-run-in-parallel.md)(runInParallel: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Tells the job manager whether or not to run the jobs in parallel + +#### Parameters + + + +| | | +|---|---| +| runInParallel | true if the jobs are to be ran in parallel, false otherwise | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-validate-all.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-validate-all.md index 33c6d6ccc5..697e387844 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-validate-all.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-validate-all.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[setValidateAll](set-validate-all.md) - -# setValidateAll - - -public [setValidateAll](set-validate-all.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -set the validate all flag - -#### Parameters - - - -| | | -|---|---| -| flag | value | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setValidateAll + + +public [setValidateAll](set-validate-all.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +set the validate all flag + +#### Parameters + + + +| | | +|---|---| +| flag | value | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md index 495c0aaaa2..f905bb3c48 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md @@ -1,183 +1,181 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[submit](submit.md) - -# submit - - -public [submit](submit.md)(dc: [DataCollector](../-data-collector/index.md)) - -start solving the defined table of runs - -#### Parameters - - - -| | | -|---|---| -| dc | the Data Explorer used to display the results | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [submit](submit.md)(dc: [DataCollector](../-data-collector/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -start solving the defined table of runs - -#### Parameters - - - -| | | -|---|---| -| dc | the Data Explorer used to display the results | -| description | the type of trade study to be run | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [submit](submit.md)(dc: [DataCollector](../-data-collector/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fireAndForget: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -start solving the defined table of runs - -#### Parameters - - - -| | | -|---|---| -| dc | the Data Explorer used to display the results | -| description | the type of trade study to be run | -| fireAndForget | flag for whether fire-n-forget is enabled | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [submit](submit.md)(dh: [DataHistory](../-data-history/index.md)) - -start solving the defined table of runs. - -#### Parameters - - - -| | | -|---|---| -| dh | Data history to display the results | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [submit](submit.md)(dh: [DataHistory](../-data-history/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -start solving the defined table of runs. - -#### Parameters - - - -| | | -|---|---| -| dh | Data history to display the results | -| description | the type of trade study to be run | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [submit](submit.md)(dh: [DataHistory](../-data-history/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fireAndForget: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -start solving the defined table of runs. - -#### Parameters - - - -| | | -|---|---| -| dh | Data history to display the results | -| description | the type of trade study to be run | -| fireAndForget | flag for whether fire-n-forget is enabled | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [submit](submit.md)(de: [DataExplorer](../-data-explorer/index.md)) - -start solving the defined table of runs. - -#### Parameters - - - -| | | -|---|---| -| de | DataExplorer to display the results | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [submit](submit.md)(de: [DataExplorer](../-data-explorer/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -start solving the defined table of runs. - -#### Parameters - - - -| | | -|---|---| -| de | DataExplorer to display the results | -| description | the type of trade study to be run | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [submit](submit.md)(de: [DataExplorer](../-data-explorer/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fireAndForget: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -start solving the defined table of runs. - -#### Parameters - - - -| | | -|---|---| -| de | DataExplorer to display the results | -| description | the type of trade study to be run | -| fireAndForget | flag for whether fire-n-forget is enabled | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# submit + + +public [submit](submit.md)(dc: [DataCollector](../-data-collector/index.md)) + +start solving the defined table of runs + +#### Parameters + + + +| | | +|---|---| +| dc | the Data Explorer used to display the results | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [submit](submit.md)(dc: [DataCollector](../-data-collector/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +start solving the defined table of runs + +#### Parameters + + + +| | | +|---|---| +| dc | the Data Explorer used to display the results | +| description | the type of trade study to be run | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [submit](submit.md)(dc: [DataCollector](../-data-collector/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fireAndForget: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +start solving the defined table of runs + +#### Parameters + + + +| | | +|---|---| +| dc | the Data Explorer used to display the results | +| description | the type of trade study to be run | +| fireAndForget | flag for whether fire-n-forget is enabled | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [submit](submit.md)(dh: [DataHistory](../-data-history/index.md)) + +start solving the defined table of runs. + +#### Parameters + + + +| | | +|---|---| +| dh | Data history to display the results | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [submit](submit.md)(dh: [DataHistory](../-data-history/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +start solving the defined table of runs. + +#### Parameters + + + +| | | +|---|---| +| dh | Data history to display the results | +| description | the type of trade study to be run | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [submit](submit.md)(dh: [DataHistory](../-data-history/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fireAndForget: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +start solving the defined table of runs. + +#### Parameters + + + +| | | +|---|---| +| dh | Data history to display the results | +| description | the type of trade study to be run | +| fireAndForget | flag for whether fire-n-forget is enabled | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [submit](submit.md)(de: [DataExplorer](../-data-explorer/index.md)) + +start solving the defined table of runs. + +#### Parameters + + + +| | | +|---|---| +| de | DataExplorer to display the results | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [submit](submit.md)(de: [DataExplorer](../-data-explorer/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +start solving the defined table of runs. + +#### Parameters + + + +| | | +|---|---| +| de | DataExplorer to display the results | +| description | the type of trade study to be run | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [submit](submit.md)(de: [DataExplorer](../-data-explorer/index.md), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fireAndForget: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +start solving the defined table of runs. + +#### Parameters + + + +| | | +|---|---| +| de | DataExplorer to display the results | +| description | the type of trade study to be run | +| fireAndForget | flag for whether fire-n-forget is enabled | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/wait-for-job-completion.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/wait-for-job-completion.md index 83db93966e..16fb6eac26 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/wait-for-job-completion.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-job-manager/wait-for-job-completion.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[JobManager](index.md)/[waitForJobCompletion](wait-for-job-completion.md) - -# waitForJobCompletion - - -public [waitForJobCompletion](wait-for-job-completion.md)() - -wait for the current job to complete before continuing - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# waitForJobCompletion + + +public [waitForJobCompletion](wait-for-job-completion.md)() + +wait for the current job to complete before continuing + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center-exception/-model-center-exception.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center-exception/-model-center-exception.md index fdea828df7..3d6227c7ad 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center-exception/-model-center-exception.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center-exception/-model-center-exception.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenterException](index.md)/[ModelCenterException](-model-center-exception.md) - -# ModelCenterException - - -constructor() - -constructor(s: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -constructor(cause: [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html)) - -constructor(s: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), cause: [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html)) +# ModelCenterException + + +constructor() + +constructor(s: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +constructor(cause: [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html)) + +constructor(s: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), cause: [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center-exception/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center-exception/index.md index f07fc2f6d6..1259a12916 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center-exception/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center-exception/index.md @@ -1,43 +1,41 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenterException](index.md) - -# ModelCenterException - -public class [ModelCenterException](index.md) : [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) - -This class wraps exceptions thrown by the ModelCenter native methods. - -#### Author - -Haisma, 2/2000 - -#### See also - -| | -|---| -| [ModelCenter](../-model-center/index.md) | - -## Constructors - -| | | -|---|---| -| [ModelCenterException](-model-center-exception.md) | constructor()constructor(s: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))constructor(cause: [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html))constructor(s: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), cause: [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html)) | - -## Properties - -| Name | Summary | -|---|---| -| [cause](index.md#-1023347080%2FProperties%2F-2117262581) | open val [cause](index.md#-1023347080%2FProperties%2F-2117262581): [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html) | -| [stackTrace](index.md#1573944892%2FProperties%2F-2117262581) | open var [stackTrace](index.md#1573944892%2FProperties%2F-2117262581): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html)> | - -## Functions - -| Name | Summary | -|---|---| -| [addSuppressed](index.md#-1898257014%2FFunctions%2F-2117262581) | fun [addSuppressed](index.md#-1898257014%2FFunctions%2F-2117262581)(exception: [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html)) | -| [fillInStackTrace](index.md#-1207709164%2FFunctions%2F-2117262581) | public [fillInStackTrace](index.md#-1207709164%2FFunctions%2F-2117262581)(): [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html) | -| [getLocalizedMessage](index.md#-2138642817%2FFunctions%2F-2117262581) | public [getLocalizedMessage](index.md#-2138642817%2FFunctions%2F-2117262581)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | -| [getMessage](index.md#1068546184%2FFunctions%2F-2117262581) | public [getMessage](index.md#1068546184%2FFunctions%2F-2117262581)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | -| [getSuppressed](index.md#1678506999%2FFunctions%2F-2117262581) | fun [getSuppressed](index.md#1678506999%2FFunctions%2F-2117262581)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html)> | -| [initCause](index.md#-104903378%2FFunctions%2F-2117262581) | public [initCause](index.md#-104903378%2FFunctions%2F-2117262581)(cause: [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html)): [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html) | -| [printStackTrace](index.md#-1357294889%2FFunctions%2F-2117262581) | public [printStackTrace](index.md#-1357294889%2FFunctions%2F-2117262581)() | -| [toString](index.md#1869833549%2FFunctions%2F-2117262581) | public [toString](index.md#1869833549%2FFunctions%2F-2117262581)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | +# ModelCenterException + +public class [ModelCenterException](index.md) : [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) + +This class wraps exceptions thrown by the ModelCenter native methods. + +#### Author + +Haisma, 2/2000 + +#### See also + +| | +|---| +| [ModelCenter](../-model-center/index.md) | + +## Constructors + +| | | +|---|---| +| [ModelCenterException](-model-center-exception.md) | constructor()constructor(s: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))constructor(cause: [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html))constructor(s: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), cause: [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html)) | + +## Properties + +| Name | Summary | +|---|---| +| [cause](index.md#-1023347080%2FProperties%2F-2117262581) | open val [cause](index.md#-1023347080%2FProperties%2F-2117262581): [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html) | +| [stackTrace](index.md#1573944892%2FProperties%2F-2117262581) | open var [stackTrace](index.md#1573944892%2FProperties%2F-2117262581): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://docs.oracle.com/javase/8/docs/api/java/lang/StackTraceElement.html)> | + +## Functions + +| Name | Summary | +|---|---| +| [addSuppressed](index.md#-1898257014%2FFunctions%2F-2117262581) | fun [addSuppressed](index.md#-1898257014%2FFunctions%2F-2117262581)(exception: [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html)) | +| [fillInStackTrace](index.md#-1207709164%2FFunctions%2F-2117262581) | public [fillInStackTrace](index.md#-1207709164%2FFunctions%2F-2117262581)(): [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html) | +| [getLocalizedMessage](index.md#-2138642817%2FFunctions%2F-2117262581) | public [getLocalizedMessage](index.md#-2138642817%2FFunctions%2F-2117262581)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | +| [getMessage](index.md#1068546184%2FFunctions%2F-2117262581) | public [getMessage](index.md#1068546184%2FFunctions%2F-2117262581)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | +| [getSuppressed](index.md#1678506999%2FFunctions%2F-2117262581) | fun [getSuppressed](index.md#1678506999%2FFunctions%2F-2117262581)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html)> | +| [initCause](index.md#-104903378%2FFunctions%2F-2117262581) | public [initCause](index.md#-104903378%2FFunctions%2F-2117262581)(cause: [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html)): [Throwable](https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html) | +| [printStackTrace](index.md#-1357294889%2FFunctions%2F-2117262581) | public [printStackTrace](index.md#-1357294889%2FFunctions%2F-2117262581)() | +| [toString](index.md#1869833549%2FFunctions%2F-2117262581) | public [toString](index.md#1869833549%2FFunctions%2F-2117262581)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-a-s-s-e-m-b-l-y.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-a-s-s-e-m-b-l-y.md index a50fcfcbb7..873f69587d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-a-s-s-e-m-b-l-y.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-a-s-s-e-m-b-l-y.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[ASSEMBLY_TYPE_ASSEMBLY](-a-s-s-e-m-b-l-y_-t-y-p-e_-a-s-s-e-m-b-l-y.md) - -# ASSEMBLY_TYPE_ASSEMBLY - - -val [ASSEMBLY_TYPE_ASSEMBLY](-a-s-s-e-m-b-l-y_-t-y-p-e_-a-s-s-e-m-b-l-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Assembly" +# ASSEMBLY_TYPE_ASSEMBLY + + +val [ASSEMBLY_TYPE_ASSEMBLY](-a-s-s-e-m-b-l-y_-t-y-p-e_-a-s-s-e-m-b-l-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Assembly" diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-f-o-r_-e-a-c-h.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-f-o-r_-e-a-c-h.md index 4c2d0b3751..7f278bf304 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-f-o-r_-e-a-c-h.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-f-o-r_-e-a-c-h.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[ASSEMBLY_TYPE_FOR_EACH](-a-s-s-e-m-b-l-y_-t-y-p-e_-f-o-r_-e-a-c-h.md) - -# ASSEMBLY_TYPE_FOR_EACH - - -val [ASSEMBLY_TYPE_FOR_EACH](-a-s-s-e-m-b-l-y_-t-y-p-e_-f-o-r_-e-a-c-h.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ForEach" +# ASSEMBLY_TYPE_FOR_EACH + + +val [ASSEMBLY_TYPE_FOR_EACH](-a-s-s-e-m-b-l-y_-t-y-p-e_-f-o-r_-e-a-c-h.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ForEach" diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-i-f.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-i-f.md index b5de2d8275..60e69687d4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-i-f.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-i-f.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[ASSEMBLY_TYPE_IF](-a-s-s-e-m-b-l-y_-t-y-p-e_-i-f.md) - -# ASSEMBLY_TYPE_IF - - -val [ASSEMBLY_TYPE_IF](-a-s-s-e-m-b-l-y_-t-y-p-e_-i-f.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "If" +# ASSEMBLY_TYPE_IF + + +val [ASSEMBLY_TYPE_IF](-a-s-s-e-m-b-l-y_-t-y-p-e_-i-f.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "If" diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-p-a-r-a-l-l-e-l.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-p-a-r-a-l-l-e-l.md index 05dbf2b945..a86fbbd069 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-p-a-r-a-l-l-e-l.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-p-a-r-a-l-l-e-l.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[ASSEMBLY_TYPE_PARALLEL](-a-s-s-e-m-b-l-y_-t-y-p-e_-p-a-r-a-l-l-e-l.md) - -# ASSEMBLY_TYPE_PARALLEL - - -val [ASSEMBLY_TYPE_PARALLEL](-a-s-s-e-m-b-l-y_-t-y-p-e_-p-a-r-a-l-l-e-l.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Parallel" +# ASSEMBLY_TYPE_PARALLEL + + +val [ASSEMBLY_TYPE_PARALLEL](-a-s-s-e-m-b-l-y_-t-y-p-e_-p-a-r-a-l-l-e-l.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Parallel" diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-s-e-q-u-e-n-c-e.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-s-e-q-u-e-n-c-e.md index aa6eb01b14..613763d3e6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-s-e-q-u-e-n-c-e.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-s-e-q-u-e-n-c-e.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[ASSEMBLY_TYPE_SEQUENCE](-a-s-s-e-m-b-l-y_-t-y-p-e_-s-e-q-u-e-n-c-e.md) - -# ASSEMBLY_TYPE_SEQUENCE - - -val [ASSEMBLY_TYPE_SEQUENCE](-a-s-s-e-m-b-l-y_-t-y-p-e_-s-e-q-u-e-n-c-e.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Sequence" +# ASSEMBLY_TYPE_SEQUENCE + + +val [ASSEMBLY_TYPE_SEQUENCE](-a-s-s-e-m-b-l-y_-t-y-p-e_-s-e-q-u-e-n-c-e.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Sequence" diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/height.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/height.md index 715645696d..118f6bad84 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/height.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/height.md @@ -1,6 +1,4 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[ModelCenter](../index.md)/[AssemblyStyleInfo](index.md)/[height](height.md) - -# height - - -val [height](height.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) +# height + + +val [height](height.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/index.md index 3626e72a38..7cb2f506e3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/index.md @@ -1,16 +1,14 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[ModelCenter](../index.md)/[AssemblyStyleInfo](index.md) - -# AssemblyStyleInfo - - -public class [AssemblyStyleInfo](index.md) - -Information about an assembly's visual style. - -## Properties - -| Name | Summary | -|---|---| -| [height](height.md) | val [height](height.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | -| [style](style.md) | val [style](style.md): [ModelCenter.AssemblyStyle](../-assembly-style/index.md) | -| [width](width.md) | val [width](width.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +# AssemblyStyleInfo + + +public class [AssemblyStyleInfo](index.md) + +Information about an assembly's visual style. + +## Properties + +| Name | Summary | +|---|---| +| [height](height.md) | val [height](height.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [style](style.md) | val [style](style.md): [ModelCenter.AssemblyStyle](../-assembly-style/index.md) | +| [width](width.md) | val [width](width.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/style.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/style.md index e5c82333cf..8561b64661 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/style.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/style.md @@ -1,6 +1,4 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[ModelCenter](../index.md)/[AssemblyStyleInfo](index.md)/[style](style.md) - -# style - - -val [style](style.md): [ModelCenter.AssemblyStyle](../-assembly-style/index.md) +# style + + +val [style](style.md): [ModelCenter.AssemblyStyle](../-assembly-style/index.md) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/width.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/width.md index 46cf5c48a5..686fad6ff3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/width.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/width.md @@ -1,6 +1,4 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[ModelCenter](../index.md)/[AssemblyStyleInfo](index.md)/[width](width.md) - -# width - - -val [width](width.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) +# width + + +val [width](width.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-auto-n-squared/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-auto-n-squared/index.md index 9f8a9cdf7c..00498f884e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-auto-n-squared/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-auto-n-squared/index.md @@ -1,8 +1,6 @@ -//[mc_api](../../../../../index.md)/[com.phoenix_int.ModelCenter](../../../index.md)/[ModelCenter](../../index.md)/[AssemblyStyle](../index.md)/[AutoNSquared](index.md) - -# AutoNSquared - - -[AutoNSquared](index.md) - -Set to auto-N^2 view. Only valid for data-driven assemblies. +# AutoNSquared + + +[AutoNSquared](index.md) + +Set to auto-N^2 view. Only valid for data-driven assemblies. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-classic/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-classic/index.md index 8547546db4..df7bf704d6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-classic/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-classic/index.md @@ -1,8 +1,6 @@ -//[mc_api](../../../../../index.md)/[com.phoenix_int.ModelCenter](../../../index.md)/[ModelCenter](../../index.md)/[AssemblyStyle](../index.md)/[Classic](index.md) - -# Classic - - -[Classic](index.md) - -Set to classic view. Only valid for data-driven assemblies. +# Classic + + +[Classic](index.md) + +Set to classic view. Only valid for data-driven assemblies. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-collapsed/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-collapsed/index.md index 7a29bdf70d..ca0fda97c7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-collapsed/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-collapsed/index.md @@ -1,8 +1,6 @@ -//[mc_api](../../../../../index.md)/[com.phoenix_int.ModelCenter](../../../index.md)/[ModelCenter](../../index.md)/[AssemblyStyle](../index.md)/[Collapsed](index.md) - -# Collapsed - - -[Collapsed](index.md) - -Collapse the assembly. Not allowed for the model. +# Collapsed + + +[Collapsed](index.md) + +Collapse the assembly. Not allowed for the model. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-expanded/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-expanded/index.md index b508a4ff4e..420f96219c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-expanded/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-expanded/index.md @@ -1,8 +1,6 @@ -//[mc_api](../../../../../index.md)/[com.phoenix_int.ModelCenter](../../../index.md)/[ModelCenter](../../index.md)/[AssemblyStyle](../index.md)/[Expanded](index.md) - -# Expanded - - -[Expanded](index.md) - -Expand the assembly. No effect for the model. +# Expanded + + +[Expanded](index.md) + +Expand the assembly. No effect for the model. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-n-squared/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-n-squared/index.md index 9e451fe596..759f5adb7e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-n-squared/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-n-squared/index.md @@ -1,8 +1,6 @@ -//[mc_api](../../../../../index.md)/[com.phoenix_int.ModelCenter](../../../index.md)/[ModelCenter](../../index.md)/[AssemblyStyle](../index.md)/[NSquared](index.md) - -# NSquared - - -[NSquared](index.md) - -Set to N^2 view. Only valid for data-driven assemblies. +# NSquared + + +[NSquared](index.md) + +Set to N^2 view. Only valid for data-driven assemblies. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/index.md index 78c39a6bde..860576fce1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/index.md @@ -1,25 +1,23 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[ModelCenter](../index.md)/[AssemblyStyle](index.md) - -# AssemblyStyle - - -enum [AssemblyStyle](index.md) - -Ways to display an assembly. - -## Entries - -| | | -|---|---| -| [Collapsed](-collapsed/index.md) | [Collapsed](-collapsed/index.md)
Collapse the assembly. Not allowed for the model. | -| [Expanded](-expanded/index.md) | [Expanded](-expanded/index.md)
Expand the assembly. No effect for the model. | -| [Classic](-classic/index.md) | [Classic](-classic/index.md)
Set to classic view. Only valid for data-driven assemblies. | -| [NSquared](-n-squared/index.md) | [NSquared](-n-squared/index.md)
Set to N^2 view. Only valid for data-driven assemblies. | -| [AutoNSquared](-auto-n-squared/index.md) | [AutoNSquared](-auto-n-squared/index.md)
Set to auto-N^2 view. Only valid for data-driven assemblies. | - -## Functions - -| Name | Summary | -|---|---| -| [valueOf](value-of.md) | public [valueOf](value-of.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [ModelCenter.AssemblyStyle](index.md)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) | -| [values](values.md) | public [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[ModelCenter.AssemblyStyle](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants. | +# AssemblyStyle + + +enum [AssemblyStyle](index.md) + +Ways to display an assembly. + +## Entries + +| | | +|---|---| +| [Collapsed](-collapsed/index.md) | [Collapsed](-collapsed/index.md)
Collapse the assembly. Not allowed for the model. | +| [Expanded](-expanded/index.md) | [Expanded](-expanded/index.md)
Expand the assembly. No effect for the model. | +| [Classic](-classic/index.md) | [Classic](-classic/index.md)
Set to classic view. Only valid for data-driven assemblies. | +| [NSquared](-n-squared/index.md) | [NSquared](-n-squared/index.md)
Set to N^2 view. Only valid for data-driven assemblies. | +| [AutoNSquared](-auto-n-squared/index.md) | [AutoNSquared](-auto-n-squared/index.md)
Set to auto-N^2 view. Only valid for data-driven assemblies. | + +## Functions + +| Name | Summary | +|---|---| +| [valueOf](value-of.md) | public [valueOf](value-of.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [ModelCenter.AssemblyStyle](index.md)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) | +| [values](values.md) | public [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[ModelCenter.AssemblyStyle](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/value-of.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/value-of.md index c01d4ce9d7..95bdc327f5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/value-of.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/value-of.md @@ -1,18 +1,16 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[ModelCenter](../index.md)/[AssemblyStyle](index.md)/[valueOf](value-of.md) - -# valueOf - - -public [valueOf](value-of.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [ModelCenter.AssemblyStyle](index.md) - -Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) - -#### Return - -the enum constant with the specified name - -#### Throws - -| | | -|---|---| -| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if this enum type has no constant with the specified name | +# valueOf + + +public [valueOf](value-of.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [ModelCenter.AssemblyStyle](index.md) + +Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) + +#### Return + +the enum constant with the specified name + +#### Throws + +| | | +|---|---| +| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if this enum type has no constant with the specified name | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/values.md index b303bfdf7b..61c6baa4e9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/values.md @@ -1,12 +1,10 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[ModelCenter](../index.md)/[AssemblyStyle](index.md)/[values](values.md) - -# values - - -public [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[ModelCenter.AssemblyStyle](index.md)> - -Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants. - -#### Return - -an array containing the constants of this enum type, in the order they're declared +# values + + +public [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[ModelCenter.AssemblyStyle](index.md)> + +Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants. + +#### Return + +an array containing the constants of this enum type, in the order they're declared diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-c-o-n-n_-e-r-r_-e-r-r-o-r.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-c-o-n-n_-e-r-r_-e-r-r-o-r.md index 8c000564ad..b353423465 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-c-o-n-n_-e-r-r_-e-r-r-o-r.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-c-o-n-n_-e-r-r_-e-r-r-o-r.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[CONN_ERR_ERROR](-c-o-n-n_-e-r-r_-e-r-r-o-r.md) - -# CONN_ERR_ERROR - - -val [CONN_ERR_ERROR](-c-o-n-n_-e-r-r_-e-r-r-o-r.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 3 +# CONN_ERR_ERROR + + +val [CONN_ERR_ERROR](-c-o-n-n_-e-r-r_-e-r-r-o-r.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 3 diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-c-o-n-n_-e-r-r_-i-g-n-o-r-e.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-c-o-n-n_-e-r-r_-i-g-n-o-r-e.md index 68213b94d0..b800cdd00d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-c-o-n-n_-e-r-r_-i-g-n-o-r-e.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-c-o-n-n_-e-r-r_-i-g-n-o-r-e.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[CONN_ERR_IGNORE](-c-o-n-n_-e-r-r_-i-g-n-o-r-e.md) - -# CONN_ERR_IGNORE - - -val [CONN_ERR_IGNORE](-c-o-n-n_-e-r-r_-i-g-n-o-r-e.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 1 +# CONN_ERR_IGNORE + + +val [CONN_ERR_IGNORE](-c-o-n-n_-e-r-r_-i-g-n-o-r-e.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 1 diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-c-o-n-n_-e-r-r_-u-s-e-d-i-a-l-o-g.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-c-o-n-n_-e-r-r_-u-s-e-d-i-a-l-o-g.md index 8eab43a7fe..0f37405a65 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-c-o-n-n_-e-r-r_-u-s-e-d-i-a-l-o-g.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-c-o-n-n_-e-r-r_-u-s-e-d-i-a-l-o-g.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[CONN_ERR_USEDIALOG](-c-o-n-n_-e-r-r_-u-s-e-d-i-a-l-o-g.md) - -# CONN_ERR_USEDIALOG - - -val [CONN_ERR_USEDIALOG](-c-o-n-n_-e-r-r_-u-s-e-d-i-a-l-o-g.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = -1 +# CONN_ERR_USEDIALOG + + +val [CONN_ERR_USEDIALOG](-c-o-n-n_-e-r-r_-u-s-e-d-i-a-l-o-g.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = -1 diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-h-t-m-l-viewer-wait-for-close.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-h-t-m-l-viewer-wait-for-close.md index c7fdd79af7..a1571f94b7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-h-t-m-l-viewer-wait-for-close.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-h-t-m-l-viewer-wait-for-close.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[HTMLViewerWaitForClose](-h-t-m-l-viewer-wait-for-close.md) - -# HTMLViewerWaitForClose - - -public [HTMLViewerWaitForClose](-h-t-m-l-viewer-wait-for-close.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -waits for the HTMLViewer embedded browser tool to close +# HTMLViewerWaitForClose + + +public [HTMLViewerWaitForClose](-h-t-m-l-viewer-wait-for-close.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +waits for the HTMLViewer embedded browser tool to close diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-m-o-d-e-l_-t-y-p-e_-d-a-t-a.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-m-o-d-e-l_-t-y-p-e_-d-a-t-a.md index fc1985bc8a..511517cda5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-m-o-d-e-l_-t-y-p-e_-d-a-t-a.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-m-o-d-e-l_-t-y-p-e_-d-a-t-a.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[MODEL_TYPE_DATA](-m-o-d-e-l_-t-y-p-e_-d-a-t-a.md) - -# MODEL_TYPE_DATA - - -val [MODEL_TYPE_DATA](-m-o-d-e-l_-t-y-p-e_-d-a-t-a.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "dataModel" +# MODEL_TYPE_DATA + + +val [MODEL_TYPE_DATA](-m-o-d-e-l_-t-y-p-e_-d-a-t-a.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "dataModel" diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-m-o-d-e-l_-t-y-p-e_-p-r-o-c-e-s-s.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-m-o-d-e-l_-t-y-p-e_-p-r-o-c-e-s-s.md index a4ed35a85f..72b9b9d8d7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-m-o-d-e-l_-t-y-p-e_-p-r-o-c-e-s-s.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-m-o-d-e-l_-t-y-p-e_-p-r-o-c-e-s-s.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[MODEL_TYPE_PROCESS](-m-o-d-e-l_-t-y-p-e_-p-r-o-c-e-s-s.md) - -# MODEL_TYPE_PROCESS - - -val [MODEL_TYPE_PROCESS](-m-o-d-e-l_-t-y-p-e_-p-r-o-c-e-s-s.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "processModel" +# MODEL_TYPE_PROCESS + + +val [MODEL_TYPE_PROCESS](-m-o-d-e-l_-t-y-p-e_-p-r-o-c-e-s-s.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "processModel" diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-message-box.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-message-box.md index a061d690fa..83b7b15270 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-message-box.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-message-box.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[MessageBox](-message-box.md) - -# MessageBox - - -public [MessageBox](-message-box.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -displays a Windows Message Box - -#### Parameters - - - -| | | -|---|---| -| msg | the message to display | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# MessageBox + + +public [MessageBox](-message-box.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +displays a Windows Message Box + +#### Parameters + + + +| | | +|---|---| +| msg | the message to display | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-model-center.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-model-center.md index 3977094440..f454d70c9f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-model-center.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-model-center.md @@ -1,45 +1,43 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[ModelCenter](-model-center.md) - -# ModelCenter - - -constructor() - -constructor(optionStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -default constructor. A ModelCenter session is started and attached to Java - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), f: [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html)) - -Connects this Java object to the specified session of ModelCenter. The resulting session is not currently attached to any thread. As soon as any call is made to ModelCenter, this object is attached to that thread. All subsequent calls must then be made on that thread. To create a new, unattached instance, call newInstance(). - -#### Parameters - - - -| | | -|---|---| -| pstrm | A pointer to a stream generated by CoMarshalInterThreadInterfaceInStream() containing information about an IDispatch interface to ModelCenter. The caller should add a COM reference. The reference will be removed when this object is finalized (or closed) | -| f | the JFrame that represents the ModelCenter window | - - -constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), f: [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Connects this Java object to the specified session of ModelCenter. The resulting session is not currently attached to any thread. As soon as any call is made to ModelCenter, this object is attached to that thread. All subsequent calls must then be made on that thread. To create a new, unattached instance, call newInstance(). - -#### Parameters - - - -| | | -|---|---| -| pstrm | A pointer to a stream generated by CoMarshalInterThreadInterfaceInStream() containing information about an IDispatch interface to ModelCenter. The caller should add a COM reference. The reference will be removed when this object is finalized (or closed) | -| f | the JFrame that represents the ModelCenter window | -| addRef | whether to add a reference count on this acquisition or not | +# ModelCenter + + +constructor() + +constructor(optionStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +default constructor. A ModelCenter session is started and attached to Java + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), f: [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html)) + +Connects this Java object to the specified session of ModelCenter. The resulting session is not currently attached to any thread. As soon as any call is made to ModelCenter, this object is attached to that thread. All subsequent calls must then be made on that thread. To create a new, unattached instance, call newInstance(). + +#### Parameters + + + +| | | +|---|---| +| pstrm | A pointer to a stream generated by CoMarshalInterThreadInterfaceInStream() containing information about an IDispatch interface to ModelCenter. The caller should add a COM reference. The reference will be removed when this object is finalized (or closed) | +| f | the JFrame that represents the ModelCenter window | + + +constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), f: [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Connects this Java object to the specified session of ModelCenter. The resulting session is not currently attached to any thread. As soon as any call is made to ModelCenter, this object is attached to that thread. All subsequent calls must then be made on that thread. To create a new, unattached instance, call newInstance(). + +#### Parameters + + + +| | | +|---|---| +| pstrm | A pointer to a stream generated by CoMarshalInterThreadInterfaceInStream() containing information about an IDispatch interface to ModelCenter. The caller should add a COM reference. The reference will be removed when this object is finalized (or closed) | +| f | the JFrame that represents the ModelCenter window | +| addRef | whether to add a reference count on this acquisition or not | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/-do-not-version/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/-do-not-version/index.md index 0eb31692e6..ec3412f4aa 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/-do-not-version/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/-do-not-version/index.md @@ -1,8 +1,6 @@ -//[mc_api](../../../../../index.md)/[com.phoenix_int.ModelCenter](../../../index.md)/[ModelCenter](../../index.md)/[VersionStatus](../index.md)/[DoNotVersion](index.md) - -# DoNotVersion - - -[DoNotVersion](index.md) - -Do not version file or subordinant files. +# DoNotVersion + + +[DoNotVersion](index.md) + +Do not version file or subordinant files. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/-do-versioning-if-possible/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/-do-versioning-if-possible/index.md index c92374930a..8c91faa5e7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/-do-versioning-if-possible/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/-do-versioning-if-possible/index.md @@ -1,8 +1,6 @@ -//[mc_api](../../../../../index.md)/[com.phoenix_int.ModelCenter](../../../index.md)/[ModelCenter](../../index.md)/[VersionStatus](../index.md)/[DoVersioningIfPossible](index.md) - -# DoVersioningIfPossible - - -[DoVersioningIfPossible](index.md) - -Version the file and subordinant files if possible. +# DoVersioningIfPossible + + +[DoVersioningIfPossible](index.md) + +Version the file and subordinant files if possible. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/-do-versioning/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/-do-versioning/index.md index fd007b9402..9295b93447 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/-do-versioning/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/-do-versioning/index.md @@ -1,8 +1,6 @@ -//[mc_api](../../../../../index.md)/[com.phoenix_int.ModelCenter](../../../index.md)/[ModelCenter](../../index.md)/[VersionStatus](../index.md)/[DoVersioning](index.md) - -# DoVersioning - - -[DoVersioning](index.md) - -Version the file and all subordinant files. Error if any file cannot be versioned. +# DoVersioning + + +[DoVersioning](index.md) + +Version the file and all subordinant files. Error if any file cannot be versioned. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/index.md index 94e3409716..ff933558d0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/index.md @@ -1,23 +1,21 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[ModelCenter](../index.md)/[VersionStatus](index.md) - -# VersionStatus - - -enum [VersionStatus](index.md) - -Ways to version a file - -## Entries - -| | | -|---|---| -| [DoVersioning](-do-versioning/index.md) | [DoVersioning](-do-versioning/index.md)
Version the file and all subordinant files. Error if any file cannot be versioned. | -| [DoNotVersion](-do-not-version/index.md) | [DoNotVersion](-do-not-version/index.md)
Do not version file or subordinant files. | -| [DoVersioningIfPossible](-do-versioning-if-possible/index.md) | [DoVersioningIfPossible](-do-versioning-if-possible/index.md)
Version the file and subordinant files if possible. | - -## Functions - -| Name | Summary | -|---|---| -| [valueOf](value-of.md) | public [valueOf](value-of.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [ModelCenter.VersionStatus](index.md)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) | -| [values](values.md) | public [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[ModelCenter.VersionStatus](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants. | +# VersionStatus + + +enum [VersionStatus](index.md) + +Ways to version a file + +## Entries + +| | | +|---|---| +| [DoVersioning](-do-versioning/index.md) | [DoVersioning](-do-versioning/index.md)
Version the file and all subordinant files. Error if any file cannot be versioned. | +| [DoNotVersion](-do-not-version/index.md) | [DoNotVersion](-do-not-version/index.md)
Do not version file or subordinant files. | +| [DoVersioningIfPossible](-do-versioning-if-possible/index.md) | [DoVersioningIfPossible](-do-versioning-if-possible/index.md)
Version the file and subordinant files if possible. | + +## Functions + +| Name | Summary | +|---|---| +| [valueOf](value-of.md) | public [valueOf](value-of.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [ModelCenter.VersionStatus](index.md)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) | +| [values](values.md) | public [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[ModelCenter.VersionStatus](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/value-of.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/value-of.md index dabf2edd36..13792227af 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/value-of.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/value-of.md @@ -1,18 +1,16 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[ModelCenter](../index.md)/[VersionStatus](index.md)/[valueOf](value-of.md) - -# valueOf - - -public [valueOf](value-of.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [ModelCenter.VersionStatus](index.md) - -Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) - -#### Return - -the enum constant with the specified name - -#### Throws - -| | | -|---|---| -| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if this enum type has no constant with the specified name | +# valueOf + + +public [valueOf](value-of.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [ModelCenter.VersionStatus](index.md) + +Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) + +#### Return + +the enum constant with the specified name + +#### Throws + +| | | +|---|---| +| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if this enum type has no constant with the specified name | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/values.md index 187e366478..0dd5b02c12 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/values.md @@ -1,12 +1,10 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[ModelCenter](../index.md)/[VersionStatus](index.md)/[values](values.md) - -# values - - -public [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[ModelCenter.VersionStatus](index.md)> - -Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants. - -#### Return - -an array containing the constants of this enum type, in the order they're declared +# values + + +public [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[ModelCenter.VersionStatus](index.md)> + +Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants. + +#### Return + +an array containing the constants of this enum type, in the order they're declared diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/add-icon.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/add-icon.md index ec48976fa4..969179a6b9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/add-icon.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/add-icon.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[addIcon](add-icon.md) - -# addIcon - - -public [addIcon](add-icon.md)(iconFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -Registers an icon with ModelCenter. This icon can then later be used to customize Assemblies and Groups via the iconID property - -#### Return - -the id of the added icon - -#### Parameters - - - -| | -|---| -| iconFile | +# addIcon + + +public [addIcon](add-icon.md)(iconFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Registers an icon with ModelCenter. This icon can then later be used to customize Assemblies and Groups via the iconID property + +#### Return + +the id of the added icon + +#### Parameters + + + +| | +|---| +| iconFile | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/add-new-macro.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/add-new-macro.md index e508eb281c..e643efdf92 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/add-new-macro.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/add-new-macro.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[addNewMacro](add-new-macro.md) - -# addNewMacro - - -public [addNewMacro](add-new-macro.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isAppMacro: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -adds a new Macro to ModelCenter's macro facility - -#### Parameters - - - -| | | -|---|---| -| macroName | the name of the new macro | -| isAppMacro | defines whether the new macro is an Application macro (true) or Model macro (false) | +# addNewMacro + + +public [addNewMacro](add-new-macro.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isAppMacro: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +adds a new Macro to ModelCenter's macro facility + +#### Parameters + + + +| | | +|---|---| +| macroName | the name of the new macro | +| isAppMacro | defines whether the new macro is an Application macro (true) or Model macro (false) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/allow-bring-window-to-front.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/allow-bring-window-to-front.md index 3620b8b90e..1d97ff6c22 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/allow-bring-window-to-front.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/allow-bring-window-to-front.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[allowBringWindowToFront](allow-bring-window-to-front.md) - -# allowBringWindowToFront - - -public [allowBringWindowToFront](allow-bring-window-to-front.md)(processID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -Use OS calls to allow another process to bring a window to the front. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# allowBringWindowToFront + + +public [allowBringWindowToFront](allow-bring-window-to-front.md)(processID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +Use OS calls to allow another process to bring a window to the front. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/auto-link.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/auto-link.md index 2e9ca3a72e..2b9de53ee6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/auto-link.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/auto-link.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[autoLink](auto-link.md) - -# autoLink - - -public [autoLink](auto-link.md)(srcComp: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), destComp: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -auto links the variables of two Components - -#### Parameters - - - -| | | -|---|---| -| srcComp | name of the source component | -| destComp | name of the destination component | +# autoLink + + +public [autoLink](auto-link.md)(srcComp: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), destComp: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +auto links the variables of two Components + +#### Parameters + + + +| | | +|---|---| +| srcComp | name of the source component | +| destComp | name of the destination component | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/break-link.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/break-link.md index 969f154226..31aa03a734 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/break-link.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/break-link.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[breakLink](break-link.md) - -# breakLink - - -public [breakLink](break-link.md)(variable: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Breaks the link of a specified variable - -#### Parameters - - - -| | | -|---|---| -| variable | the variable whose link is to be broken | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# breakLink + + +public [breakLink](break-link.md)(variable: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Breaks the link of a specified variable + +#### Parameters + + + +| | | +|---|---| +| variable | the variable whose link is to be broken | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/checkout.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/checkout.md index 85564ba336..f1068a7691 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/checkout.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/checkout.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[checkout](checkout.md) - -# checkout - - -public [checkout](checkout.md)(feature: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Feature](../-feature/index.md) - -Should check out a license feature from Ansys - -#### Return - -a Feature object - -#### Parameters - - - -| | | -|---|---| -| feature | the name of the feature to be checked out | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# checkout + + +public [checkout](checkout.md)(feature: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Feature](../-feature/index.md) + +Should check out a license feature from Ansys + +#### Return + +a Feature object + +#### Parameters + + + +| | | +|---|---| +| feature | the name of the feature to be checked out | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/checkout2.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/checkout2.md index 7b0db43511..3d538610c7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/checkout2.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/checkout2.md @@ -1,27 +1,25 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[checkout2](checkout2.md) - -# checkout2 - - -public [checkout2](checkout2.md)(feature: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), productRelease: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Feature](../-feature/index.md) - -Should check out a license feature from Ansys - -#### Return - -a Feature object - -#### Parameters - - - -| | | -|---|---| -| feature | the name of the feature to be checked out | -| productRelease | the release date of the feature being passed | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# checkout2 + + +public [checkout2](checkout2.md)(feature: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), productRelease: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Feature](../-feature/index.md) + +Should check out a license feature from Ansys + +#### Return + +a Feature object + +#### Parameters + + + +| | | +|---|---| +| feature | the name of the feature to be checked out | +| productRelease | the release date of the feature being passed | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/close-h-t-m-l-viewer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/close-h-t-m-l-viewer.md index 32c2d2dddf..8059b4b087 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/close-h-t-m-l-viewer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/close-h-t-m-l-viewer.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[closeHTMLViewer](close-h-t-m-l-viewer.md) - -# closeHTMLViewer - - -public [closeHTMLViewer](close-h-t-m-l-viewer.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -closes the HTMLViewer embedded browser tool +# closeHTMLViewer + + +public [closeHTMLViewer](close-h-t-m-l-viewer.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +closes the HTMLViewer embedded browser tool diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/close-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/close-model.md index eb975e0c21..50597d3b3e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/close-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/close-model.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[closeModel](close-model.md) - -# closeModel - - -public [closeModel](close-model.md)() - -closes the model within ModelCenter - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# closeModel + + +public [closeModel](close-model.md)() + +closes the model within ModelCenter + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/close.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/close.md index 146c7a892e..9f4400ca2f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/close.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/close.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[close](close.md) - -# close - - -public [close](close.md)() - -closes ModelCenter. This function is also called by the finalizer for this class, but since finalizers are not guarenteed to be called, this method should be called directly. It is safe to call close() multiple times. - -#### Deprecated - -close() is just an alias for "release()", which is the preferred way to release the object. ModelCenter will close when all objects pointing to it are released(). - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# close + + +public [close](close.md)() + +closes ModelCenter. This function is also called by the finalizer for this class, but since finalizers are not guarenteed to be called, this method should be called directly. It is safe to call close() multiple times. + +#### Deprecated + +close() is just an alias for "release()", which is the preferred way to release the object. ModelCenter will close when all objects pointing to it are released(). + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-and-init-component.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-and-init-component.md index e5c94e648d..3c3874bc80 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-and-init-component.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-and-init-component.md @@ -1,31 +1,29 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[createAndInitComponent](create-and-init-component.md) - -# createAndInitComponent - - -public [createAndInitComponent](create-and-init-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), initString: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Component](../-component/index.md) - -Creates a new component and initializes it from string data. IMPORTANT NOTE: This method can only be invoked on plugins which support IComponentPlugin.fromString(). Furthermore, it should only be used when you know EXACTLY the format that is expected by the component's fromString() method. It is designed to be used from plugins in third-party software which need to initialize a matching component to connect to that software in the model. Ideally, both the plugin for the third-party software and the ModelCenter component WILL SHARE THE SAME CODEBASE, so you can generate the configuration string from the same code which you will use to process it later. Mismatch between formats will almost certainly cause this method to fail. - -#### Return - -the component created - -#### Parameters - - - -| | | -|---|---| -| serverPath | the server path, e.g. "mcre:\\localhost\block" | -| name | the name for the new component | -| parentName | the parent component | -| initString | the initialization string for the component (see above) if initString is NULL, behavior is identical to createComponent() | -| xPos | the x position | -| yPos | the y position | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# createAndInitComponent + + +public [createAndInitComponent](create-and-init-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), initString: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Component](../-component/index.md) + +Creates a new component and initializes it from string data. IMPORTANT NOTE: This method can only be invoked on plugins which support IComponentPlugin.fromString(). Furthermore, it should only be used when you know EXACTLY the format that is expected by the component's fromString() method. It is designed to be used from plugins in third-party software which need to initialize a matching component to connect to that software in the model. Ideally, both the plugin for the third-party software and the ModelCenter component WILL SHARE THE SAME CODEBASE, so you can generate the configuration string from the same code which you will use to process it later. Mismatch between formats will almost certainly cause this method to fail. + +#### Return + +the component created + +#### Parameters + + + +| | | +|---|---| +| serverPath | the server path, e.g. "mcre:\\localhost\block" | +| name | the name for the new component | +| parentName | the parent component | +| initString | the initialization string for the component (see above) if initString is NULL, behavior is identical to createComponent() | +| xPos | the x position | +| yPos | the y position | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-assembly-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-assembly-variable.md index da7026f684..d68c7cef65 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-assembly-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-assembly-variable.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[createAssemblyVariable](create-assembly-variable.md) - -# createAssemblyVariable - - -public [createAssemblyVariable](create-assembly-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) - -creates an assembly variable - -#### Return - -a Variable object - -#### Parameters - - - -| | | -|---|---| -| name | Name of the new variable to create. | -| type | Type of the new variable. Possible types are: double, int, string, file, double[], int[], boolean[], string[], quadfacet, surfaceofrevolution, nurbs, bspline, ruled, skinned, vrml, node | -| parent | the name of the parent assembly | +# createAssemblyVariable + + +public [createAssemblyVariable](create-assembly-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) + +creates an assembly variable + +#### Return + +a Variable object + +#### Parameters + + + +| | | +|---|---| +| name | Name of the new variable to create. | +| type | Type of the new variable. Possible types are: double, int, string, file, double[], int[], boolean[], string[], quadfacet, surfaceofrevolution, nurbs, bspline, ruled, skinned, vrml, node | +| parent | the name of the parent assembly | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-assembly.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-assembly.md index 81cd969291..36ce521697 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-assembly.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-assembly.md @@ -1,40 +1,38 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[createAssembly](create-assembly.md) - -# createAssembly - - -public [createAssembly](create-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md) - -creates an assembly - -#### Return - -an Assembly object - -#### Parameters - - - -| | | -|---|---| -| name | the name of the assembly to be created | -| parent | the name of the parent assembly | - - -public [createAssembly](create-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), assemblyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md) - -creates an assembly - -#### Return - -an Assembly object - -#### Parameters - - - -| | | -|---|---| -| name | the name of the assembly to be created | -| parent | the name of the parent assembly | -| assemblyType | the type of assembly to create: ASSEMBLY_TYPE_ASSEMBLY - traditional ModelCenter assembly The following additional assembly types are available in ModelCenter process models (i.e. modelType == MODEL_TYPE_PROCESS) ASSEMBLY_TYPE_SEQUENCE - sequential flow ASSEMBLY_TYPE_IF - if-then-else flow ASSEMBLY_TYPE_FOR_EACH - loop over a data array | +# createAssembly + + +public [createAssembly](create-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md) + +creates an assembly + +#### Return + +an Assembly object + +#### Parameters + + + +| | | +|---|---| +| name | the name of the assembly to be created | +| parent | the name of the parent assembly | + + +public [createAssembly](create-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), assemblyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md) + +creates an assembly + +#### Return + +an Assembly object + +#### Parameters + + + +| | | +|---|---| +| name | the name of the assembly to be created | +| parent | the name of the parent assembly | +| assemblyType | the type of assembly to create: ASSEMBLY_TYPE_ASSEMBLY - traditional ModelCenter assembly The following additional assembly types are available in ModelCenter process models (i.e. modelType == MODEL_TYPE_PROCESS) ASSEMBLY_TYPE_SEQUENCE - sequential flow ASSEMBLY_TYPE_IF - if-then-else flow ASSEMBLY_TYPE_FOR_EACH - loop over a data array | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-component.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-component.md index c1443636ac..a244bd25f3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-component.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-component.md @@ -1,47 +1,45 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[createComponent](create-component.md) - -# createComponent - - -public [createComponent](create-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Instantiates a new component into the Model - -#### Parameters - - - -| | | -|---|---| -| serverPath | the location of the Component to instantiate, e.g. mcre://localhost/Block | -| name | the name for the instantiated Component | -| parentName | the name of the parent Component to instantiate the new Component into. To instantiate the Component into the top level, the parent name is usually "Model" | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [createComponent](create-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -Instantiates a new component into the Model - -#### Parameters - - - -| | | -|---|---| -| serverPath | the location of the Component to instantiate, e.g. mcre://localhost/Block | -| name | the name for the instantiated Component | -| parentName | the name of the parent Component to instantiate the new Component into. To instantiate the Component into the top level, the parent name is usually "Model" | -| xPos | the x position for the new component in the Analysis View | -| yPos | the y position for the new component in the Analysis View | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# createComponent + + +public [createComponent](create-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Instantiates a new component into the Model + +#### Parameters + + + +| | | +|---|---| +| serverPath | the location of the Component to instantiate, e.g. mcre://localhost/Block | +| name | the name for the instantiated Component | +| parentName | the name of the parent Component to instantiate the new Component into. To instantiate the Component into the top level, the parent name is usually "Model" | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [createComponent](create-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +Instantiates a new component into the Model + +#### Parameters + + + +| | | +|---|---| +| serverPath | the location of the Component to instantiate, e.g. mcre://localhost/Block | +| name | the name for the instantiated Component | +| parentName | the name of the parent Component to instantiate the new Component into. To instantiate the Component into the top level, the parent name is usually "Model" | +| xPos | the x position for the new component in the Analysis View | +| yPos | the y position for the new component in the Analysis View | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-collector.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-collector.md index b8416637d6..1c8ad3be33 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-collector.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-collector.md @@ -1,28 +1,26 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[createDataCollector](create-data-collector.md) - -# createDataCollector - - -public [~~createDataCollector~~](create-data-collector.md)(tradeStudyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DataCollector](../-data-collector/index.md) - ---- - -### Deprecated - ---- - -creates a Data Collector for storing and displaying data - -#### Return - -a DataCollector object - -#### Deprecated - -use [createDataExplorer](create-data-explorer.md) instead - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# createDataCollector + + +public [~~createDataCollector~~](create-data-collector.md)(tradeStudyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DataCollector](../-data-collector/index.md) + +--- + +### Deprecated + +--- + +creates a Data Collector for storing and displaying data + +#### Return + +a DataCollector object + +#### Deprecated + +use [createDataExplorer](create-data-explorer.md) instead + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-explorer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-explorer.md index 7b8da6a442..4ff5008cdd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-explorer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-explorer.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[createDataExplorer](create-data-explorer.md) - -# createDataExplorer - - -public [createDataExplorer](create-data-explorer.md)(tradeStudyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DataExplorer](../-data-explorer/index.md) - -creates a Data Explorer for storing and displaying data - -#### Return - -a DataExplorer object - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# createDataExplorer + + +public [createDataExplorer](create-data-explorer.md)(tradeStudyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DataExplorer](../-data-explorer/index.md) + +creates a Data Explorer for storing and displaying data + +#### Return + +a DataExplorer object + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-history-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-history-variable.md index 619bf22632..7d2bc76b10 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-history-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-history-variable.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[createDataHistoryVariable](create-data-history-variable.md) - -# createDataHistoryVariable - - -public [createDataHistoryVariable](create-data-history-variable.md)(): [DHVariable](../-d-h-variable/index.md) - -Creates a new DHVariable instance. - -#### Return - -a blank DHVariable object - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# createDataHistoryVariable + + +public [createDataHistoryVariable](create-data-history-variable.md)(): [DHVariable](../-d-h-variable/index.md) + +Creates a new DHVariable instance. + +#### Return + +a blank DHVariable object + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-monitor.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-monitor.md index 86cd77b48e..3148314e75 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-monitor.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-monitor.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[createDataMonitor](create-data-monitor.md) - -# createDataMonitor - - -public [createDataMonitor](create-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), x: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), y: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [DataMonitor](../-data-monitor/index.md) - -create a data monitor and associate it with a particular component - -#### Return - -a PHXCOMDataMonitor COM object representing the data monitor control - -#### Parameters - - - -| | | -|---|---| -| component | the name of the component under which to create this data monitor | -| title | the title of the new data monitor | -| x | the x coordinate (in model space) of the new data monitor | -| y | the y coordinate (in model space) of the new data monitor | +# createDataMonitor + + +public [createDataMonitor](create-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), x: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), y: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [DataMonitor](../-data-monitor/index.md) + +create a data monitor and associate it with a particular component + +#### Return + +a PHXCOMDataMonitor COM object representing the data monitor control + +#### Parameters + + + +| | | +|---|---| +| component | the name of the component under which to create this data monitor | +| title | the title of the new data monitor | +| x | the x coordinate (in model space) of the new data monitor | +| y | the y coordinate (in model space) of the new data monitor | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-job-manager.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-job-manager.md index 9f9d914e1f..a410887a22 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-job-manager.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-job-manager.md @@ -1,64 +1,62 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[createJobManager](create-job-manager.md) - -# createJobManager - - -public [createJobManager](create-job-manager.md)(): [JobManager](../-job-manager/index.md) - -creates a JobManager object for performing trade study runs - -#### Return - -a JobManager object - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [createJobManager](create-job-manager.md)(showProgressDialog: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [JobManager](../-job-manager/index.md) - -Creates a JobManager for performing trade study runs. - -#### Return - -a JobManager object - -#### Parameters - - - -| | | -|---|---| -| showProgressDialog | if true, show a progress dialog when creating the job manager and attempt to parent it to the main ModelCenter window. If false, don't show a progress dialog. | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if something goes wrong creating a job manager | - - -public [createJobManager](create-job-manager.md)(progressDialogParent: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [JobManager](../-job-manager/index.md) - -Creates a JobManager for performing trade study runs. - -#### Return - -a JobManager object - -#### Parameters - - - -| | | -|---|---| -| progressDialogParent | the ID of the window that should own the progress dialog that will be shown when creating the job manager. | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if something goes wrong creating a job manager | +# createJobManager + + +public [createJobManager](create-job-manager.md)(): [JobManager](../-job-manager/index.md) + +creates a JobManager object for performing trade study runs + +#### Return + +a JobManager object + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [createJobManager](create-job-manager.md)(showProgressDialog: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [JobManager](../-job-manager/index.md) + +Creates a JobManager for performing trade study runs. + +#### Return + +a JobManager object + +#### Parameters + + + +| | | +|---|---| +| showProgressDialog | if true, show a progress dialog when creating the job manager and attempt to parent it to the main ModelCenter window. If false, don't show a progress dialog. | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if something goes wrong creating a job manager | + + +public [createJobManager](create-job-manager.md)(progressDialogParent: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [JobManager](../-job-manager/index.md) + +Creates a JobManager for performing trade study runs. + +#### Return + +a JobManager object + +#### Parameters + + + +| | | +|---|---| +| progressDialogParent | the ID of the window that should own the progress dialog that will be shown when creating the job manager. | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if something goes wrong creating a job manager | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-link.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-link.md index 55fa13f6c1..d9ac96e501 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-link.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-link.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[createLink](create-link.md) - -# createLink - - -public [createLink](create-link.md)(varName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Creates a new link - -#### Parameters - - - -| | | -|---|---| -| varName | the full name of the variable to be linked | -| equation | the variable(s) to link varName to. | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# createLink + + +public [createLink](create-link.md)(varName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Creates a new link + +#### Parameters + + + +| | | +|---|---| +| varName | the full name of the variable to be linked | +| equation | the variable(s) to link varName to. | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-plug-in-frame.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-plug-in-frame.md index 0e49f1b56e..58a4f32686 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-plug-in-frame.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-plug-in-frame.md @@ -1,30 +1,28 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[createPlugInFrame](create-plug-in-frame.md) - -# createPlugInFrame - - -public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -Create a frame window in which to embed the java plug-in - -#### Return - -window handle for the frame created - -#### Parameters - - - -| | | -|---|---| -| name | name of the plug-in frame | -| title | window title for the plug-in frame | -| reserved | Reserved for future use | -| plugin | IDispatch for the plug-in asking to be put into a frame | - - -public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), defWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), defHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), defWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), defHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), minWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), minHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) +# createPlugInFrame + + +public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +Create a frame window in which to embed the java plug-in + +#### Return + +window handle for the frame created + +#### Parameters + + + +| | | +|---|---| +| name | name of the plug-in frame | +| title | window title for the plug-in frame | +| reserved | Reserved for future use | +| plugin | IDispatch for the plug-in asking to be put into a frame | + + +public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), defWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), defHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), defWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), defHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), minWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), minHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-trade-study.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-trade-study.md index 70acc5e427..9ed41f1f83 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-trade-study.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/create-trade-study.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[createTradeStudy](create-trade-study.md) - -# createTradeStudy - - -public [createTradeStudy](create-trade-study.md)(idStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [TradeStudy](../-trade-study/index.md) - -Creates the specified trade study and returns a handle to it. Unlike for launchTradeStudy method, the trade study is not shown before object is returned. Does not currently support Java plug-ins. - -#### Parameters - - - -| | | -|---|---| -| idStr | a fully specified URL like "SOFTWARE\\Phoenix Integration\\Trade Study Plug-Ins\\DOE Tool" | +# createTradeStudy + + +public [createTradeStudy](create-trade-study.md)(idStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [TradeStudy](../-trade-study/index.md) + +Creates the specified trade study and returns a handle to it. Unlike for launchTradeStudy method, the trade study is not shown before object is returned. Does not currently support Java plug-ins. + +#### Parameters + + + +| | | +|---|---| +| idStr | a fully specified URL like "SOFTWARE\\Phoenix Integration\\Trade Study Plug-Ins\\DOE Tool" | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/destroy-plug-in-frame.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/destroy-plug-in-frame.md index efece23a36..ad3b787714 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/destroy-plug-in-frame.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/destroy-plug-in-frame.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[destroyPlugInFrame](destroy-plug-in-frame.md) - -# destroyPlugInFrame - - -public [destroyPlugInFrame](destroy-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -Destroys the frame window which the java plug-in is embedded in - -#### Parameters - - - -| | | -|---|---| -| hwnd | handle to the frame window CWnd | +# destroyPlugInFrame + + +public [destroyPlugInFrame](destroy-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +Destroys the frame window which the java plug-in is embedded in + +#### Parameters + + + +| | | +|---|---| +| hwnd | handle to the frame window CWnd | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/dump-com-debug.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/dump-com-debug.md index 14898ec346..488c5bcb9a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/dump-com-debug.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/dump-com-debug.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[dumpComDebug](dump-com-debug.md) - -# dumpComDebug - - -public [dumpComDebug](dump-com-debug.md)() - -Dumps COM debugging information on the ModelCenter process side; only has an effect if ModelCenter is compiled in Debug mode. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# dumpComDebug + + +public [dumpComDebug](dump-com-debug.md)() + +Dumps COM debugging information on the ModelCenter process side; only has an effect if ModelCenter is compiled in Debug mode. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-active-job-manager.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-active-job-manager.md index e9c452d194..a9a36f39d2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-active-job-manager.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-active-job-manager.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getActiveJobManager](get-active-job-manager.md) - -# getActiveJobManager - - -public [getActiveJobManager](get-active-job-manager.md)(): [JobManager](../-job-manager/index.md) - -Gets the Job Manager associated with the currently running trade study. An exception will be thrown if a trade study is not currently running - -#### Return - -a Job Manager object +# getActiveJobManager + + +public [getActiveJobManager](get-active-job-manager.md)(): [JobManager](../-job-manager/index.md) + +Gets the Job Manager associated with the currently running trade study. An exception will be thrown if a trade study is not currently running + +#### Return + +a Job Manager object diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-app-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-app-name.md index 0e30e97f00..00f67d7f1f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-app-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-app-name.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getAppName](get-app-name.md) - -# getAppName - - -public [getAppName](get-app-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the Application name - -#### Return - -Application name - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getAppName + + +public [getAppName](get-app-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the Application name + +#### Return + +Application name + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-assembly-style.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-assembly-style.md index 8fee96e9b4..174980612e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-assembly-style.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-assembly-style.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getAssemblyStyle](get-assembly-style.md) - -# getAssemblyStyle - - -public [getAssemblyStyle](get-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [ModelCenter.AssemblyStyleInfo](-assembly-style-info/index.md) - -Get the visual style of an assembly. This method can be used to get information about any control with children, including IF blocks, traditional assemblies, drivers (in process mode), sequences, and parallel blocks. The style in the returned data will either be Expanded or Collapsed, except for expanded data-driven assemblies, which will have more detailed information. - -#### Return - -the style information - -#### Parameters - - - -| | | -|---|---| -| assemblyName | the full name of the assembly to modify | +# getAssemblyStyle + + +public [getAssemblyStyle](get-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [ModelCenter.AssemblyStyleInfo](-assembly-style-info/index.md) + +Get the visual style of an assembly. This method can be used to get information about any control with children, including IF blocks, traditional assemblies, drivers (in process mode), sequences, and parallel blocks. The style in the returned data will either be Expanded or Collapsed, except for expanded data-driven assemblies, which will have more detailed information. + +#### Return + +the style information + +#### Parameters + + + +| | | +|---|---| +| assemblyName | the full name of the assembly to modify | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-assembly.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-assembly.md index 64638f162b..38b4b7ea54 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-assembly.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-assembly.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getAssembly](get-assembly.md) - -# getAssembly - - -public [getAssembly](get-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md) - -Gets the specified assembly from the model. - -#### Return - -an Assembly object - -#### Parameters - - - -| | | -|---|---| -| name | the assembly name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getAssembly + + +public [getAssembly](get-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md) + +Gets the specified assembly from the model. + +#### Return + +an Assembly object + +#### Parameters + + + +| | | +|---|---| +| name | the assembly name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-component.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-component.md index 9294af29b3..cec981c189 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-component.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-component.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getComponent](get-component.md) - -# getComponent - - -public [getComponent](get-component.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Component](../-component/index.md) - -Gets the specified component from the Model - -#### Return - -a Component object - -#### Parameters - - - -| | | -|---|---| -| name | the component name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getComponent + + +public [getComponent](get-component.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Component](../-component/index.md) + +Gets the specified component from the Model + +#### Return + +a Component object + +#### Parameters + + + +| | | +|---|---| +| name | the component name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-collector-for-data-explorer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-collector-for-data-explorer.md index b35750a033..6061965520 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-collector-for-data-explorer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-collector-for-data-explorer.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getDataCollectorForDataExplorer](get-data-collector-for-data-explorer.md) - -# getDataCollectorForDataExplorer - - -public [getDataCollectorForDataExplorer](get-data-collector-for-data-explorer.md)(dataExplorer: [DataExplorer](../-data-explorer/index.md)): [DataCollector](../-data-collector/index.md) - -Retrieves a DataCollector for the DataExplorer with the specified ID. - -#### Return - -A DataCollector for the DataExplorer with the specified ID - -#### Parameters - - - -| | | -|---|---| -| dataExplorer | The DataExplorer for which to retrieve a DataCollector | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | If something goes wrong in retrieving a DataCollector for the specified DataExplorerID | +# getDataCollectorForDataExplorer + + +public [getDataCollectorForDataExplorer](get-data-collector-for-data-explorer.md)(dataExplorer: [DataExplorer](../-data-explorer/index.md)): [DataCollector](../-data-collector/index.md) + +Retrieves a DataCollector for the DataExplorer with the specified ID. + +#### Return + +A DataCollector for the DataExplorer with the specified ID + +#### Parameters + + + +| | | +|---|---| +| dataExplorer | The DataExplorer for which to retrieve a DataCollector | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | If something goes wrong in retrieving a DataCollector for the specified DataExplorerID | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-collector.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-collector.md index d376dbdfe4..1bb84b8d73 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-collector.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-collector.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getDataCollector](get-data-collector.md) - -# getDataCollector - - -public [getDataCollector](get-data-collector.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [DataCollector](../-data-collector/index.md) +# getDataCollector + + +public [getDataCollector](get-data-collector.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [DataCollector](../-data-collector/index.md) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-explorer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-explorer.md index b11a14d2e3..55fef606a7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-explorer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-explorer.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getDataExplorer](get-data-explorer.md) - -# getDataExplorer - - -public [getDataExplorer](get-data-explorer.md)(id: [Variant](../-variant/index.md)): [DataExplorer](../-data-explorer/index.md) - -gets a specific DataExplorer - -#### Return - -a PHXCOMDataMonitor COM object representing the data monitor control - -#### Parameters - - - -| | | -|---|---| -| id | 0-based index of Data Explorer | +# getDataExplorer + + +public [getDataExplorer](get-data-explorer.md)(id: [Variant](../-variant/index.md)): [DataExplorer](../-data-explorer/index.md) + +gets a specific DataExplorer + +#### Return + +a PHXCOMDataMonitor COM object representing the data monitor control + +#### Parameters + + + +| | | +|---|---| +| id | 0-based index of Data Explorer | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-monitor.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-monitor.md index 7248a5a52b..b6c4a458cd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-monitor.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-monitor.md @@ -1,21 +1,19 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getDataMonitor](get-data-monitor.md) - -# getDataMonitor - - -public [getDataMonitor](get-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Variant](../-variant/index.md)): [DataMonitor](../-data-monitor/index.md) - -gets a specific data monitor associated with a particular component - -#### Return - -a PHXCOMDataMonitor COM object representing the data monitor control - -#### Parameters - - - -| | | -|---|---| -| component | the name of the component under which to search for data monitors | -| index | the integer index (0-based index) or string title of the data monitor being sought | +# getDataMonitor + + +public [getDataMonitor](get-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Variant](../-variant/index.md)): [DataMonitor](../-data-monitor/index.md) + +gets a specific data monitor associated with a particular component + +#### Return + +a PHXCOMDataMonitor COM object representing the data monitor control + +#### Parameters + + + +| | | +|---|---| +| component | the name of the component under which to search for data monitors | +| index | the integer index (0-based index) or string title of the data monitor being sought | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-file-system-info.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-file-system-info.md index 37503a37a3..338d0c79ad 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-file-system-info.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-file-system-info.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getFileSystemInfo](get-file-system-info.md) - -# getFileSystemInfo - - -public [getFileSystemInfo](get-file-system-info.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [FileSystemInfo](../-file-system-info/index.md) - -Gets the FileSystemInfo for a given URI. The URI doesn't necessarily need to exist. - -#### Return - -the FileSystemInfo for the given uri - -#### Parameters - - - -| | | -|---|---| -| uri | the URI of the file to get system info for | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if an error is encountered generating the FileSystemInfo | +# getFileSystemInfo + + +public [getFileSystemInfo](get-file-system-info.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [FileSystemInfo](../-file-system-info/index.md) + +Gets the FileSystemInfo for a given URI. The URI doesn't necessarily need to exist. + +#### Return + +the FileSystemInfo for the given uri + +#### Parameters + + + +| | | +|---|---| +| uri | the URI of the file to get system info for | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if an error is encountered generating the FileSystemInfo | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-formatter.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-formatter.md index 17ce5485b8..bc7841cc2e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-formatter.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-formatter.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getFormatter](get-formatter.md) - -# getFormatter - - -public [getFormatter](get-formatter.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Format](../-format/index.md) - -Gets an instance of a formatter object +# getFormatter + + +public [getFormatter](get-formatter.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Format](../-format/index.md) + +Gets an instance of a formatter object diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-frame.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-frame.md index c231b17265..658d2d1214 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-frame.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-frame.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getFrame](get-frame.md) - -# getFrame - - -public [getFrame](get-frame.md)(): [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html) - -gets a Frame that should be used as the parent for all windows displayed by Java plug-ins. This Frame is not the actual ModelCenter window and should not be used for anything but specifying a parent window. If ModelCenter is running in server mode, this object will be null. - -#### Return - -a JFrame object +# getFrame + + +public [getFrame](get-frame.md)(): [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html) + +gets a Frame that should be used as the parent for all windows displayed by Java plug-ins. This Frame is not the actual ModelCenter window and should not be used for anything but specifying a parent window. If ModelCenter is running in server mode, this object will be null. + +#### Return + +a JFrame object diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-global-parameters.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-global-parameters.md index 94daf3c862..92f03e10be 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-global-parameters.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-global-parameters.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getGlobalParameters](get-global-parameters.md) - -# getGlobalParameters - - -public [getGlobalParameters](get-global-parameters.md)(): [GlobalParameters](../-global-parameters/index.md) - -Gets the list of global parameters +# getGlobalParameters + + +public [getGlobalParameters](get-global-parameters.md)(): [GlobalParameters](../-global-parameters/index.md) + +Gets the list of global parameters diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-halt-status.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-halt-status.md index 41fa6f7db6..987771f296 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-halt-status.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-halt-status.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getHaltStatus](get-halt-status.md) - -# getHaltStatus - - -public [getHaltStatus](get-halt-status.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -checks to see if the halt button has been pressed - -#### Return - -true if the halt button was pressed and the current actions should be halted - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getHaltStatus + + +public [getHaltStatus](get-halt-status.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +checks to see if the halt button has been pressed + +#### Return + +true if the halt button was pressed and the current actions should be halted + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-is-interactive.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-is-interactive.md index 06c75514fa..76fb897ced 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-is-interactive.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-is-interactive.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getIsInteractive](get-is-interactive.md) - -# getIsInteractive - - -public [getIsInteractive](get-is-interactive.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Determine if the current ModelCenter is running interactively - that is, if it has a GUI and a main window. Some methods will not work if the application is running in non-interactive (server or COM) mode. +# getIsInteractive + + +public [getIsInteractive](get-is-interactive.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Determine if the current ModelCenter is running interactively - that is, if it has a GUI and a main window. Some methods will not work if the application is running in non-interactive (server or COM) mode. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-last-error-message.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-last-error-message.md index 06636394d5..e60602a951 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-last-error-message.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-last-error-message.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getLastErrorMessage](get-last-error-message.md) - -# getLastErrorMessage - - -public [getLastErrorMessage](get-last-error-message.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -retrieves the text associated with the last ModelCenter error - -#### Return - -error text - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getLastErrorMessage + + +public [getLastErrorMessage](get-last-error-message.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +retrieves the text associated with the last ModelCenter error + +#### Return + +error text + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-licensing-path.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-licensing-path.md index 637f48d4a1..6850ff3998 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-licensing-path.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-licensing-path.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getLicensingPath](get-licensing-path.md) - -# getLicensingPath - - -public [getLicensingPath](get-licensing-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the ModelCenter licensing path returns ModelCenter licensing path +# getLicensingPath + + +public [getLicensingPath](get-licensing-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the ModelCenter licensing path returns ModelCenter licensing path diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-links.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-links.md index 434b84a94c..ff3d957e3a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-links.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-links.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getLinks](get-links.md) - -# getLinks - - -public [getLinks](get-links.md)(includeReferences: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [VariableLinks](../-variable-links/index.md) - -Retreive a list of all links in a model - -#### Return - -a VariableLinks object encapsulating all the links in the model - -#### Parameters - - - -| | | -|---|---| -| includeReferences | whether or not to include references in the listing | +# getLinks + + +public [getLinks](get-links.md)(includeReferences: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [VariableLinks](../-variable-links/index.md) + +Retreive a list of all links in a model + +#### Return + +a VariableLinks object encapsulating all the links in the model + +#### Parameters + + + +| | | +|---|---| +| includeReferences | whether or not to include references in the listing | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-logger.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-logger.md index bbf56e5b66..3540c4128d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-logger.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-logger.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getLogger](get-logger.md) - -# getLogger - - -public [getLogger](get-logger.md)(): [Logger](../../com.phoenix_int.ModelCenter.logging/-logger/index.md) - -Retrieves a logger. Note that the logger is always associated with the caller component if there is one, otherwise it is associated with the Model component. If there is not model then a logger associated with the application will be returned - -#### Return - -a Logger object - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getLogger + + +public [getLogger](get-logger.md)(): [Logger](../../com.phoenix_int.ModelCenter.logging/-logger/index.md) + +Retrieves a logger. Note that the logger is always associated with the caller component if there is one, otherwise it is associated with the Model component. If there is not model then a logger associated with the application will be returned + +#### Return + +a Logger object + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-macro-script-language.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-macro-script-language.md index 4cd3dc311b..ac456a8c37 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-macro-script-language.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-macro-script-language.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getMacroScriptLanguage](get-macro-script-language.md) - -# getMacroScriptLanguage - - -public [getMacroScriptLanguage](get-macro-script-language.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -get the script language for a macro if the macro exists - -#### Return - -the macro script language - -#### Parameters - - - -| | | -|---|---| -| macroName | the name of the macro | +# getMacroScriptLanguage + + +public [getMacroScriptLanguage](get-macro-script-language.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +get the script language for a macro if the macro exists + +#### Return + +the macro script language + +#### Parameters + + + +| | | +|---|---| +| macroName | the name of the macro | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-macro-script.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-macro-script.md index 14770023bb..3c93105e6b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-macro-script.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-macro-script.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getMacroScript](get-macro-script.md) - -# getMacroScript - - -public [getMacroScript](get-macro-script.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -get the script for a macro if the macro exists - -#### Return - -the macro script - -#### Parameters - - - -| | | -|---|---| -| macroName | the name of the macro | +# getMacroScript + + +public [getMacroScript](get-macro-script.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +get the script for a macro if the macro exists + +#### Return + +the macro script + +#### Parameters + + + +| | | +|---|---| +| macroName | the name of the macro | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-macro-timeout.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-macro-timeout.md index 4cc5eaae3a..fe2aea4144 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-macro-timeout.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-macro-timeout.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getMacroTimeout](get-macro-timeout.md) - -# getMacroTimeout - - -public [getMacroTimeout](get-macro-timeout.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -get the timeout for a macro if the macro exists - -#### Return - -the number of seconds to allow a script to run before canceling it; -1 indicates no timeout - -#### Parameters - - - -| | | -|---|---| -| macroName | the name of the macro | +# getMacroTimeout + + +public [getMacroTimeout](get-macro-timeout.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +get the timeout for a macro if the macro exists + +#### Return + +the number of seconds to allow a script to run before canceling it; -1 indicates no timeout + +#### Parameters + + + +| | | +|---|---| +| macroName | the name of the macro | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model-center-path.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model-center-path.md index 212c34cfdb..143c76d068 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model-center-path.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model-center-path.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getModelCenterPath](get-model-center-path.md) - -# getModelCenterPath - - -public [getModelCenterPath](get-model-center-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Retrieves the install path for ModelCenter. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getModelCenterPath + + +public [getModelCenterPath](get-model-center-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Retrieves the install path for ModelCenter. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model-directory.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model-directory.md index 5f8479f33d..7de990e5c9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model-directory.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model-directory.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getModelDirectory](get-model-directory.md) - -# getModelDirectory - - -public [getModelDirectory](get-model-directory.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the Model directory returns an exception when Model is not open returns an empty string when Model has not been saved +# getModelDirectory + + +public [getModelDirectory](get-model-directory.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the Model directory returns an exception when Model is not open returns an empty string when Model has not been saved diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model-file-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model-file-name.md index 068d9f82f3..b1c638bff7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model-file-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model-file-name.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getModelFileName](get-model-file-name.md) - -# getModelFileName - - -public [getModelFileName](get-model-file-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the Model file name - -#### Return - -Model file name - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getModelFileName + + +public [getModelFileName](get-model-file-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the Model file name + +#### Return + +Model file name + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model.md index 107d0d0908..dde69e0596 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getModel](get-model.md) - -# getModel - - -public [getModel](get-model.md)(): [Assembly](../-assembly/index.md) - -Gets the Model object - -#### Return - -an Assembly object - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getModel + + +public [getModel](get-model.md)(): [Assembly](../-assembly/index.md) + +Gets the Model object + +#### Return + +an Assembly object + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-preference.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-preference.md index 2c69ee12dc..bc6d77e36e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-preference.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-preference.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getPreference](get-preference.md) - -# getPreference - - -public [getPreference](get-preference.md)(prefName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) - -gets a preference - -#### Return - -a preference value - -#### Parameters - - - -| | | -|---|---| -| prefName | the name of the preference | +# getPreference + + +public [getPreference](get-preference.md)(prefName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) + +gets a preference + +#### Return + +a preference value + +#### Parameters + + + +| | | +|---|---| +| prefName | the name of the preference | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-process-i-d.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-process-i-d.md index 85664d32c1..40a326f817 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-process-i-d.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-process-i-d.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getProcessID](get-process-i-d.md) - -# getProcessID - - -public [getProcessID](get-process-i-d.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -Retrieves the process identifier (PID) of the ModelCenter process. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getProcessID + + +public [getProcessID](get-process-i-d.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +Retrieves the process identifier (PID) of the ModelCenter process. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-run-only-mode.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-run-only-mode.md index 653f3c464b..7178207a26 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-run-only-mode.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-run-only-mode.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getRunOnlyMode](get-run-only-mode.md) - -# getRunOnlyMode - - -public [getRunOnlyMode](get-run-only-mode.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Gets the status of ModelCenter being in Run-Only Mode. - -#### Return - -true if ModelCenter is in Run-Only Mode; otherwise, false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getRunOnlyMode + + +public [getRunOnlyMode](get-run-only-mode.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Gets the status of ModelCenter being in Run-Only Mode. + +#### Return + +true if ModelCenter is in Run-Only Mode; otherwise, false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-screen-updating.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-screen-updating.md index cb15401832..8795ac8e8e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-screen-updating.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-screen-updating.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getScreenUpdating](get-screen-updating.md) - -# getScreenUpdating - - -public [getScreenUpdating](get-screen-updating.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -returns the current screen updating flag - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getScreenUpdating + + +public [getScreenUpdating](get-screen-updating.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +returns the current screen updating flag + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-trade-study-filters.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-trade-study-filters.md index f4139355e2..6889af77de 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-trade-study-filters.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-trade-study-filters.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getTradeStudyFilters](get-trade-study-filters.md) - -# getTradeStudyFilters - - -public [getTradeStudyFilters](get-trade-study-filters.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> - -Get the filters for saving Trade Study files (for use in showFileBrowseDialog and showFileSaveDialog) - -#### Return - -the filters for saving Trade Study files - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if an error is encountered getting the trade study filters | +# getTradeStudyFilters + + +public [getTradeStudyFilters](get-trade-study-filters.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> + +Get the filters for saving Trade Study files (for use in showFileBrowseDialog and showFileSaveDialog) + +#### Return + +the filters for saving Trade Study files + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if an error is encountered getting the trade study filters | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-value-absolute.md index ae6600528f..240a013942 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-value-absolute.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getValueAbsolute](get-value-absolute.md) - -# getValueAbsolute - - -public [getValueAbsolute](get-value-absolute.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) - -gets a value for the specified variable without validating it - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| name | the full variable name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValueAbsolute + + +public [getValueAbsolute](get-value-absolute.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) + +gets a value for the specified variable without validating it + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| name | the full variable name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-value.md index 0784d27d13..f1cd66248f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-value.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getValue](get-value.md) - -# getValue - - -public [getValue](get-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) - -gets a value for the specified variable - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| name | the full variable name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValue + + +public [getValue](get-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) + +gets a value for the specified variable + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| name | the full variable name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-variable-meta-data.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-variable-meta-data.md index 4f48c9067e..c1e9cbff51 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-variable-meta-data.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-variable-meta-data.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getVariableMetaData](get-variable-meta-data.md) - -# getVariableMetaData - - -public [getVariableMetaData](get-variable-meta-data.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md) - -Get metadata about the specified variable from the Model. - -#### Return - -a DHVariable object - -#### Parameters - - - -| | | -|---|---| -| name | the variable name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getVariableMetaData + + +public [getVariableMetaData](get-variable-meta-data.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md) + +Get metadata about the specified variable from the Model. + +#### Return + +a DHVariable object + +#### Parameters + + + +| | | +|---|---| +| name | the variable name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-variable.md index 3d0346b530..441d333f2f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-variable.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getVariable](get-variable.md) - -# getVariable - - -public [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) - -Gets the specified variable from the Model - -#### Return - -a Variable object - -#### Parameters - - - -| | | -|---|---| -| name | the variable name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getVariable + + +public [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) + +Gets the specified variable from the Model + +#### Return + +a Variable object + +#### Parameters + + + +| | | +|---|---| +| name | the variable name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-version.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-version.md index 8fb8f08c24..3b21067ecc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-version.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-version.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getVersion](get-version.md) - -# getVersion - - -public [getVersion](get-version.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -Gets the ModelCenter version - -#### Return - -the version number requested - -#### Parameters - - - -| | | -|---|---| -| index | The version item to get:
- 0 - Major version - 1 - Minor version - 2 - Patch version | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getVersion + + +public [getVersion](get-version.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +Gets the ModelCenter version + +#### Return + +the version number requested + +#### Parameters + + + +| | | +|---|---| +| index | The version item to get:
- 0 - Major version - 1 - Minor version - 2 - Patch version | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-x-m-l-extension.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-x-m-l-extension.md index a8ee0d4085..bcee5d266e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-x-m-l-extension.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/get-x-m-l-extension.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[getXMLExtension](get-x-m-l-extension.md) - -# getXMLExtension - - -public [getXMLExtension](get-x-m-l-extension.md)(nodeName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), attributeName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), attributeValue: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -For internal use only. +# getXMLExtension + + +public [getXMLExtension](get-x-m-l-extension.md)(nodeName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), attributeName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), attributeValue: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +For internal use only. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/gui-close-all-multiplexers.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/gui-close-all-multiplexers.md index 7071eeeb34..c1728e3e0d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/gui-close-all-multiplexers.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/gui-close-all-multiplexers.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[guiCloseAllMultiplexers](gui-close-all-multiplexers.md) - -# guiCloseAllMultiplexers - - -public [guiCloseAllMultiplexers](gui-close-all-multiplexers.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Attempts to close the DataExplorers of all vizualization multiplexers. +# guiCloseAllMultiplexers + + +public [guiCloseAllMultiplexers](gui-close-all-multiplexers.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Attempts to close the DataExplorers of all vizualization multiplexers. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/gui-load-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/gui-load-file.md index b87140aa09..07c958543b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/gui-load-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/gui-load-file.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[guiLoadFile](gui-load-file.md) - -# guiLoadFile - - -public [guiLoadFile](gui-load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Loads a file in "GUI" mode, that is, unlike loadFile(...), will produce a prompt to the user to verify whether or not any currently opened model should be saved prior to loading the given file. - -#### Return - -false if the save was cancelled; true otherwise - -#### Parameters - - - -| | | -|---|---| -| modelFile | Path of the file to load. | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if something goes wrong loading the file | +# guiLoadFile + + +public [guiLoadFile](gui-load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Loads a file in "GUI" mode, that is, unlike loadFile(...), will produce a prompt to the user to verify whether or not any currently opened model should be saved prior to loading the given file. + +#### Return + +false if the save was cancelled; true otherwise + +#### Parameters + + + +| | | +|---|---| +| modelFile | Path of the file to load. | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if something goes wrong loading the file | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/gui-save-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/gui-save-model.md index b30076adbf..885fb7d428 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/gui-save-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/gui-save-model.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[guiSaveModel](gui-save-model.md) - -# guiSaveModel - - -public [guiSaveModel](gui-save-model.md)() - -Saves a file in "GUI" mode, which will pop up a dialog if the file has not yet been saved. - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if there is an error while saving the file | +# guiSaveModel + + +public [guiSaveModel](gui-save-model.md)() + +Saves a file in "GUI" mode, which will pop up a dialog if the file has not yet been saved. + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if there is an error while saving the file | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/halt.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/halt.md index f396c9d342..9b45e1192e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/halt.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/halt.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[halt](halt.md) - -# halt - - -public [halt](halt.md)() - -Halts any running trade studies +# halt + + +public [halt](halt.md)() + +Halts any running trade studies diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/hide-plug-in-frame.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/hide-plug-in-frame.md index d96bf6e22c..305fd96566 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/hide-plug-in-frame.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/hide-plug-in-frame.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[hidePlugInFrame](hide-plug-in-frame.md) - -# hidePlugInFrame - - -public [hidePlugInFrame](hide-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -Hides the frame window which the java plugin is embedded in - -#### Parameters - - - -| | | -|---|---| -| hwnd | handle to the frame window CWnd | +# hidePlugInFrame + + +public [hidePlugInFrame](hide-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +Hides the frame window which the java plugin is embedded in + +#### Parameters + + + +| | | +|---|---| +| hwnd | handle to the frame window CWnd | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/index.md index d412a73967..8843a886f9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/index.md @@ -1,187 +1,185 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md) - -# ModelCenter - - -public class [ModelCenter](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [IModelCenter](../-i-model-center/index.md) - -This is the wrapper class that handles the native COM calls to ModelCenter. The class is used by Java plug-ins to ModelCenter or by stand-alone Java programs to interact with ModelCenter. - - Example: - -```kotlin - -try -{ - ModelCenter mc = new ModelCenter(); - mc.loadModel( "d:\\test.pxc" ); - - for ( int x = 0; x < 10; x++ ) - { - System.out.print( "x = " + x ); - mc.setValue( "Model.Script.x", "" + x ); - System.out.println( ", y = " + mc.getValue( "Model.Script.y" ) ); - } - - mc.close(); -} -catch ( ModelCenterException e ) -{ - e.printStackTrace(); -} - -``` - -#### Author - -Woyak, 9-01 - -## Constructors - -| | | -|---|---| -| [ModelCenter](-model-center.md) | constructor()
default constructor.
constructor(optionStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
default constructor.
constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), f: [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html))
Connects this Java object to the specified session of ModelCenter.
constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), f: [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Connects this Java object to the specified session of ModelCenter. | - -## Types - -| Name | Summary | -|---|---| -| [AssemblyStyle](-assembly-style/index.md) | enum [AssemblyStyle](-assembly-style/index.md)
Ways to display an assembly. | -| [AssemblyStyleInfo](-assembly-style-info/index.md) | public class [AssemblyStyleInfo](-assembly-style-info/index.md)
Information about an assembly's visual style. | -| [VersionStatus](-version-status/index.md) | enum [VersionStatus](-version-status/index.md)
Ways to version a file | - -## Properties - -| Name | Summary | -|---|---| -| [ASSEMBLY_TYPE_ASSEMBLY](-a-s-s-e-m-b-l-y_-t-y-p-e_-a-s-s-e-m-b-l-y.md) | val [ASSEMBLY_TYPE_ASSEMBLY](-a-s-s-e-m-b-l-y_-t-y-p-e_-a-s-s-e-m-b-l-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Assembly" | -| [ASSEMBLY_TYPE_FOR_EACH](-a-s-s-e-m-b-l-y_-t-y-p-e_-f-o-r_-e-a-c-h.md) | val [ASSEMBLY_TYPE_FOR_EACH](-a-s-s-e-m-b-l-y_-t-y-p-e_-f-o-r_-e-a-c-h.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ForEach" | -| [ASSEMBLY_TYPE_IF](-a-s-s-e-m-b-l-y_-t-y-p-e_-i-f.md) | val [ASSEMBLY_TYPE_IF](-a-s-s-e-m-b-l-y_-t-y-p-e_-i-f.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "If" | -| [ASSEMBLY_TYPE_PARALLEL](-a-s-s-e-m-b-l-y_-t-y-p-e_-p-a-r-a-l-l-e-l.md) | val [ASSEMBLY_TYPE_PARALLEL](-a-s-s-e-m-b-l-y_-t-y-p-e_-p-a-r-a-l-l-e-l.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Parallel" | -| [ASSEMBLY_TYPE_SEQUENCE](-a-s-s-e-m-b-l-y_-t-y-p-e_-s-e-q-u-e-n-c-e.md) | val [ASSEMBLY_TYPE_SEQUENCE](-a-s-s-e-m-b-l-y_-t-y-p-e_-s-e-q-u-e-n-c-e.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Sequence" | -| [CONN_ERR_ERROR](-c-o-n-n_-e-r-r_-e-r-r-o-r.md) | val [CONN_ERR_ERROR](-c-o-n-n_-e-r-r_-e-r-r-o-r.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 3 | -| [CONN_ERR_IGNORE](-c-o-n-n_-e-r-r_-i-g-n-o-r-e.md) | val [CONN_ERR_IGNORE](-c-o-n-n_-e-r-r_-i-g-n-o-r-e.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 1 | -| [CONN_ERR_USEDIALOG](-c-o-n-n_-e-r-r_-u-s-e-d-i-a-l-o-g.md) | val [CONN_ERR_USEDIALOG](-c-o-n-n_-e-r-r_-u-s-e-d-i-a-l-o-g.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = -1 | -| [MODEL_TYPE_DATA](-m-o-d-e-l_-t-y-p-e_-d-a-t-a.md) | val [MODEL_TYPE_DATA](-m-o-d-e-l_-t-y-p-e_-d-a-t-a.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "dataModel" | -| [MODEL_TYPE_PROCESS](-m-o-d-e-l_-t-y-p-e_-p-r-o-c-e-s-s.md) | val [MODEL_TYPE_PROCESS](-m-o-d-e-l_-t-y-p-e_-p-r-o-c-e-s-s.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "processModel" | - -## Functions - -| Name | Summary | -|---|---| -| [addIcon](add-icon.md) | public [addIcon](add-icon.md)(iconFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Registers an icon with ModelCenter. | -| [addNewMacro](add-new-macro.md) | public [addNewMacro](add-new-macro.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isAppMacro: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
adds a new Macro to ModelCenter's macro facility | -| [allowBringWindowToFront](allow-bring-window-to-front.md) | public [allowBringWindowToFront](allow-bring-window-to-front.md)(processID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Use OS calls to allow another process to bring a window to the front. | -| [autoLink](auto-link.md) | public [autoLink](auto-link.md)(srcComp: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), destComp: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
auto links the variables of two Components | -| [breakLink](break-link.md) | public [breakLink](break-link.md)(variable: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Breaks the link of a specified variable | -| [checkout](checkout.md) | public [checkout](checkout.md)(feature: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Feature](../-feature/index.md)
Should check out a license feature from Ansys | -| [checkout2](checkout2.md) | public [checkout2](checkout2.md)(feature: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), productRelease: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Feature](../-feature/index.md)
Should check out a license feature from Ansys | -| [close](close.md) | public [close](close.md)()
closes ModelCenter. | -| [closeHTMLViewer](close-h-t-m-l-viewer.md) | public [closeHTMLViewer](close-h-t-m-l-viewer.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
closes the HTMLViewer embedded browser tool | -| [closeModel](close-model.md) | public [closeModel](close-model.md)()
closes the model within ModelCenter | -| [createAndInitComponent](create-and-init-component.md) | public [createAndInitComponent](create-and-init-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), initString: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Component](../-component/index.md)
Creates a new component and initializes it from string data. | -| [createAssembly](create-assembly.md) | public [createAssembly](create-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md)
public [createAssembly](create-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), assemblyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md)
creates an assembly | -| [createAssemblyVariable](create-assembly-variable.md) | public [createAssemblyVariable](create-assembly-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
creates an assembly variable | -| [createComponent](create-component.md) | public [createComponent](create-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [createComponent](create-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Instantiates a new component into the Model | -| [createDataCollector](create-data-collector.md) | public [~~createDataCollector~~](create-data-collector.md)(tradeStudyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DataCollector](../-data-collector/index.md)
creates a Data Collector for storing and displaying data | -| [createDataExplorer](create-data-explorer.md) | public [createDataExplorer](create-data-explorer.md)(tradeStudyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DataExplorer](../-data-explorer/index.md)
creates a Data Explorer for storing and displaying data | -| [createDataHistoryVariable](create-data-history-variable.md) | public [createDataHistoryVariable](create-data-history-variable.md)(): [DHVariable](../-d-h-variable/index.md)
Creates a new DHVariable instance. | -| [createDataMonitor](create-data-monitor.md) | public [createDataMonitor](create-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), x: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), y: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [DataMonitor](../-data-monitor/index.md)
create a data monitor and associate it with a particular component | -| [createJobManager](create-job-manager.md) | public [createJobManager](create-job-manager.md)(): [JobManager](../-job-manager/index.md)
creates a JobManager object for performing trade study runs
public [createJobManager](create-job-manager.md)(showProgressDialog: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [JobManager](../-job-manager/index.md)
public [createJobManager](create-job-manager.md)(progressDialogParent: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [JobManager](../-job-manager/index.md)
Creates a JobManager for performing trade study runs. | -| [createLink](create-link.md) | public [createLink](create-link.md)(varName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Creates a new link | -| [createPlugInFrame](create-plug-in-frame.md) | public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Create a frame window in which to embed the java plug-in
public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), defWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), defHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), defWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), defHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), minWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), minHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | -| [createTradeStudy](create-trade-study.md) | public [createTradeStudy](create-trade-study.md)(idStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [TradeStudy](../-trade-study/index.md)
Creates the specified trade study and returns a handle to it. | -| [destroyPlugInFrame](destroy-plug-in-frame.md) | public [destroyPlugInFrame](destroy-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Destroys the frame window which the java plug-in is embedded in | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [dumpComDebug](dump-com-debug.md) | public [dumpComDebug](dump-com-debug.md)()
Dumps COM debugging information on the ModelCenter process side; only has an effect if ModelCenter is compiled in Debug mode. | -| [getActiveJobManager](get-active-job-manager.md) | public [getActiveJobManager](get-active-job-manager.md)(): [JobManager](../-job-manager/index.md)
Gets the Job Manager associated with the currently running trade study. | -| [getAppName](get-app-name.md) | public [getAppName](get-app-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Application name | -| [getAssembly](get-assembly.md) | public [getAssembly](get-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md)
Gets the specified assembly from the model. | -| [getAssemblyStyle](get-assembly-style.md) | public [getAssemblyStyle](get-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [ModelCenter.AssemblyStyleInfo](-assembly-style-info/index.md)
Get the visual style of an assembly. | -| [getComponent](get-component.md) | public [getComponent](get-component.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Component](../-component/index.md)
Gets the specified component from the Model | -| [getDataCollector](get-data-collector.md) | public [getDataCollector](get-data-collector.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [DataCollector](../-data-collector/index.md) | -| [getDataCollectorForDataExplorer](get-data-collector-for-data-explorer.md) | public [getDataCollectorForDataExplorer](get-data-collector-for-data-explorer.md)(dataExplorer: [DataExplorer](../-data-explorer/index.md)): [DataCollector](../-data-collector/index.md)
Retrieves a DataCollector for the DataExplorer with the specified ID. | -| [getDataExplorer](get-data-explorer.md) | public [getDataExplorer](get-data-explorer.md)(id: [Variant](../-variant/index.md)): [DataExplorer](../-data-explorer/index.md)
gets a specific DataExplorer | -| [getDataMonitor](get-data-monitor.md) | public [getDataMonitor](get-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Variant](../-variant/index.md)): [DataMonitor](../-data-monitor/index.md)
gets a specific data monitor associated with a particular component | -| [getFileSystemInfo](get-file-system-info.md) | public [getFileSystemInfo](get-file-system-info.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [FileSystemInfo](../-file-system-info/index.md)
Gets the FileSystemInfo for a given URI. | -| [getFormatter](get-formatter.md) | public [getFormatter](get-formatter.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Format](../-format/index.md)
Gets an instance of a formatter object | -| [getFrame](get-frame.md) | public [getFrame](get-frame.md)(): [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html)
gets a Frame that should be used as the parent for all windows displayed by Java plug-ins. | -| [getGlobalParameters](get-global-parameters.md) | public [getGlobalParameters](get-global-parameters.md)(): [GlobalParameters](../-global-parameters/index.md)
Gets the list of global parameters | -| [getHaltStatus](get-halt-status.md) | public [getHaltStatus](get-halt-status.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks to see if the halt button has been pressed | -| [getIsInteractive](get-is-interactive.md) | public [getIsInteractive](get-is-interactive.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determine if the current ModelCenter is running interactively - that is, if it has a GUI and a main window. | -| [getLastErrorMessage](get-last-error-message.md) | public [getLastErrorMessage](get-last-error-message.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
retrieves the text associated with the last ModelCenter error | -| [getLicensingPath](get-licensing-path.md) | public [getLicensingPath](get-licensing-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the ModelCenter licensing path returns ModelCenter licensing path | -| [getLinks](get-links.md) | public [getLinks](get-links.md)(includeReferences: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [VariableLinks](../-variable-links/index.md)
Retreive a list of all links in a model | -| [getLogger](get-logger.md) | public [getLogger](get-logger.md)(): [Logger](../../com.phoenix_int.ModelCenter.logging/-logger/index.md)
Retrieves a logger. | -| [getMacroScript](get-macro-script.md) | public [getMacroScript](get-macro-script.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the script for a macro if the macro exists | -| [getMacroScriptLanguage](get-macro-script-language.md) | public [getMacroScriptLanguage](get-macro-script-language.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the script language for a macro if the macro exists | -| [getMacroTimeout](get-macro-timeout.md) | public [getMacroTimeout](get-macro-timeout.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
get the timeout for a macro if the macro exists | -| [getModel](get-model.md) | public [getModel](get-model.md)(): [Assembly](../-assembly/index.md)
Gets the Model object | -| [getModelCenterPath](get-model-center-path.md) | public [getModelCenterPath](get-model-center-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Retrieves the install path for ModelCenter. | -| [getModelDirectory](get-model-directory.md) | public [getModelDirectory](get-model-directory.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Model directory returns an exception when Model is not open returns an empty string when Model has not been saved | -| [getModelFileName](get-model-file-name.md) | public [getModelFileName](get-model-file-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Model file name | -| [getPreference](get-preference.md) | public [getPreference](get-preference.md)(prefName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
gets a preference | -| [getProcessID](get-process-i-d.md) | public [getProcessID](get-process-i-d.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Retrieves the process identifier (PID) of the ModelCenter process. | -| [getRunOnlyMode](get-run-only-mode.md) | public [getRunOnlyMode](get-run-only-mode.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets the status of ModelCenter being in Run-Only Mode. | -| [getScreenUpdating](get-screen-updating.md) | public [getScreenUpdating](get-screen-updating.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
returns the current screen updating flag | -| [getTradeStudyFilters](get-trade-study-filters.md) | public [getTradeStudyFilters](get-trade-study-filters.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>
Get the filters for saving Trade Study files (for use in showFileBrowseDialog and showFileSaveDialog) | -| [getValue](get-value.md) | public [getValue](get-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
gets a value for the specified variable | -| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
gets a value for the specified variable without validating it | -| [getVariable](get-variable.md) | public [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
Gets the specified variable from the Model | -| [getVariableMetaData](get-variable-meta-data.md) | public [getVariableMetaData](get-variable-meta-data.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md)
Get metadata about the specified variable from the Model. | -| [getVersion](get-version.md) | public [getVersion](get-version.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the ModelCenter version | -| [getXMLExtension](get-x-m-l-extension.md) | public [getXMLExtension](get-x-m-l-extension.md)(nodeName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), attributeName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), attributeValue: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
For internal use only. | -| [guiCloseAllMultiplexers](gui-close-all-multiplexers.md) | public [guiCloseAllMultiplexers](gui-close-all-multiplexers.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Attempts to close the DataExplorers of all vizualization multiplexers. | -| [guiLoadFile](gui-load-file.md) | public [guiLoadFile](gui-load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Loads a file in "GUI" mode, that is, unlike loadFile(...), will produce a prompt to the user to verify whether or not any currently opened model should be saved prior to loading the given file. | -| [guiSaveModel](gui-save-model.md) | public [guiSaveModel](gui-save-model.md)()
Saves a file in "GUI" mode, which will pop up a dialog if the file has not yet been saved. | -| [halt](halt.md) | public [halt](halt.md)()
Halts any running trade studies | -| [hidePlugInFrame](hide-plug-in-frame.md) | public [hidePlugInFrame](hide-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Hides the frame window which the java plugin is embedded in | -| [HTMLViewerWaitForClose](-h-t-m-l-viewer-wait-for-close.md) | public [HTMLViewerWaitForClose](-h-t-m-l-viewer-wait-for-close.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
waits for the HTMLViewer embedded browser tool to close | -| [internalLicensing](internal-licensing.md) | public [internalLicensing](internal-licensing.md)(one: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), two: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
For internal use only | -| [invokeHelp](invoke-help.md) | public [invokeHelp](invoke-help.md)(helpID: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Display a topic in ModelCenter's help system | -| [isOkToClose](is-ok-to-close.md) | public [isOkToClose](is-ok-to-close.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determine whether it's ok to shutdown ModelCenter or whether there are still windows open | -| [launchDataCollectorPlugIn](launch-data-collector-plug-in.md) | public [launchDataCollectorPlugIn](launch-data-collector-plug-in.md)(plugInName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), dataExplorer: [DataExplorer](../-data-explorer/index.md))
Launches a specific Data Collector PlugIn, by name, on the specified Data Explorer. | -| [launchHTMLViewer](launch-h-t-m-l-viewer.md) | public [launchHTMLViewer](launch-h-t-m-l-viewer.md)(url: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), popup: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
starts the HTMLViewer embedded browser tool | -| [launchMacroEditor](launch-macro-editor.md) | public [launchMacroEditor](launch-macro-editor.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
launches the macro editor, displays the macro scrip if it exists | -| [launchTradeStudy](launch-trade-study.md) | public [launchTradeStudy](launch-trade-study.md)(idStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Launches the specified trade study. | -| [loadFile](load-file.md) | public [loadFile](load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [loadFile](load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), connectErrorMode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
opens the specified Model | -| [loadModel](load-model.md) | public [loadModel](load-model.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [loadModel](load-model.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), connectErrorMode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
opens the specified Model | -| [MessageBox](-message-box.md) | public [MessageBox](-message-box.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
displays a Windows Message Box | -| [moveComponent](move-component.md) | public [moveComponent](move-component.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Moves a component. | -| [newInstance](new-instance.md) | public [newInstance](new-instance.md)(): [ModelCenter](index.md)
creates a new ModelCenter object (that is connected to the same ModelCenter session) that is not currently attached to any thread. | -| [newModel](new-model.md) | public [newModel](new-model.md)()
loads ModelCenter with a new, empty Model (data dependency model - MODEL_TYPE_DATA)
public [newModel](new-model.md)(modelType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
loads ModelCenter with a new, empty Model | -| [parallelInstance](parallel-instance.md) | public [parallelInstance](parallel-instance.md)(): [ModelCenter](index.md)
For internal use only | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [removeComponent](remove-component.md) | public [removeComponent](remove-component.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Removes a specified component | -| [removeDataMonitor](remove-data-monitor.md) | public [removeDataMonitor](remove-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Variant](../-variant/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
remove a specific data monitor associated with a particular component | -| [run](run.md) | public [run](run.md)(variableArray: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
A comma-separated list of ModelCenter variables to validate. | -| [runAntFile](run-ant-file.md) | public [runAntFile](run-ant-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
runs an ANT testing file | -| [runMacro](run-macro.md) | public [runMacro](run-macro.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
runs a macro | -| [runMacro2](run-macro2.md) | public [runMacro2](run-macro2.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
runs a macro and passes the current modelCenter object to the script (i.e. | -| [saveModel](save-model.md) | public [saveModel](save-model.md)()
saves the current Model with it's existing file name | -| [saveModelAs](save-model-as.md) | public [saveModelAs](save-model-as.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
saves the current Model with the specified file name | -| [saveTradeStudy](save-trade-study.md) | public [saveTradeStudy](save-trade-study.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileType: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), dataExplorer: [DataExplorer](../-data-explorer/index.md))
Save the trade study inside of the Data Explorer | -| [saveVersionedModel](save-versioned-model.md) | public [saveVersionedModel](save-versioned-model.md)(versionStatus: [ModelCenter.VersionStatus](-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
saves the current Model with it's existing file name | -| [saveVersionedModelAs](save-versioned-model-as.md) | public [saveVersionedModelAs](save-versioned-model-as.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), versionStatus: [ModelCenter.VersionStatus](-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
saves the current Model with the specified file name | -| [setAssemblyStyle](set-assembly-style.md) | public [setAssemblyStyle](set-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), style: [ModelCenter.AssemblyStyle](-assembly-style/index.md))
Set the visual style of an assembly.
public [setAssemblyStyle](set-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), style: [ModelCenter.AssemblyStyle](-assembly-style/index.md), width: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), height: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Set the visual style of an assembly including (optionally) width and height. | -| [setIconPlugInFrame](set-icon-plug-in-frame.md) | public [setIconPlugInFrame](set-icon-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), iconFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the icon for the frame window which the java plugin is embedded in | -| [setLoginCallback](set-login-callback.md) | public [setLoginCallback](set-login-callback.md)(callback: [ILoginCallback](../-i-login-callback/index.md))
Set the login callback to use | -| [setMacroScript](set-macro-script.md) | public [setMacroScript](set-macro-script.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), script: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set the script for a macro if the macro exists | -| [setMacroScriptLanguage](set-macro-script-language.md) | public [setMacroScriptLanguage](set-macro-script-language.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), language: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set the script lancuage for a macro if the macro exists | -| [setMacroTimeout](set-macro-timeout.md) | public [setMacroTimeout](set-macro-timeout.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), timeout: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
sets the timeout for a macro if the macro exists | -| [setPassword](set-password.md) | public [setPassword](set-password.md)(password: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the global default password combination in ModelCenter | -| [setPreference](set-preference.md) | public [setPreference](set-preference.md)(prefName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets a preference | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setRunOnlyMode](set-run-only-mode.md) | public [setRunOnlyMode](set-run-only-mode.md)(shouldBeInRunOnly: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets the status of ModelCenter being in Run-Only Mode to the specified value. | -| [setScheduler](set-scheduler.md) | public [setScheduler](set-scheduler.md)(scheduler: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the appropriate schdeuler. | -| [setScreenUpdating](set-screen-updating.md) | public [setScreenUpdating](set-screen-updating.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets a flag indicating if the ModelCenter window should update due to Model changes. | -| [setUserName](set-user-name.md) | public [setUserName](set-user-name.md)(username: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the global default username combination in ModelCenter | -| [setValue](set-value.md) | public [setValue](set-value.md)(varName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value for the specified variable | -| [setXMLExtension](set-x-m-l-extension.md) | public [setXMLExtension](set-x-m-l-extension.md)(xml: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
For internal use only. | -| [showFileBrowseDialog](show-file-browse-dialog.md) | public [showFileBrowseDialog](show-file-browse-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [showFileBrowseDialog](show-file-browse-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Displays file selection dialog for loading and returns URL of selected file. | -| [showFileSaveDialog](show-file-save-dialog.md) | public [showFileSaveDialog](show-file-save-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), selectedFilter: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html)>, initialFileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Displays file selection dialog for saving and returns URL of selected file. | -| [showPlugInFrame](show-plug-in-frame.md) | public [showPlugInFrame](show-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Shows the frame window which the java plugin is embedded in | -| [startGUIMode](start-g-u-i-mode.md) | public [startGUIMode](start-g-u-i-mode.md)(showDialogs: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
THIS FUNCTION IS A BETA CAPABILITY Normally when invoked via COM, ModelCenter is in "server" mode and it hides all GUI and dialogs. | -| [tradeStudyEnd](trade-study-end.md) | public [tradeStudyEnd](trade-study-end.md)()
lets ModelCenter know that a trade study is ending | -| [tradeStudyStart](trade-study-start.md) | public [tradeStudyStart](trade-study-start.md)()
lets ModelCenter know that a trade study is beginning | +# ModelCenter + + +public class [ModelCenter](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [IModelCenter](../-i-model-center/index.md) + +This is the wrapper class that handles the native COM calls to ModelCenter. The class is used by Java plug-ins to ModelCenter or by stand-alone Java programs to interact with ModelCenter. + + Example: + +```kotlin + +try +{ + ModelCenter mc = new ModelCenter(); + mc.loadModel( "d:\\test.pxc" ); + + for ( int x = 0; x < 10; x++ ) + { + System.out.print( "x = " + x ); + mc.setValue( "Model.Script.x", "" + x ); + System.out.println( ", y = " + mc.getValue( "Model.Script.y" ) ); + } + + mc.close(); +} +catch ( ModelCenterException e ) +{ + e.printStackTrace(); +} + +``` + +#### Author + +Woyak, 9-01 + +## Constructors + +| | | +|---|---| +| [ModelCenter](-model-center.md) | constructor()
default constructor.
constructor(optionStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
default constructor.
constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), f: [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html))
Connects this Java object to the specified session of ModelCenter.
constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), f: [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Connects this Java object to the specified session of ModelCenter. | + +## Types + +| Name | Summary | +|---|---| +| [AssemblyStyle](-assembly-style/index.md) | enum [AssemblyStyle](-assembly-style/index.md)
Ways to display an assembly. | +| [AssemblyStyleInfo](-assembly-style-info/index.md) | public class [AssemblyStyleInfo](-assembly-style-info/index.md)
Information about an assembly's visual style. | +| [VersionStatus](-version-status/index.md) | enum [VersionStatus](-version-status/index.md)
Ways to version a file | + +## Properties + +| Name | Summary | +|---|---| +| [ASSEMBLY_TYPE_ASSEMBLY](-a-s-s-e-m-b-l-y_-t-y-p-e_-a-s-s-e-m-b-l-y.md) | val [ASSEMBLY_TYPE_ASSEMBLY](-a-s-s-e-m-b-l-y_-t-y-p-e_-a-s-s-e-m-b-l-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Assembly" | +| [ASSEMBLY_TYPE_FOR_EACH](-a-s-s-e-m-b-l-y_-t-y-p-e_-f-o-r_-e-a-c-h.md) | val [ASSEMBLY_TYPE_FOR_EACH](-a-s-s-e-m-b-l-y_-t-y-p-e_-f-o-r_-e-a-c-h.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ForEach" | +| [ASSEMBLY_TYPE_IF](-a-s-s-e-m-b-l-y_-t-y-p-e_-i-f.md) | val [ASSEMBLY_TYPE_IF](-a-s-s-e-m-b-l-y_-t-y-p-e_-i-f.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "If" | +| [ASSEMBLY_TYPE_PARALLEL](-a-s-s-e-m-b-l-y_-t-y-p-e_-p-a-r-a-l-l-e-l.md) | val [ASSEMBLY_TYPE_PARALLEL](-a-s-s-e-m-b-l-y_-t-y-p-e_-p-a-r-a-l-l-e-l.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Parallel" | +| [ASSEMBLY_TYPE_SEQUENCE](-a-s-s-e-m-b-l-y_-t-y-p-e_-s-e-q-u-e-n-c-e.md) | val [ASSEMBLY_TYPE_SEQUENCE](-a-s-s-e-m-b-l-y_-t-y-p-e_-s-e-q-u-e-n-c-e.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Sequence" | +| [CONN_ERR_ERROR](-c-o-n-n_-e-r-r_-e-r-r-o-r.md) | val [CONN_ERR_ERROR](-c-o-n-n_-e-r-r_-e-r-r-o-r.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 3 | +| [CONN_ERR_IGNORE](-c-o-n-n_-e-r-r_-i-g-n-o-r-e.md) | val [CONN_ERR_IGNORE](-c-o-n-n_-e-r-r_-i-g-n-o-r-e.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 1 | +| [CONN_ERR_USEDIALOG](-c-o-n-n_-e-r-r_-u-s-e-d-i-a-l-o-g.md) | val [CONN_ERR_USEDIALOG](-c-o-n-n_-e-r-r_-u-s-e-d-i-a-l-o-g.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = -1 | +| [MODEL_TYPE_DATA](-m-o-d-e-l_-t-y-p-e_-d-a-t-a.md) | val [MODEL_TYPE_DATA](-m-o-d-e-l_-t-y-p-e_-d-a-t-a.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "dataModel" | +| [MODEL_TYPE_PROCESS](-m-o-d-e-l_-t-y-p-e_-p-r-o-c-e-s-s.md) | val [MODEL_TYPE_PROCESS](-m-o-d-e-l_-t-y-p-e_-p-r-o-c-e-s-s.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "processModel" | + +## Functions + +| Name | Summary | +|---|---| +| [addIcon](add-icon.md) | public [addIcon](add-icon.md)(iconFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Registers an icon with ModelCenter. | +| [addNewMacro](add-new-macro.md) | public [addNewMacro](add-new-macro.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isAppMacro: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
adds a new Macro to ModelCenter's macro facility | +| [allowBringWindowToFront](allow-bring-window-to-front.md) | public [allowBringWindowToFront](allow-bring-window-to-front.md)(processID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Use OS calls to allow another process to bring a window to the front. | +| [autoLink](auto-link.md) | public [autoLink](auto-link.md)(srcComp: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), destComp: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
auto links the variables of two Components | +| [breakLink](break-link.md) | public [breakLink](break-link.md)(variable: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Breaks the link of a specified variable | +| [checkout](checkout.md) | public [checkout](checkout.md)(feature: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Feature](../-feature/index.md)
Should check out a license feature from Ansys | +| [checkout2](checkout2.md) | public [checkout2](checkout2.md)(feature: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), productRelease: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Feature](../-feature/index.md)
Should check out a license feature from Ansys | +| [close](close.md) | public [close](close.md)()
closes ModelCenter. | +| [closeHTMLViewer](close-h-t-m-l-viewer.md) | public [closeHTMLViewer](close-h-t-m-l-viewer.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
closes the HTMLViewer embedded browser tool | +| [closeModel](close-model.md) | public [closeModel](close-model.md)()
closes the model within ModelCenter | +| [createAndInitComponent](create-and-init-component.md) | public [createAndInitComponent](create-and-init-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), initString: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Component](../-component/index.md)
Creates a new component and initializes it from string data. | +| [createAssembly](create-assembly.md) | public [createAssembly](create-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md)
public [createAssembly](create-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), assemblyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md)
creates an assembly | +| [createAssemblyVariable](create-assembly-variable.md) | public [createAssemblyVariable](create-assembly-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
creates an assembly variable | +| [createComponent](create-component.md) | public [createComponent](create-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [createComponent](create-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Instantiates a new component into the Model | +| [createDataCollector](create-data-collector.md) | public [~~createDataCollector~~](create-data-collector.md)(tradeStudyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DataCollector](../-data-collector/index.md)
creates a Data Collector for storing and displaying data | +| [createDataExplorer](create-data-explorer.md) | public [createDataExplorer](create-data-explorer.md)(tradeStudyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DataExplorer](../-data-explorer/index.md)
creates a Data Explorer for storing and displaying data | +| [createDataHistoryVariable](create-data-history-variable.md) | public [createDataHistoryVariable](create-data-history-variable.md)(): [DHVariable](../-d-h-variable/index.md)
Creates a new DHVariable instance. | +| [createDataMonitor](create-data-monitor.md) | public [createDataMonitor](create-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), x: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), y: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [DataMonitor](../-data-monitor/index.md)
create a data monitor and associate it with a particular component | +| [createJobManager](create-job-manager.md) | public [createJobManager](create-job-manager.md)(): [JobManager](../-job-manager/index.md)
creates a JobManager object for performing trade study runs
public [createJobManager](create-job-manager.md)(showProgressDialog: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [JobManager](../-job-manager/index.md)
public [createJobManager](create-job-manager.md)(progressDialogParent: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [JobManager](../-job-manager/index.md)
Creates a JobManager for performing trade study runs. | +| [createLink](create-link.md) | public [createLink](create-link.md)(varName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Creates a new link | +| [createPlugInFrame](create-plug-in-frame.md) | public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Create a frame window in which to embed the java plug-in
public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), defWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), defHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), defWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), defHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), minWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), minHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | +| [createTradeStudy](create-trade-study.md) | public [createTradeStudy](create-trade-study.md)(idStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [TradeStudy](../-trade-study/index.md)
Creates the specified trade study and returns a handle to it. | +| [destroyPlugInFrame](destroy-plug-in-frame.md) | public [destroyPlugInFrame](destroy-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Destroys the frame window which the java plug-in is embedded in | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [dumpComDebug](dump-com-debug.md) | public [dumpComDebug](dump-com-debug.md)()
Dumps COM debugging information on the ModelCenter process side; only has an effect if ModelCenter is compiled in Debug mode. | +| [getActiveJobManager](get-active-job-manager.md) | public [getActiveJobManager](get-active-job-manager.md)(): [JobManager](../-job-manager/index.md)
Gets the Job Manager associated with the currently running trade study. | +| [getAppName](get-app-name.md) | public [getAppName](get-app-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Application name | +| [getAssembly](get-assembly.md) | public [getAssembly](get-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](../-assembly/index.md)
Gets the specified assembly from the model. | +| [getAssemblyStyle](get-assembly-style.md) | public [getAssemblyStyle](get-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [ModelCenter.AssemblyStyleInfo](-assembly-style-info/index.md)
Get the visual style of an assembly. | +| [getComponent](get-component.md) | public [getComponent](get-component.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Component](../-component/index.md)
Gets the specified component from the Model | +| [getDataCollector](get-data-collector.md) | public [getDataCollector](get-data-collector.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [DataCollector](../-data-collector/index.md) | +| [getDataCollectorForDataExplorer](get-data-collector-for-data-explorer.md) | public [getDataCollectorForDataExplorer](get-data-collector-for-data-explorer.md)(dataExplorer: [DataExplorer](../-data-explorer/index.md)): [DataCollector](../-data-collector/index.md)
Retrieves a DataCollector for the DataExplorer with the specified ID. | +| [getDataExplorer](get-data-explorer.md) | public [getDataExplorer](get-data-explorer.md)(id: [Variant](../-variant/index.md)): [DataExplorer](../-data-explorer/index.md)
gets a specific DataExplorer | +| [getDataMonitor](get-data-monitor.md) | public [getDataMonitor](get-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Variant](../-variant/index.md)): [DataMonitor](../-data-monitor/index.md)
gets a specific data monitor associated with a particular component | +| [getFileSystemInfo](get-file-system-info.md) | public [getFileSystemInfo](get-file-system-info.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [FileSystemInfo](../-file-system-info/index.md)
Gets the FileSystemInfo for a given URI. | +| [getFormatter](get-formatter.md) | public [getFormatter](get-formatter.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Format](../-format/index.md)
Gets an instance of a formatter object | +| [getFrame](get-frame.md) | public [getFrame](get-frame.md)(): [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html)
gets a Frame that should be used as the parent for all windows displayed by Java plug-ins. | +| [getGlobalParameters](get-global-parameters.md) | public [getGlobalParameters](get-global-parameters.md)(): [GlobalParameters](../-global-parameters/index.md)
Gets the list of global parameters | +| [getHaltStatus](get-halt-status.md) | public [getHaltStatus](get-halt-status.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
checks to see if the halt button has been pressed | +| [getIsInteractive](get-is-interactive.md) | public [getIsInteractive](get-is-interactive.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determine if the current ModelCenter is running interactively - that is, if it has a GUI and a main window. | +| [getLastErrorMessage](get-last-error-message.md) | public [getLastErrorMessage](get-last-error-message.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
retrieves the text associated with the last ModelCenter error | +| [getLicensingPath](get-licensing-path.md) | public [getLicensingPath](get-licensing-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the ModelCenter licensing path returns ModelCenter licensing path | +| [getLinks](get-links.md) | public [getLinks](get-links.md)(includeReferences: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [VariableLinks](../-variable-links/index.md)
Retreive a list of all links in a model | +| [getLogger](get-logger.md) | public [getLogger](get-logger.md)(): [Logger](../../com.phoenix_int.ModelCenter.logging/-logger/index.md)
Retrieves a logger. | +| [getMacroScript](get-macro-script.md) | public [getMacroScript](get-macro-script.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the script for a macro if the macro exists | +| [getMacroScriptLanguage](get-macro-script-language.md) | public [getMacroScriptLanguage](get-macro-script-language.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the script language for a macro if the macro exists | +| [getMacroTimeout](get-macro-timeout.md) | public [getMacroTimeout](get-macro-timeout.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
get the timeout for a macro if the macro exists | +| [getModel](get-model.md) | public [getModel](get-model.md)(): [Assembly](../-assembly/index.md)
Gets the Model object | +| [getModelCenterPath](get-model-center-path.md) | public [getModelCenterPath](get-model-center-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Retrieves the install path for ModelCenter. | +| [getModelDirectory](get-model-directory.md) | public [getModelDirectory](get-model-directory.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Model directory returns an exception when Model is not open returns an empty string when Model has not been saved | +| [getModelFileName](get-model-file-name.md) | public [getModelFileName](get-model-file-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the Model file name | +| [getPreference](get-preference.md) | public [getPreference](get-preference.md)(prefName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
gets a preference | +| [getProcessID](get-process-i-d.md) | public [getProcessID](get-process-i-d.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
Retrieves the process identifier (PID) of the ModelCenter process. | +| [getRunOnlyMode](get-run-only-mode.md) | public [getRunOnlyMode](get-run-only-mode.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets the status of ModelCenter being in Run-Only Mode. | +| [getScreenUpdating](get-screen-updating.md) | public [getScreenUpdating](get-screen-updating.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
returns the current screen updating flag | +| [getTradeStudyFilters](get-trade-study-filters.md) | public [getTradeStudyFilters](get-trade-study-filters.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>
Get the filters for saving Trade Study files (for use in showFileBrowseDialog and showFileSaveDialog) | +| [getValue](get-value.md) | public [getValue](get-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
gets a value for the specified variable | +| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
gets a value for the specified variable without validating it | +| [getVariable](get-variable.md) | public [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
Gets the specified variable from the Model | +| [getVariableMetaData](get-variable-meta-data.md) | public [getVariableMetaData](get-variable-meta-data.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md)
Get metadata about the specified variable from the Model. | +| [getVersion](get-version.md) | public [getVersion](get-version.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the ModelCenter version | +| [getXMLExtension](get-x-m-l-extension.md) | public [getXMLExtension](get-x-m-l-extension.md)(nodeName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), attributeName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), attributeValue: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
For internal use only. | +| [guiCloseAllMultiplexers](gui-close-all-multiplexers.md) | public [guiCloseAllMultiplexers](gui-close-all-multiplexers.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Attempts to close the DataExplorers of all vizualization multiplexers. | +| [guiLoadFile](gui-load-file.md) | public [guiLoadFile](gui-load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Loads a file in "GUI" mode, that is, unlike loadFile(...), will produce a prompt to the user to verify whether or not any currently opened model should be saved prior to loading the given file. | +| [guiSaveModel](gui-save-model.md) | public [guiSaveModel](gui-save-model.md)()
Saves a file in "GUI" mode, which will pop up a dialog if the file has not yet been saved. | +| [halt](halt.md) | public [halt](halt.md)()
Halts any running trade studies | +| [hidePlugInFrame](hide-plug-in-frame.md) | public [hidePlugInFrame](hide-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Hides the frame window which the java plugin is embedded in | +| [HTMLViewerWaitForClose](-h-t-m-l-viewer-wait-for-close.md) | public [HTMLViewerWaitForClose](-h-t-m-l-viewer-wait-for-close.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
waits for the HTMLViewer embedded browser tool to close | +| [internalLicensing](internal-licensing.md) | public [internalLicensing](internal-licensing.md)(one: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), two: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
For internal use only | +| [invokeHelp](invoke-help.md) | public [invokeHelp](invoke-help.md)(helpID: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Display a topic in ModelCenter's help system | +| [isOkToClose](is-ok-to-close.md) | public [isOkToClose](is-ok-to-close.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determine whether it's ok to shutdown ModelCenter or whether there are still windows open | +| [launchDataCollectorPlugIn](launch-data-collector-plug-in.md) | public [launchDataCollectorPlugIn](launch-data-collector-plug-in.md)(plugInName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), dataExplorer: [DataExplorer](../-data-explorer/index.md))
Launches a specific Data Collector PlugIn, by name, on the specified Data Explorer. | +| [launchHTMLViewer](launch-h-t-m-l-viewer.md) | public [launchHTMLViewer](launch-h-t-m-l-viewer.md)(url: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), popup: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
starts the HTMLViewer embedded browser tool | +| [launchMacroEditor](launch-macro-editor.md) | public [launchMacroEditor](launch-macro-editor.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
launches the macro editor, displays the macro scrip if it exists | +| [launchTradeStudy](launch-trade-study.md) | public [launchTradeStudy](launch-trade-study.md)(idStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Launches the specified trade study. | +| [loadFile](load-file.md) | public [loadFile](load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [loadFile](load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), connectErrorMode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
opens the specified Model | +| [loadModel](load-model.md) | public [loadModel](load-model.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [loadModel](load-model.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), connectErrorMode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
opens the specified Model | +| [MessageBox](-message-box.md) | public [MessageBox](-message-box.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
displays a Windows Message Box | +| [moveComponent](move-component.md) | public [moveComponent](move-component.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Moves a component. | +| [newInstance](new-instance.md) | public [newInstance](new-instance.md)(): [ModelCenter](index.md)
creates a new ModelCenter object (that is connected to the same ModelCenter session) that is not currently attached to any thread. | +| [newModel](new-model.md) | public [newModel](new-model.md)()
loads ModelCenter with a new, empty Model (data dependency model - MODEL_TYPE_DATA)
public [newModel](new-model.md)(modelType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
loads ModelCenter with a new, empty Model | +| [parallelInstance](parallel-instance.md) | public [parallelInstance](parallel-instance.md)(): [ModelCenter](index.md)
For internal use only | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [removeComponent](remove-component.md) | public [removeComponent](remove-component.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Removes a specified component | +| [removeDataMonitor](remove-data-monitor.md) | public [removeDataMonitor](remove-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Variant](../-variant/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
remove a specific data monitor associated with a particular component | +| [run](run.md) | public [run](run.md)(variableArray: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
A comma-separated list of ModelCenter variables to validate. | +| [runAntFile](run-ant-file.md) | public [runAntFile](run-ant-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
runs an ANT testing file | +| [runMacro](run-macro.md) | public [runMacro](run-macro.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
runs a macro | +| [runMacro2](run-macro2.md) | public [runMacro2](run-macro2.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
runs a macro and passes the current modelCenter object to the script (i.e. | +| [saveModel](save-model.md) | public [saveModel](save-model.md)()
saves the current Model with it's existing file name | +| [saveModelAs](save-model-as.md) | public [saveModelAs](save-model-as.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
saves the current Model with the specified file name | +| [saveTradeStudy](save-trade-study.md) | public [saveTradeStudy](save-trade-study.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileType: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), dataExplorer: [DataExplorer](../-data-explorer/index.md))
Save the trade study inside of the Data Explorer | +| [saveVersionedModel](save-versioned-model.md) | public [saveVersionedModel](save-versioned-model.md)(versionStatus: [ModelCenter.VersionStatus](-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
saves the current Model with it's existing file name | +| [saveVersionedModelAs](save-versioned-model-as.md) | public [saveVersionedModelAs](save-versioned-model-as.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), versionStatus: [ModelCenter.VersionStatus](-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
saves the current Model with the specified file name | +| [setAssemblyStyle](set-assembly-style.md) | public [setAssemblyStyle](set-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), style: [ModelCenter.AssemblyStyle](-assembly-style/index.md))
Set the visual style of an assembly.
public [setAssemblyStyle](set-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), style: [ModelCenter.AssemblyStyle](-assembly-style/index.md), width: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), height: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
Set the visual style of an assembly including (optionally) width and height. | +| [setIconPlugInFrame](set-icon-plug-in-frame.md) | public [setIconPlugInFrame](set-icon-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), iconFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the icon for the frame window which the java plugin is embedded in | +| [setLoginCallback](set-login-callback.md) | public [setLoginCallback](set-login-callback.md)(callback: [ILoginCallback](../-i-login-callback/index.md))
Set the login callback to use | +| [setMacroScript](set-macro-script.md) | public [setMacroScript](set-macro-script.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), script: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set the script for a macro if the macro exists | +| [setMacroScriptLanguage](set-macro-script-language.md) | public [setMacroScriptLanguage](set-macro-script-language.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), language: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set the script lancuage for a macro if the macro exists | +| [setMacroTimeout](set-macro-timeout.md) | public [setMacroTimeout](set-macro-timeout.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), timeout: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
sets the timeout for a macro if the macro exists | +| [setPassword](set-password.md) | public [setPassword](set-password.md)(password: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the global default password combination in ModelCenter | +| [setPreference](set-preference.md) | public [setPreference](set-preference.md)(prefName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets a preference | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setRunOnlyMode](set-run-only-mode.md) | public [setRunOnlyMode](set-run-only-mode.md)(shouldBeInRunOnly: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets the status of ModelCenter being in Run-Only Mode to the specified value. | +| [setScheduler](set-scheduler.md) | public [setScheduler](set-scheduler.md)(scheduler: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the appropriate schdeuler. | +| [setScreenUpdating](set-screen-updating.md) | public [setScreenUpdating](set-screen-updating.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets a flag indicating if the ModelCenter window should update due to Model changes. | +| [setUserName](set-user-name.md) | public [setUserName](set-user-name.md)(username: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the global default username combination in ModelCenter | +| [setValue](set-value.md) | public [setValue](set-value.md)(varName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value for the specified variable | +| [setXMLExtension](set-x-m-l-extension.md) | public [setXMLExtension](set-x-m-l-extension.md)(xml: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
For internal use only. | +| [showFileBrowseDialog](show-file-browse-dialog.md) | public [showFileBrowseDialog](show-file-browse-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [showFileBrowseDialog](show-file-browse-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Displays file selection dialog for loading and returns URL of selected file. | +| [showFileSaveDialog](show-file-save-dialog.md) | public [showFileSaveDialog](show-file-save-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), selectedFilter: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html)>, initialFileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Displays file selection dialog for saving and returns URL of selected file. | +| [showPlugInFrame](show-plug-in-frame.md) | public [showPlugInFrame](show-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
Shows the frame window which the java plugin is embedded in | +| [startGUIMode](start-g-u-i-mode.md) | public [startGUIMode](start-g-u-i-mode.md)(showDialogs: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
THIS FUNCTION IS A BETA CAPABILITY Normally when invoked via COM, ModelCenter is in "server" mode and it hides all GUI and dialogs. | +| [tradeStudyEnd](trade-study-end.md) | public [tradeStudyEnd](trade-study-end.md)()
lets ModelCenter know that a trade study is ending | +| [tradeStudyStart](trade-study-start.md) | public [tradeStudyStart](trade-study-start.md)()
lets ModelCenter know that a trade study is beginning | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/internal-licensing.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/internal-licensing.md index 5aa465c4e9..1fd037db45 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/internal-licensing.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/internal-licensing.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[internalLicensing](internal-licensing.md) - -# internalLicensing - - -public [internalLicensing](internal-licensing.md)(one: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), two: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -For internal use only +# internalLicensing + + +public [internalLicensing](internal-licensing.md)(one: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), two: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +For internal use only diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/invoke-help.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/invoke-help.md index 605b688863..d4a733faff 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/invoke-help.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/invoke-help.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[invokeHelp](invoke-help.md) - -# invokeHelp - - -public [invokeHelp](invoke-help.md)(helpID: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -Display a topic in ModelCenter's help system - -#### Parameters - - - -| | | -|---|---| -| helpID | The id of the help topic to display: | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# invokeHelp + + +public [invokeHelp](invoke-help.md)(helpID: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +Display a topic in ModelCenter's help system + +#### Parameters + + + +| | | +|---|---| +| helpID | The id of the help topic to display: | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/is-ok-to-close.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/is-ok-to-close.md index 2db185dc1a..8ffc342142 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/is-ok-to-close.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/is-ok-to-close.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[isOkToClose](is-ok-to-close.md) - -# isOkToClose - - -public [isOkToClose](is-ok-to-close.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Determine whether it's ok to shutdown ModelCenter or whether there are still windows open +# isOkToClose + + +public [isOkToClose](is-ok-to-close.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Determine whether it's ok to shutdown ModelCenter or whether there are still windows open diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-data-collector-plug-in.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-data-collector-plug-in.md index 293ccb7018..9048747c72 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-data-collector-plug-in.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-data-collector-plug-in.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[launchDataCollectorPlugIn](launch-data-collector-plug-in.md) - -# launchDataCollectorPlugIn - - -public [launchDataCollectorPlugIn](launch-data-collector-plug-in.md)(plugInName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), dataExplorer: [DataExplorer](../-data-explorer/index.md)) - -Launches a specific Data Collector PlugIn, by name, on the specified Data Explorer. - -#### Parameters - - - -| | | -|---|---| -| plugInName | The name of the Data Collector PlugIn to be launched | -| dataExplorer | The Data Explorer for which to launch the PlugIn | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | If something goes wrong in launching the PlugIn | +# launchDataCollectorPlugIn + + +public [launchDataCollectorPlugIn](launch-data-collector-plug-in.md)(plugInName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), dataExplorer: [DataExplorer](../-data-explorer/index.md)) + +Launches a specific Data Collector PlugIn, by name, on the specified Data Explorer. + +#### Parameters + + + +| | | +|---|---| +| plugInName | The name of the Data Collector PlugIn to be launched | +| dataExplorer | The Data Explorer for which to launch the PlugIn | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | If something goes wrong in launching the PlugIn | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-h-t-m-l-viewer.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-h-t-m-l-viewer.md index 0ba17f2d3a..dcac6181a1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-h-t-m-l-viewer.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-h-t-m-l-viewer.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[launchHTMLViewer](launch-h-t-m-l-viewer.md) - -# launchHTMLViewer - - -public [launchHTMLViewer](launch-h-t-m-l-viewer.md)(url: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), popup: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -starts the HTMLViewer embedded browser tool +# launchHTMLViewer + + +public [launchHTMLViewer](launch-h-t-m-l-viewer.md)(url: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), popup: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +starts the HTMLViewer embedded browser tool diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-macro-editor.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-macro-editor.md index 544b931e76..badecafd51 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-macro-editor.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-macro-editor.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[launchMacroEditor](launch-macro-editor.md) - -# launchMacroEditor - - -public [launchMacroEditor](launch-macro-editor.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -launches the macro editor, displays the macro scrip if it exists - -#### Parameters - - - -| | | -|---|---| -| macroName | the macro to display in the editor | +# launchMacroEditor + + +public [launchMacroEditor](launch-macro-editor.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +launches the macro editor, displays the macro scrip if it exists + +#### Parameters + + + +| | | +|---|---| +| macroName | the macro to display in the editor | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-trade-study.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-trade-study.md index 0c4b67dbe6..aa4454ce6a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-trade-study.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-trade-study.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[launchTradeStudy](launch-trade-study.md) - -# launchTradeStudy - - -public [launchTradeStudy](launch-trade-study.md)(idStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Launches the specified trade study. May be a common name, like "doe" or a fully specified URL like "common:\\tradestudy\\doe" - -#### Parameters - - - -| | | -|---|---| -| idStr | the trade study name | +# launchTradeStudy + + +public [launchTradeStudy](launch-trade-study.md)(idStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Launches the specified trade study. May be a common name, like "doe" or a fully specified URL like "common:\\tradestudy\\doe" + +#### Parameters + + + +| | | +|---|---| +| idStr | the trade study name | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/load-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/load-file.md index 9c2e26dace..227a72f4aa 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/load-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/load-file.md @@ -1,42 +1,40 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[loadFile](load-file.md) - -# loadFile - - -public [loadFile](load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -opens the specified Model - -#### Parameters - - - -| | | -|---|---| -| modelFile | the Model to open | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [loadFile](load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), connectErrorMode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -opens the specified Model - -#### Parameters - - - -| | | -|---|---| -| modelFile | the Model to open | -| connectErrorMode | What to do when a connect error is encountered. (see error modes below)
```kotlin Error Modes: CONN_ERR_ERROR - (default) Abort loading and throw the error back to the caller. CONN_ERR_IGNORE - Ignore the error and continue loading (as if user has pressed "Ignore" in the dialog). CONN_ERR_USEDIALOG - (option not available when running ModelCenter in server mode) Shows the error as if the user were loading the file manually with full control. ``` | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# loadFile + + +public [loadFile](load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +opens the specified Model + +#### Parameters + + + +| | | +|---|---| +| modelFile | the Model to open | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [loadFile](load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), connectErrorMode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +opens the specified Model + +#### Parameters + + + +| | | +|---|---| +| modelFile | the Model to open | +| connectErrorMode | What to do when a connect error is encountered. (see error modes below)
```kotlin Error Modes: CONN_ERR_ERROR - (default) Abort loading and throw the error back to the caller. CONN_ERR_IGNORE - Ignore the error and continue loading (as if user has pressed "Ignore" in the dialog). CONN_ERR_USEDIALOG - (option not available when running ModelCenter in server mode) Shows the error as if the user were loading the file manually with full control. ``` | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/load-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/load-model.md index 7e9b0beb3e..b0d3d82cc7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/load-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/load-model.md @@ -1,42 +1,40 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[loadModel](load-model.md) - -# loadModel - - -public [loadModel](load-model.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -opens the specified Model - -#### Parameters - - - -| | | -|---|---| -| modelFile | the Model to open | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [loadModel](load-model.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), connectErrorMode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -opens the specified Model - -#### Parameters - - - -| | | -|---|---| -| modelFile | the Model to open | -| connectErrorMode | What to do when a connect error is encountered. (see error modes below)
```kotlin Error Modes: CONN_ERR_ERROR - (default) Abort loading and throw the error back to the caller. CONN_ERR_IGNORE - Ignore the error and continue loading (as if user has pressed "Ignore" in the dialog). CONN_ERR_USEDIALOG - (option not available when running ModelCenter in server mode) Shows the error as if the user were loading the file manually with full control. ``` | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# loadModel + + +public [loadModel](load-model.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +opens the specified Model + +#### Parameters + + + +| | | +|---|---| +| modelFile | the Model to open | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [loadModel](load-model.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), connectErrorMode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +opens the specified Model + +#### Parameters + + + +| | | +|---|---| +| modelFile | the Model to open | +| connectErrorMode | What to do when a connect error is encountered. (see error modes below)
```kotlin Error Modes: CONN_ERR_ERROR - (default) Abort loading and throw the error back to the caller. CONN_ERR_IGNORE - Ignore the error and continue loading (as if user has pressed "Ignore" in the dialog). CONN_ERR_USEDIALOG - (option not available when running ModelCenter in server mode) Shows the error as if the user were loading the file manually with full control. ``` | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/move-component.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/move-component.md index adf9fe8102..3996a161f1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/move-component.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/move-component.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[moveComponent](move-component.md) - -# moveComponent - - -public [moveComponent](move-component.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -Moves a component. - -#### Parameters - - - -| | | -|---|---| -| component | the component to move | -| parent | the name of the parent | -| index | the index to move to; -1 for end | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# moveComponent + + +public [moveComponent](move-component.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +Moves a component. + +#### Parameters + + + +| | | +|---|---| +| component | the component to move | +| parent | the name of the parent | +| index | the index to move to; -1 for end | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/new-instance.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/new-instance.md index 1e023edfdc..20161a0f8a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/new-instance.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/new-instance.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[newInstance](new-instance.md) - -# newInstance - - -public [newInstance](new-instance.md)(): [ModelCenter](index.md) - -creates a new ModelCenter object (that is connected to the same ModelCenter session) that is not currently attached to any thread. Use this method if you need to call ModelCenter from multiple threads. The spawning thread should call this function for each thread that needs to call ModelCenter. The new instance should be passed to the spawned thread and used there. - -#### Return - -a ModelCenter instance that is not attached to any thread - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# newInstance + + +public [newInstance](new-instance.md)(): [ModelCenter](index.md) + +creates a new ModelCenter object (that is connected to the same ModelCenter session) that is not currently attached to any thread. Use this method if you need to call ModelCenter from multiple threads. The spawning thread should call this function for each thread that needs to call ModelCenter. The new instance should be passed to the spawned thread and used there. + +#### Return + +a ModelCenter instance that is not attached to any thread + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/new-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/new-model.md index 4b1a55c0dc..2d9958c306 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/new-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/new-model.md @@ -1,33 +1,31 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[newModel](new-model.md) - -# newModel - - -public [newModel](new-model.md)() - -loads ModelCenter with a new, empty Model (data dependency model - MODEL_TYPE_DATA) - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [newModel](new-model.md)(modelType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -loads ModelCenter with a new, empty Model - -#### Parameters - - - -| | | -|---|---| -| modelType | can be either MODEL_TYPE_DATA to create a traditional data dependency ModelCenter model or MODEL_TYPE_PROCESS to create a model that can incorporate newer process modeling components and features | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# newModel + + +public [newModel](new-model.md)() + +loads ModelCenter with a new, empty Model (data dependency model - MODEL_TYPE_DATA) + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [newModel](new-model.md)(modelType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +loads ModelCenter with a new, empty Model + +#### Parameters + + + +| | | +|---|---| +| modelType | can be either MODEL_TYPE_DATA to create a traditional data dependency ModelCenter model or MODEL_TYPE_PROCESS to create a model that can incorporate newer process modeling components and features | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/parallel-instance.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/parallel-instance.md index 3d1bf32158..0170e2b936 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/parallel-instance.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/parallel-instance.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[parallelInstance](parallel-instance.md) - -# parallelInstance - - -public [parallelInstance](parallel-instance.md)(): [ModelCenter](index.md) - -For internal use only +# parallelInstance + + +public [parallelInstance](parallel-instance.md)(): [ModelCenter](index.md) + +For internal use only diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/remove-component.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/remove-component.md index 8d0a4a664b..de4bbc07ac 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/remove-component.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/remove-component.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[removeComponent](remove-component.md) - -# removeComponent - - -public [removeComponent](remove-component.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Removes a specified component - -#### Parameters - - - -| | | -|---|---| -| component | the component to remove | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# removeComponent + + +public [removeComponent](remove-component.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Removes a specified component + +#### Parameters + + + +| | | +|---|---| +| component | the component to remove | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/remove-data-monitor.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/remove-data-monitor.md index 39bfa69259..40414e8f91 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/remove-data-monitor.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/remove-data-monitor.md @@ -1,21 +1,19 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[removeDataMonitor](remove-data-monitor.md) - -# removeDataMonitor - - -public [removeDataMonitor](remove-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Variant](../-variant/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -remove a specific data monitor associated with a particular component - -#### Return - -whether the data monitor was successfully found and deleted - -#### Parameters - - - -| | | -|---|---| -| component | the name of the component under which to find the data monitor for deletion | -| index | the integer index (0-based index) or string title of the data monitor being removed | +# removeDataMonitor + + +public [removeDataMonitor](remove-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Variant](../-variant/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +remove a specific data monitor associated with a particular component + +#### Return + +whether the data monitor was successfully found and deleted + +#### Parameters + + + +| | | +|---|---| +| component | the name of the component under which to find the data monitor for deletion | +| index | the integer index (0-based index) or string title of the data monitor being removed | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/run-ant-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/run-ant-file.md index deaafe7e5a..fd413cf73c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/run-ant-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/run-ant-file.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[runAntFile](run-ant-file.md) - -# runAntFile - - -public [runAntFile](run-ant-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -runs an ANT testing file +# runAntFile + + +public [runAntFile](run-ant-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +runs an ANT testing file diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/run-macro.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/run-macro.md index 59f41ca394..70ca9d2a9f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/run-macro.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/run-macro.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[runMacro](run-macro.md) - -# runMacro - - -public [runMacro](run-macro.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) - -runs a macro - -#### Return - -Variant(reserved for future use) - -#### Parameters - - - -| | | -|---|---| -| macroName | the name of the macro to run | +# runMacro + + +public [runMacro](run-macro.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) + +runs a macro + +#### Return + +Variant(reserved for future use) + +#### Parameters + + + +| | | +|---|---| +| macroName | the name of the macro to run | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/run-macro2.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/run-macro2.md index 30795e6137..d5654d4583 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/run-macro2.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/run-macro2.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[runMacro2](run-macro2.md) - -# runMacro2 - - -public [runMacro2](run-macro2.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) - -runs a macro and passes the current modelCenter object to the script (i.e., the script "app" object) - -#### Return - -Variant(reserved for future use) - -#### Parameters - - - -| | | -|---|---| -| macroName | the name of the macro to run | +# runMacro2 + + +public [runMacro2](run-macro2.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) + +runs a macro and passes the current modelCenter object to the script (i.e., the script "app" object) + +#### Return + +Variant(reserved for future use) + +#### Parameters + + + +| | | +|---|---| +| macroName | the name of the macro to run | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/run.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/run.md index ed7677f195..6534f2c432 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/run.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/run.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[run](run.md) - -# run - - -public [run](run.md)(variableArray: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -A comma-separated list of ModelCenter variables to validate. If no variables are specified then the entire model will be run (equivalent to clicking the scheduler run button). - -#### Parameters - - - -| | | -|---|---| -| variableArray | a csv | +# run + + +public [run](run.md)(variableArray: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +A comma-separated list of ModelCenter variables to validate. If no variables are specified then the entire model will be run (equivalent to clicking the scheduler run button). + +#### Parameters + + + +| | | +|---|---| +| variableArray | a csv | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-model-as.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-model-as.md index 17445f198e..39ecc15917 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-model-as.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-model-as.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[saveModelAs](save-model-as.md) - -# saveModelAs - - -public [saveModelAs](save-model-as.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -saves the current Model with the specified file name - -#### Parameters - - - -| | | -|---|---| -| fileName | the file name to save the Model as | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# saveModelAs + + +public [saveModelAs](save-model-as.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +saves the current Model with the specified file name + +#### Parameters + + + +| | | +|---|---| +| fileName | the file name to save the Model as | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-model.md index b46e0f1045..6c1d9945b8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-model.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[saveModel](save-model.md) - -# saveModel - - -public [saveModel](save-model.md)() - -saves the current Model with it's existing file name - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# saveModel + + +public [saveModel](save-model.md)() + +saves the current Model with it's existing file name + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-trade-study.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-trade-study.md index ad6a798383..36a698a272 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-trade-study.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-trade-study.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[saveTradeStudy](save-trade-study.md) - -# saveTradeStudy - - -public [saveTradeStudy](save-trade-study.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileType: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), dataExplorer: [DataExplorer](../-data-explorer/index.md)) - -Save the trade study inside of the Data Explorer - -#### Parameters - - - -| | | -|---|---| -| uri | the URI to save the trade study to | -| fileType | the file format for the trade study | -| dataExplorer | a pointer to the Data Explorer from which to save | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if an argument is invalid or if an error occurs while saving | +# saveTradeStudy + + +public [saveTradeStudy](save-trade-study.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileType: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), dataExplorer: [DataExplorer](../-data-explorer/index.md)) + +Save the trade study inside of the Data Explorer + +#### Parameters + + + +| | | +|---|---| +| uri | the URI to save the trade study to | +| fileType | the file format for the trade study | +| dataExplorer | a pointer to the Data Explorer from which to save | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if an argument is invalid or if an error occurs while saving | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-versioned-model-as.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-versioned-model-as.md index 7adaeadf39..3c28fd8208 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-versioned-model-as.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-versioned-model-as.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[saveVersionedModelAs](save-versioned-model-as.md) - -# saveVersionedModelAs - - -public [saveVersionedModelAs](save-versioned-model-as.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), versionStatus: [ModelCenter.VersionStatus](-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -saves the current Model with the specified file name - -#### Parameters - - - -| | | -|---|---| -| fileName | the file name to save the Model as | -| versionStatus | how to go about versioning the file | -| checkinMessage | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# saveVersionedModelAs + + +public [saveVersionedModelAs](save-versioned-model-as.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), versionStatus: [ModelCenter.VersionStatus](-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +saves the current Model with the specified file name + +#### Parameters + + + +| | | +|---|---| +| fileName | the file name to save the Model as | +| versionStatus | how to go about versioning the file | +| checkinMessage | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-versioned-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-versioned-model.md index 72a093528f..87f997f847 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-versioned-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/save-versioned-model.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[saveVersionedModel](save-versioned-model.md) - -# saveVersionedModel - - -public [saveVersionedModel](save-versioned-model.md)(versionStatus: [ModelCenter.VersionStatus](-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -saves the current Model with it's existing file name - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# saveVersionedModel + + +public [saveVersionedModel](save-versioned-model.md)(versionStatus: [ModelCenter.VersionStatus](-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +saves the current Model with it's existing file name + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-assembly-style.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-assembly-style.md index 944a441ebd..de3c84e696 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-assembly-style.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-assembly-style.md @@ -1,37 +1,35 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[setAssemblyStyle](set-assembly-style.md) - -# setAssemblyStyle - - -public [setAssemblyStyle](set-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), style: [ModelCenter.AssemblyStyle](-assembly-style/index.md)) - -Set the visual style of an assembly. This method can be used to modify any control with children, including IF blocks, traditional assemblies, drivers (in process mode), sequences, and parallel blocks. - -#### Parameters - - - -| | | -|---|---| -| assemblyName | the full name of the assembly to modify | -| style | the style | - - -public [setAssemblyStyle](set-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), style: [ModelCenter.AssemblyStyle](-assembly-style/index.md), width: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), height: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - - Set the visual style of an assembly including (optionally) width and height. Style constants are defined above and in ModelCenter.odl in the ModelCenter project. - - Width and height are ignored for the model, elements to be collapsed, and for assemblies which are not data-driven. - - This method can be used to modify any control with children, including IF blocks, traditional assemblies, drivers (in process mode), sequences, and parallel blocks. - -#### Parameters - - - -| | | -|---|---| -| assemblyName | the full name of the assembly to modify | -| style | the style | -| width | the new width; ignored when <= 0 | -| height | the new height; ignored when <= 0 | +# setAssemblyStyle + + +public [setAssemblyStyle](set-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), style: [ModelCenter.AssemblyStyle](-assembly-style/index.md)) + +Set the visual style of an assembly. This method can be used to modify any control with children, including IF blocks, traditional assemblies, drivers (in process mode), sequences, and parallel blocks. + +#### Parameters + + + +| | | +|---|---| +| assemblyName | the full name of the assembly to modify | +| style | the style | + + +public [setAssemblyStyle](set-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), style: [ModelCenter.AssemblyStyle](-assembly-style/index.md), width: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), height: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + + Set the visual style of an assembly including (optionally) width and height. Style constants are defined above and in ModelCenter.odl in the ModelCenter project. + + Width and height are ignored for the model, elements to be collapsed, and for assemblies which are not data-driven. + + This method can be used to modify any control with children, including IF blocks, traditional assemblies, drivers (in process mode), sequences, and parallel blocks. + +#### Parameters + + + +| | | +|---|---| +| assemblyName | the full name of the assembly to modify | +| style | the style | +| width | the new width; ignored when <= 0 | +| height | the new height; ignored when <= 0 | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-icon-plug-in-frame.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-icon-plug-in-frame.md index 3cb4d620d7..1ce1fe90ab 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-icon-plug-in-frame.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-icon-plug-in-frame.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[setIconPlugInFrame](set-icon-plug-in-frame.md) - -# setIconPlugInFrame - - -public [setIconPlugInFrame](set-icon-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), iconFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Sets the icon for the frame window which the java plugin is embedded in - -#### Parameters - - - -| | | -|---|---| -| hwnd | handle to the frame window CWnd | -| iconFile | string to the absolute location of the icon file | +# setIconPlugInFrame + + +public [setIconPlugInFrame](set-icon-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), iconFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Sets the icon for the frame window which the java plugin is embedded in + +#### Parameters + + + +| | | +|---|---| +| hwnd | handle to the frame window CWnd | +| iconFile | string to the absolute location of the icon file | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-login-callback.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-login-callback.md index fdff7d1bdf..fba608d1ad 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-login-callback.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-login-callback.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[setLoginCallback](set-login-callback.md) - -# setLoginCallback - - -public [setLoginCallback](set-login-callback.md)(callback: [ILoginCallback](../-i-login-callback/index.md)) - -Set the login callback to use - -#### Parameters - - - -| | | -|---|---| -| callback | callback to use | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setLoginCallback + + +public [setLoginCallback](set-login-callback.md)(callback: [ILoginCallback](../-i-login-callback/index.md)) + +Set the login callback to use + +#### Parameters + + + +| | | +|---|---| +| callback | callback to use | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-macro-script-language.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-macro-script-language.md index 6736b2dfcc..1084b5a0b9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-macro-script-language.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-macro-script-language.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[setMacroScriptLanguage](set-macro-script-language.md) - -# setMacroScriptLanguage - - -public [setMacroScriptLanguage](set-macro-script-language.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), language: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -set the script lancuage for a macro if the macro exists - -#### Parameters - - - -| | | -|---|---| -| macroName | the name of the macro | -| language | the macro script language | +# setMacroScriptLanguage + + +public [setMacroScriptLanguage](set-macro-script-language.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), language: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +set the script lancuage for a macro if the macro exists + +#### Parameters + + + +| | | +|---|---| +| macroName | the name of the macro | +| language | the macro script language | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-macro-script.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-macro-script.md index f3231fb044..4ebffd8b58 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-macro-script.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-macro-script.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[setMacroScript](set-macro-script.md) - -# setMacroScript - - -public [setMacroScript](set-macro-script.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), script: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -set the script for a macro if the macro exists - -#### Parameters - - - -| | | -|---|---| -| macroName | the name of the macro | -| script | the macro script to display in the editor | +# setMacroScript + + +public [setMacroScript](set-macro-script.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), script: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +set the script for a macro if the macro exists + +#### Parameters + + + +| | | +|---|---| +| macroName | the name of the macro | +| script | the macro script to display in the editor | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-macro-timeout.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-macro-timeout.md index 48a2c19ef1..f307742d75 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-macro-timeout.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-macro-timeout.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[setMacroTimeout](set-macro-timeout.md) - -# setMacroTimeout - - -public [setMacroTimeout](set-macro-timeout.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), timeout: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) - -sets the timeout for a macro if the macro exists - -#### Parameters - - - -| | | -|---|---| -| macroName | the name of the macro | -| timeout | the number of seconds to allow a script to run before canceling it; -1 indicates no timeout | +# setMacroTimeout + + +public [setMacroTimeout](set-macro-timeout.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), timeout: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) + +sets the timeout for a macro if the macro exists + +#### Parameters + + + +| | | +|---|---| +| macroName | the name of the macro | +| timeout | the number of seconds to allow a script to run before canceling it; -1 indicates no timeout | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-password.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-password.md index 1c27a54840..d9d353f432 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-password.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-password.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[setPassword](set-password.md) - -# setPassword - - -public [setPassword](set-password.md)(password: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Sets the global default password combination in ModelCenter - -#### Parameters - - - -| | | -|---|---| -| password | the new global default password | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setPassword + + +public [setPassword](set-password.md)(password: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Sets the global default password combination in ModelCenter + +#### Parameters + + + +| | | +|---|---| +| password | the new global default password | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-preference.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-preference.md index 700530a3aa..00852fbc0a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-preference.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-preference.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[setPreference](set-preference.md) - -# setPreference - - -public [setPreference](set-preference.md)(prefName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Sets a preference - -#### Parameters - - - -| | | -|---|---| -| prefName | the name of the preference | -| value | the new preference value | +# setPreference + + +public [setPreference](set-preference.md)(prefName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Sets a preference + +#### Parameters + + + +| | | +|---|---| +| prefName | the name of the preference | +| value | the new preference value | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-run-only-mode.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-run-only-mode.md index 337ed3e358..3c48088aef 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-run-only-mode.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-run-only-mode.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[setRunOnlyMode](set-run-only-mode.md) - -# setRunOnlyMode - - -public [setRunOnlyMode](set-run-only-mode.md)(shouldBeInRunOnly: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Sets the status of ModelCenter being in Run-Only Mode to the specified value. - - Note: This function can only be called if it is the first function to be called on a new ModelCenter object; otherwise, it will throw an exception. This is to ensure that the correct ModelCenter license is checked out. - -#### Parameters - - - -| | | -|---|---| -| shouldBeInRunOnly | true if ModelCenter should be in Run-Only Mode; otherwise, false | +# setRunOnlyMode + + +public [setRunOnlyMode](set-run-only-mode.md)(shouldBeInRunOnly: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Sets the status of ModelCenter being in Run-Only Mode to the specified value. + + Note: This function can only be called if it is the first function to be called on a new ModelCenter object; otherwise, it will throw an exception. This is to ensure that the correct ModelCenter license is checked out. + +#### Parameters + + + +| | | +|---|---| +| shouldBeInRunOnly | true if ModelCenter should be in Run-Only Mode; otherwise, false | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-scheduler.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-scheduler.md index 3204198b89..c4e8f9a92a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-scheduler.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-scheduler.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[setScheduler](set-scheduler.md) - -# setScheduler - - -public [setScheduler](set-scheduler.md)(scheduler: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Sets the appropriate schdeuler. Options are "forward", "backward", "mixed", and "script" - -#### Parameters - - - -| | | -|---|---| -| scheduler | the new scheduler | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setScheduler + + +public [setScheduler](set-scheduler.md)(scheduler: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Sets the appropriate schdeuler. Options are "forward", "backward", "mixed", and "script" + +#### Parameters + + + +| | | +|---|---| +| scheduler | the new scheduler | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-screen-updating.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-screen-updating.md index 4651dd437f..838f2f2356 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-screen-updating.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-screen-updating.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[setScreenUpdating](set-screen-updating.md) - -# setScreenUpdating - - -public [setScreenUpdating](set-screen-updating.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets a flag indicating if the ModelCenter window should update due to Model changes. If this function is called multiple times with the flag set to false, screen updating will not be turned back on again until an equal number of calls are made with the value equal to true. - -#### Parameters - - - -| | | -|---|---| -| flag | false to turn updating off, true to turn it on | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setScreenUpdating + + +public [setScreenUpdating](set-screen-updating.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets a flag indicating if the ModelCenter window should update due to Model changes. If this function is called multiple times with the flag set to false, screen updating will not be turned back on again until an equal number of calls are made with the value equal to true. + +#### Parameters + + + +| | | +|---|---| +| flag | false to turn updating off, true to turn it on | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-user-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-user-name.md index 3a7c3aa350..527e5ae360 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-user-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-user-name.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[setUserName](set-user-name.md) - -# setUserName - - -public [setUserName](set-user-name.md)(username: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Sets the global default username combination in ModelCenter - -#### Parameters - - - -| | | -|---|---| -| username | the new global default username | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setUserName + + +public [setUserName](set-user-name.md)(username: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Sets the global default username combination in ModelCenter + +#### Parameters + + + +| | | +|---|---| +| username | the new global default username | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-value.md index 9496495a1d..0c8bbf51fc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-value.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[setValue](set-value.md) - -# setValue - - -public [setValue](set-value.md)(varName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the value for the specified variable - -#### Parameters - - - -| | | -|---|---| -| varName | the full variable name | -| value | the value to set the variable to | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setValue + + +public [setValue](set-value.md)(varName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the value for the specified variable + +#### Parameters + + + +| | | +|---|---| +| varName | the full variable name | +| value | the value to set the variable to | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-x-m-l-extension.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-x-m-l-extension.md index f9a085f466..707c7d2dca 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-x-m-l-extension.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/set-x-m-l-extension.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[setXMLExtension](set-x-m-l-extension.md) - -# setXMLExtension - - -public [setXMLExtension](set-x-m-l-extension.md)(xml: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -For internal use only. +# setXMLExtension + + +public [setXMLExtension](set-x-m-l-extension.md)(xml: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +For internal use only. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/show-file-browse-dialog.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/show-file-browse-dialog.md index 667113bb46..b832244723 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/show-file-browse-dialog.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/show-file-browse-dialog.md @@ -1,54 +1,52 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[showFileBrowseDialog](show-file-browse-dialog.md) - -# showFileBrowseDialog - - -public [showFileBrowseDialog](show-file-browse-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Displays file selection dialog for loading and returns URL of selected file. - -#### Return - -URL of selected file, or null if none selected - -#### Parameters - - - -| | | -|---|---| -| title | title of dialog window | -| filters | array of file type filters, may be null | -| initialUri | initialUri to use in dialog, may be null | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [showFileBrowseDialog](show-file-browse-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Displays file selection dialog for loading and returns URL of selected file. - -#### Return - -URL of selected file, or null if none selected - -#### Parameters - - - -| | | -|---|---| -| title | title of dialog window | -| filters | array of file type filters, may be null | -| initialUri | initialUri to use in dialog, may be null | -| hwnd | the window handle to which to parent the dialog | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# showFileBrowseDialog + + +public [showFileBrowseDialog](show-file-browse-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Displays file selection dialog for loading and returns URL of selected file. + +#### Return + +URL of selected file, or null if none selected + +#### Parameters + + + +| | | +|---|---| +| title | title of dialog window | +| filters | array of file type filters, may be null | +| initialUri | initialUri to use in dialog, may be null | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [showFileBrowseDialog](show-file-browse-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Displays file selection dialog for loading and returns URL of selected file. + +#### Return + +URL of selected file, or null if none selected + +#### Parameters + + + +| | | +|---|---| +| title | title of dialog window | +| filters | array of file type filters, may be null | +| initialUri | initialUri to use in dialog, may be null | +| hwnd | the window handle to which to parent the dialog | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/show-file-save-dialog.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/show-file-save-dialog.md index a014bea218..a0d0eeac7d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/show-file-save-dialog.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/show-file-save-dialog.md @@ -1,31 +1,29 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[showFileSaveDialog](show-file-save-dialog.md) - -# showFileSaveDialog - - -public [showFileSaveDialog](show-file-save-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), selectedFilter: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html)>, initialFileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Displays file selection dialog for saving and returns URL of selected file. - -#### Return - -URL of selected file, or null if none selected - -#### Parameters - - - -| | | -|---|---| -| title | title of dialog window | -| filters | array of file type filters, may be null | -| initialFileName | the file name to populate the dialog with initially | -| selectedFilter | the index of the filter selected by the dialog (inout) | -| initialUri | initialUri to use in dialog, may be null | -| hwnd | the window handle to which to parent the dialog | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# showFileSaveDialog + + +public [showFileSaveDialog](show-file-save-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), selectedFilter: [ValueHolder](../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)<[Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html)>, initialFileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Displays file selection dialog for saving and returns URL of selected file. + +#### Return + +URL of selected file, or null if none selected + +#### Parameters + + + +| | | +|---|---| +| title | title of dialog window | +| filters | array of file type filters, may be null | +| initialFileName | the file name to populate the dialog with initially | +| selectedFilter | the index of the filter selected by the dialog (inout) | +| initialUri | initialUri to use in dialog, may be null | +| hwnd | the window handle to which to parent the dialog | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/show-plug-in-frame.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/show-plug-in-frame.md index 77695365a0..be7d02e3c7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/show-plug-in-frame.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/show-plug-in-frame.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[showPlugInFrame](show-plug-in-frame.md) - -# showPlugInFrame - - -public [showPlugInFrame](show-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -Shows the frame window which the java plugin is embedded in - -#### Parameters - - - -| | | -|---|---| -| hwnd | handle to the frame window CWnd | +# showPlugInFrame + + +public [showPlugInFrame](show-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +Shows the frame window which the java plugin is embedded in + +#### Parameters + + + +| | | +|---|---| +| hwnd | handle to the frame window CWnd | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/start-g-u-i-mode.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/start-g-u-i-mode.md index 056e3191a1..ec954ece41 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/start-g-u-i-mode.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/start-g-u-i-mode.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[startGUIMode](start-g-u-i-mode.md) - -# startGUIMode - - -public [startGUIMode](start-g-u-i-mode.md)(showDialogs: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -THIS FUNCTION IS A BETA CAPABILITY Normally when invoked via COM, ModelCenter is in "server" mode and it hides all GUI and dialogs. This method can be invoked immediately after instantiating the ModelCenter object to cause the GUI to be displayed. Calling this method at any other time than immediately after creating the ModelCenter object is NOT SUPPORTED. Strange behavior or even crashes will likely ensue if it is called at any other time. Once this method is invoked, ModelCenter may pop up GUI dialogs requiring user interation at any time. This means your script may hang indefinitely if a user is not there to click through. For example, if a component fails to load on model load, the user would be prompted with the failed component dialog and the loadModel() api function would hang until the user answered the dialog. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# startGUIMode + + +public [startGUIMode](start-g-u-i-mode.md)(showDialogs: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +THIS FUNCTION IS A BETA CAPABILITY Normally when invoked via COM, ModelCenter is in "server" mode and it hides all GUI and dialogs. This method can be invoked immediately after instantiating the ModelCenter object to cause the GUI to be displayed. Calling this method at any other time than immediately after creating the ModelCenter object is NOT SUPPORTED. Strange behavior or even crashes will likely ensue if it is called at any other time. Once this method is invoked, ModelCenter may pop up GUI dialogs requiring user interation at any time. This means your script may hang indefinitely if a user is not there to click through. For example, if a component fails to load on model load, the user would be prompted with the failed component dialog and the loadModel() api function would hang until the user answered the dialog. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/trade-study-end.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/trade-study-end.md index b34517488e..3198a64881 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/trade-study-end.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/trade-study-end.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[tradeStudyEnd](trade-study-end.md) - -# tradeStudyEnd - - -public [tradeStudyEnd](trade-study-end.md)() - -lets ModelCenter know that a trade study is ending - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# tradeStudyEnd + + +public [tradeStudyEnd](trade-study-end.md)() + +lets ModelCenter know that a trade study is ending + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/trade-study-start.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/trade-study-start.md index 00c0081c5d..74b2cbf61b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/trade-study-start.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-model-center/trade-study-start.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ModelCenter](index.md)/[tradeStudyStart](trade-study-start.md) - -# tradeStudyStart - - -public [tradeStudyStart](trade-study-start.md)() - -lets ModelCenter know that a trade study is beginning - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# tradeStudyStart + + +public [tradeStudyStart](trade-study-start.md)() + +lets ModelCenter know that a trade study is beginning + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/call-method.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/call-method.md index 23ae57f73d..48e4c3a6a5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/call-method.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/call-method.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[callMethod](call-method.md) - -# callMethod - - -public [callMethod](call-method.md)(method: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -call a method - -#### Return - -primitives object (e.g., java.lang.Double) or array of primitives (e.g., double[]) - -#### Parameters - - - -| | | -|---|---| -| method | name of the method | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# callMethod + + +public [callMethod](call-method.md)(method: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +call a method + +#### Return + +primitives object (e.g., java.lang.Double) or array of primitives (e.g., double[]) + +#### Parameters + + + +| | | +|---|---| +| method | name of the method | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/delete-all-members.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/delete-all-members.md index d08b608dcc..eec6b80b5a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/delete-all-members.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/delete-all-members.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[deleteAllMembers](delete-all-members.md) - -# deleteAllMembers - - -public [deleteAllMembers](delete-all-members.md)() - -delete all members for non-strict type object. An exception will be thrown for strict types - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# deleteAllMembers + + +public [deleteAllMembers](delete-all-members.md)() + +delete all members for non-strict type object. An exception will be thrown for strict types + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/delete-member.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/delete-member.md index bac5b056ff..041f8dd70d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/delete-member.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/delete-member.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[deleteMember](delete-member.md) - -# deleteMember - - -public [deleteMember](delete-member.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -delete a member for non-strict type object. An exception will be thrown for strict types - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# deleteMember + + +public [deleteMember](delete-member.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +delete a member for non-strict type object. An exception will be thrown for strict types + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/from-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/from-file.md index 49930e8615..ed3e924f8a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/from-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/from-file.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[fromFile](from-file.md) - -# fromFile - - -public [fromFile](from-file.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -load a file into a file member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| fileName | source file name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# fromFile + + +public [fromFile](from-file.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +load a file into a file member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| fileName | source file name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/from-x-m-l.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/from-x-m-l.md index 77ce63fa1e..ba366d8383 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/from-x-m-l.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/from-x-m-l.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[fromXML](from-x-m-l.md) - -# fromXML - - -public [fromXML](from-x-m-l.md)(xmlStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -update the object from an XML string - -#### Parameters - - - -| | | -|---|---| -| xmlStr | content of an object in XML format | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# fromXML + + +public [fromXML](from-x-m-l.md)(xmlStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +update the object from an XML string + +#### Parameters + + + +| | | +|---|---| +| xmlStr | content of an object in XML format | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-array-member-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-array-member-value-absolute.md index e0055ae484..7220793cc0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-array-member-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-array-member-value-absolute.md @@ -1,51 +1,49 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getBooleanArrayMemberValueAbsolute](get-boolean-array-member-value-absolute.md) - -# getBooleanArrayMemberValueAbsolute - - -public [getBooleanArrayMemberValueAbsolute](get-boolean-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -get the value of an 1D boolean array element without validating it - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getBooleanArrayMemberValueAbsolute](get-boolean-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -get the value of a boolean array element without validating it - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getBooleanArrayMemberValueAbsolute + + +public [getBooleanArrayMemberValueAbsolute](get-boolean-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +get the value of an 1D boolean array element without validating it + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getBooleanArrayMemberValueAbsolute](get-boolean-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +get the value of a boolean array element without validating it + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-array-member-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-array-member-value.md index 08a6ad6a9e..a564a2dd68 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-array-member-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-array-member-value.md @@ -1,51 +1,49 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getBooleanArrayMemberValue](get-boolean-array-member-value.md) - -# getBooleanArrayMemberValue - - -public [getBooleanArrayMemberValue](get-boolean-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -get the value of an 1D boolean array element - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getBooleanArrayMemberValue](get-boolean-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -get the value of a boolean array element - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getBooleanArrayMemberValue + + +public [getBooleanArrayMemberValue](get-boolean-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +get the value of an 1D boolean array element + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getBooleanArrayMemberValue](get-boolean-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +get the value of a boolean array element + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-member-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-member-value-absolute.md index 2714d44180..af23e7c2ec 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-member-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-member-value-absolute.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getBooleanMemberValueAbsolute](get-boolean-member-value-absolute.md) - -# getBooleanMemberValueAbsolute - - -public [getBooleanMemberValueAbsolute](get-boolean-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of boolean member without validating it - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getBooleanMemberValueAbsolute + + +public [getBooleanMemberValueAbsolute](get-boolean-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of boolean member without validating it + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-member-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-member-value.md index 5bcc0a01fc..906cf689d1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-member-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-member-value.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getBooleanMemberValue](get-boolean-member-value.md) - -# getBooleanMemberValue - - -public [getBooleanMemberValue](get-boolean-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets the value of boolean member - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getBooleanMemberValue + + +public [getBooleanMemberValue](get-boolean-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets the value of boolean member + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-class-u-r-l.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-class-u-r-l.md index a68986c9c2..8d3d361cd0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-class-u-r-l.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-class-u-r-l.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getClassURL](get-class-u-r-l.md) - -# getClassURL - - -public [getClassURL](get-class-u-r-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets class URL - -#### Return - -URL of the class - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getClassURL + + +public [getClassURL](get-class-u-r-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets class URL + +#### Return + +URL of the class + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-description.md index f3c344ec57..f0c010045f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-description.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getDescription](get-description.md) - -# getDescription - - -public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the description for the variable - -#### Return - -the description of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDescription + + +public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the description for the variable + +#### Return + +the description of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-array-member-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-array-member-value-absolute.md index e8ae00a89c..aec17f1936 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-array-member-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-array-member-value-absolute.md @@ -1,51 +1,49 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getDoubleArrayMemberValueAbsolute](get-double-array-member-value-absolute.md) - -# getDoubleArrayMemberValueAbsolute - - -public [getDoubleArrayMemberValueAbsolute](get-double-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -get the value of an 1D double array element without validating it - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getDoubleArrayMemberValueAbsolute](get-double-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -get the value of a double array element without validating it - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDoubleArrayMemberValueAbsolute + + +public [getDoubleArrayMemberValueAbsolute](get-double-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +get the value of an 1D double array element without validating it + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getDoubleArrayMemberValueAbsolute](get-double-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +get the value of a double array element without validating it + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-array-member-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-array-member-value.md index 53a0768a1c..6f655f71e4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-array-member-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-array-member-value.md @@ -1,51 +1,49 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getDoubleArrayMemberValue](get-double-array-member-value.md) - -# getDoubleArrayMemberValue - - -public [getDoubleArrayMemberValue](get-double-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -get the value of an 1D double array element - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getDoubleArrayMemberValue](get-double-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -get the value of a double array element - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDoubleArrayMemberValue + + +public [getDoubleArrayMemberValue](get-double-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +get the value of an 1D double array element + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getDoubleArrayMemberValue](get-double-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +get the value of a double array element + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-member-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-member-value-absolute.md index 3fdf8baf68..90f0335a24 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-member-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-member-value-absolute.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getDoubleMemberValueAbsolute](get-double-member-value-absolute.md) - -# getDoubleMemberValueAbsolute - - -public [getDoubleMemberValueAbsolute](get-double-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of a double member without validating it - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDoubleMemberValueAbsolute + + +public [getDoubleMemberValueAbsolute](get-double-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of a double member without validating it + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-member-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-member-value.md index 7e9c89d8f6..c58d8f699c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-member-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-member-value.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getDoubleMemberValue](get-double-member-value.md) - -# getDoubleMemberValue - - -public [getDoubleMemberValue](get-double-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of a double member - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDoubleMemberValue + + +public [getDoubleMemberValue](get-double-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of a double member + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-file-extension.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-file-extension.md index ce6e026959..1db2ac87e5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-file-extension.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-file-extension.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getFileExtension](get-file-extension.md) - -# getFileExtension - - -public [getFileExtension](get-file-extension.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -return file extension of a file member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getFileExtension + + +public [getFileExtension](get-file-extension.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +return file extension of a file member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-file-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-file-name.md index 8252c9d7dc..83eea8c303 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-file-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-file-name.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getFileName](get-file-name.md) - -# getFileName - - -public [getFileName](get-file-name.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -return file name of a file member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getFileName + + +public [getFileName](get-file-name.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +return file name of a file member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-index-str.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-index-str.md index 725b6b494e..57ce302fb3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-index-str.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-index-str.md @@ -1,37 +1,35 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getIndexStr](get-index-str.md) - -# getIndexStr - - -public [getIndexStr](get-index-str.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -return ModelCenter style array index as a string - -#### Return - -array index string (e.g., "[2]") - -#### Parameters - - - -| | | -|---|---| -| index | array index | - - -public [getIndexStr](get-index-str.md)(index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -return ModelCenter style array index as a string - -#### Return - -array index string (e.g., "[2,3]") - -#### Parameters - - - -| | | -|---|---| -| index | array index | +# getIndexStr + + +public [getIndexStr](get-index-str.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +return ModelCenter style array index as a string + +#### Return + +array index string (e.g., "[2]") + +#### Parameters + + + +| | | +|---|---| +| index | array index | + + +public [getIndexStr](get-index-str.md)(index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +return ModelCenter style array index as a string + +#### Return + +array index string (e.g., "[2,3]") + +#### Parameters + + + +| | | +|---|---| +| index | array index | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-array-member-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-array-member-value-absolute.md index d3ec3d8a53..397cef6f80 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-array-member-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-array-member-value-absolute.md @@ -1,51 +1,49 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getIntArrayMemberValueAbsolute](get-int-array-member-value-absolute.md) - -# getIntArrayMemberValueAbsolute - - -public [getIntArrayMemberValueAbsolute](get-int-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -get the value of an 1D integer array element without validating it - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getIntArrayMemberValueAbsolute](get-int-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -get the value of an integer array element without validating it - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getIntArrayMemberValueAbsolute + + +public [getIntArrayMemberValueAbsolute](get-int-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +get the value of an 1D integer array element without validating it + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getIntArrayMemberValueAbsolute](get-int-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +get the value of an integer array element without validating it + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-array-member-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-array-member-value.md index ebafa0fdc7..26e4e87a6c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-array-member-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-array-member-value.md @@ -1,51 +1,49 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getIntArrayMemberValue](get-int-array-member-value.md) - -# getIntArrayMemberValue - - -public [getIntArrayMemberValue](get-int-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -get the value of an 1D integer array element - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getIntArrayMemberValue](get-int-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -get the value of an integer array element - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getIntArrayMemberValue + + +public [getIntArrayMemberValue](get-int-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +get the value of an 1D integer array element + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getIntArrayMemberValue](get-int-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +get the value of an integer array element + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-member-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-member-value-absolute.md index 15ca355063..da45caebe4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-member-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-member-value-absolute.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getIntMemberValueAbsolute](get-int-member-value-absolute.md) - -# getIntMemberValueAbsolute - - -public [getIntMemberValueAbsolute](get-int-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -gets the value of an integer member without validating it - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getIntMemberValueAbsolute + + +public [getIntMemberValueAbsolute](get-int-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +gets the value of an integer member without validating it + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-member-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-member-value.md index 5ce0866a34..135de93b99 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-member-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-member-value.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getIntMemberValue](get-int-member-value.md) - -# getIntMemberValue - - -public [getIntMemberValue](get-int-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -gets the value of an integer member - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getIntMemberValue + + +public [getIntMemberValue](get-int-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +gets the value of an integer member + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-is-binary.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-is-binary.md index b401bcf48e..a261739cd7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-is-binary.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-is-binary.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getIsBinary](get-is-binary.md) - -# getIsBinary - - -public [getIsBinary](get-is-binary.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -return true if the file member contains a binary file - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getIsBinary + + +public [getIsBinary](get-is-binary.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +return true if the file member contains a binary file + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-description.md index a609840e1b..a3ad39bd93 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-description.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getMemberDescription](get-member-description.md) - -# getMemberDescription - - -public [getMemberDescription](get-member-description.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -get description of the member - -#### Return - -description of the member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getMemberDescription + + +public [getMemberDescription](get-member-description.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +get description of the member + +#### Return + +description of the member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-dimensions.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-dimensions.md index 04f97f0276..7cb1f9251b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-dimensions.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-dimensions.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getMemberDimensions](get-member-dimensions.md) - -# getMemberDimensions - - -public [getMemberDimensions](get-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)> - -get dimensions and size of an array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getMemberDimensions + + +public [getMemberDimensions](get-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)> + +get dimensions and size of an array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-enum-aliases.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-enum-aliases.md index bf28ffc69e..56c09232ed 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-enum-aliases.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-enum-aliases.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getMemberEnumAliases](get-member-enum-aliases.md) - -# getMemberEnumAliases - - -public [getMemberEnumAliases](get-member-enum-aliases.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -get enum aliases of the member - -#### Return - -enum aliases of the member as a comma separated string - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getMemberEnumAliases + + +public [getMemberEnumAliases](get-member-enum-aliases.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +get enum aliases of the member + +#### Return + +enum aliases of the member as a comma separated string + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-enum-values.md index daf068f7a9..c5087624d9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-enum-values.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getMemberEnumValues](get-member-enum-values.md) - -# getMemberEnumValues - - -public [getMemberEnumValues](get-member-enum-values.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -return enum values of the member - -#### Return - -enum values of the member as a comma separated string - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getMemberEnumValues + + +public [getMemberEnumValues](get-member-enum-values.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +return enum values of the member + +#### Return + +enum values of the member as a comma separated string + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-index.md index 0da406f9bb..c7d617ca0a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-index.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getMemberIndex](get-member-index.md) - -# getMemberIndex - - -public [getMemberIndex](get-member-index.md)(fullMemberName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -return member name from a full variable name - -#### Return - -member name (e.g., member1 from Model.comp1.obj.member1) - -#### Parameters - - - -| | | -|---|---| -| fullMemberName | full variable name (e.g., Model.comp1.obj.member1) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getMemberIndex + + +public [getMemberIndex](get-member-index.md)(fullMemberName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +return member name from a full variable name + +#### Return + +member name (e.g., member1 from Model.comp1.obj.member1) + +#### Parameters + + + +| | | +|---|---| +| fullMemberName | full variable name (e.g., Model.comp1.obj.member1) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-length.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-length.md index 18a96fe88a..23390eccab 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-length.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-length.md @@ -1,27 +1,25 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getMemberLength](get-member-length.md) - -# getMemberLength - - -public [getMemberLength](get-member-length.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -get length of an array member - -#### Return - -length of the array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| dimension | dimension id of the array member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getMemberLength + + +public [getMemberLength](get-member-length.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +get length of an array member + +#### Return + +length of the array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| dimension | dimension id of the array member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-list.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-list.md index 00b7e7ef9e..0670679397 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-list.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-list.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getMemberList](get-member-list.md) - -# getMemberList - - -public [getMemberList](get-member-list.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> - -get a list of child members. - -#### Return - -String array of child names - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the parent member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getMemberList + + +public [getMemberList](get-member-list.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> + +get a list of child members. + +#### Return + +String array of child names + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the parent member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-lower-bound.md index 50f2f00368..b0de456f40 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-lower-bound.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getMemberLowerBound](get-member-lower-bound.md) - -# getMemberLowerBound - - -public [getMemberLowerBound](get-member-lower-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -get lowerBound of a member - -#### Return - -lowerBound of the member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getMemberLowerBound + + +public [getMemberLowerBound](get-member-lower-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +get lowerBound of a member + +#### Return + +lowerBound of the member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-num-dimensions.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-num-dimensions.md index 36829c1652..6600c73a25 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-num-dimensions.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-num-dimensions.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getMemberNumDimensions](get-member-num-dimensions.md) - -# getMemberNumDimensions - - -public [getMemberNumDimensions](get-member-num-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) - -get number of dimensions of an array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getMemberNumDimensions + + +public [getMemberNumDimensions](get-member-num-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) + +get number of dimensions of an array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-property.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-property.md index 8e8e68691d..f20458c0a6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-property.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-property.md @@ -1,27 +1,25 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getMemberProperty](get-member-property.md) - -# getMemberProperty - - -public [getMemberProperty](get-member-property.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), propertyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -get value of a property of the member - -#### Return - -value of a property of the member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| propertyName | name of the property | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getMemberProperty + + +public [getMemberProperty](get-member-property.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), propertyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +get value of a property of the member + +#### Return + +value of a property of the member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| propertyName | name of the property | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-type.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-type.md index 7c8c3fd2c4..c272cfe31d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-type.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-type.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getMemberType](get-member-type.md) - -# getMemberType - - -public [getMemberType](get-member-type.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -return type of the member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getMemberType + + +public [getMemberType](get-member-type.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +return type of the member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-units.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-units.md index a521de4a83..5ab9448976 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-units.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-units.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getMemberUnits](get-member-units.md) - -# getMemberUnits - - -public [getMemberUnits](get-member-units.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -get units of the member - -#### Return - -units of the member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getMemberUnits + + +public [getMemberUnits](get-member-units.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +get units of the member + +#### Return + +units of the member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-upper-bound.md index bb6f077fd3..2baf4ba17b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-upper-bound.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getMemberUpperBound](get-member-upper-bound.md) - -# getMemberUpperBound - - -public [getMemberUpperBound](get-member-upper-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -return upperBound of the member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getMemberUpperBound + + +public [getMemberUpperBound](get-member-upper-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +return upperBound of the member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-value-absolute-as-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-value-absolute-as-string.md index 5d7655f37c..4ad3e5a65b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-value-absolute-as-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-value-absolute-as-string.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getMemberValueAbsoluteAsString](get-member-value-absolute-as-string.md) - -# getMemberValueAbsoluteAsString - - -public [getMemberValueAbsoluteAsString](get-member-value-absolute-as-string.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of a member as a string without validating it - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getMemberValueAbsoluteAsString + + +public [getMemberValueAbsoluteAsString](get-member-value-absolute-as-string.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of a member as a string without validating it + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-value-as-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-value-as-string.md index 428d7cb1af..fb8bdff09f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-value-as-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-value-as-string.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getMemberValueAsString](get-member-value-as-string.md) - -# getMemberValueAsString - - -public [getMemberValueAsString](get-member-value-as-string.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of a member as a string - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index (e.g., member1, grp1.member1, member1[1], member1[1,2]) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getMemberValueAsString + + +public [getMemberValueAsString](get-member-value-as-string.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of a member as a string + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index (e.g., member1, grp1.member1, member1[1], member1[1,2]) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-method-list.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-method-list.md index 6ffbc20e99..22c7bc88ce 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-method-list.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-method-list.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getMethodList](get-method-list.md) - -# getMethodList - - -public [getMethodList](get-method-list.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> - -get a list of methods - -#### Return - -String array of methods - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getMethodList + + +public [getMethodList](get-method-list.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> + +get a list of methods + +#### Return + +String array of methods + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-array-member-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-array-member-value-absolute.md index 8767817b5a..abf80b9e9e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-array-member-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-array-member-value-absolute.md @@ -1,51 +1,49 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getStringArrayMemberValueAbsolute](get-string-array-member-value-absolute.md) - -# getStringArrayMemberValueAbsolute - - -public [getStringArrayMemberValueAbsolute](get-string-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -get the value of an 1D String array element without validating it - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getStringArrayMemberValueAbsolute](get-string-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -get the value of a string array element without validating it - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getStringArrayMemberValueAbsolute + + +public [getStringArrayMemberValueAbsolute](get-string-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +get the value of an 1D String array element without validating it + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getStringArrayMemberValueAbsolute](get-string-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +get the value of a string array element without validating it + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-array-member-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-array-member-value.md index f2515b6ebd..2779391593 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-array-member-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-array-member-value.md @@ -1,51 +1,49 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getStringArrayMemberValue](get-string-array-member-value.md) - -# getStringArrayMemberValue - - -public [getStringArrayMemberValue](get-string-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -get the value of an 1D String array element - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getStringArrayMemberValue](get-string-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -get the value of a string array element - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getStringArrayMemberValue + + +public [getStringArrayMemberValue](get-string-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +get the value of an 1D String array element + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getStringArrayMemberValue](get-string-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +get the value of a string array element + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-member-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-member-value-absolute.md index 06510bf990..df2ed4a962 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-member-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-member-value-absolute.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getStringMemberValueAbsolute](get-string-member-value-absolute.md) - -# getStringMemberValueAbsolute - - -public [getStringMemberValueAbsolute](get-string-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of string member without validating it - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getStringMemberValueAbsolute + + +public [getStringMemberValueAbsolute](get-string-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of string member without validating it + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-member-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-member-value.md index 1a918e1f6c..b45ec36636 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-member-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-member-value.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[getStringMemberValue](get-string-member-value.md) - -# getStringMemberValue - - -public [getStringMemberValue](get-string-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of string member - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getStringMemberValue + + +public [getStringMemberValue](get-string-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of string member + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/has-member-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/has-member-lower-bound.md index 470d87909c..dbcdc8542d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/has-member-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/has-member-lower-bound.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[hasMemberLowerBound](has-member-lower-bound.md) - -# hasMemberLowerBound - - -public [hasMemberLowerBound](has-member-lower-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -check if a member has lower bound defined - -#### Return - -true if the member has lower bound defined - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# hasMemberLowerBound + + +public [hasMemberLowerBound](has-member-lower-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +check if a member has lower bound defined + +#### Return + +true if the member has lower bound defined + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/has-member-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/has-member-upper-bound.md index 1f7298c533..d9ecb08d4c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/has-member-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/has-member-upper-bound.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[hasMemberUpperBound](has-member-upper-bound.md) - -# hasMemberUpperBound - - -public [hasMemberUpperBound](has-member-upper-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -check if a member has lower bound defined - -#### Return - -true if the member has upper bound defined - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# hasMemberUpperBound + + +public [hasMemberUpperBound](has-member-upper-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +check if a member has lower bound defined + +#### Return + +true if the member has upper bound defined + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/has-member.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/has-member.md index a1f194d648..3b806603c7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/has-member.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/has-member.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[hasMember](has-member.md) - -# hasMember - - -public [hasMember](has-member.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -check if a member exists - -#### Return - -true if the member exists - -#### Parameters - - - -| | | -|---|---| -| mIndex | member name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# hasMember + + +public [hasMember](has-member.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +check if a member exists + +#### Return + +true if the member exists + +#### Parameters + + + +| | | +|---|---| +| mIndex | member name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/index.md index b730283008..755c9ff7b6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/index.md @@ -1,119 +1,117 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md) - -# ObjectVariable - - -public class [ObjectVariable](index.md) : [Variable](../-variable/index.md) - -An array type class for ModelCenter - -#### Author - -Woyak, 10/2001 - -## Functions - -| Name | Summary | -|---|---| -| [callMethod](call-method.md) | public [callMethod](call-method.md)(method: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
call a method | -| [deleteAllMembers](delete-all-members.md) | public [deleteAllMembers](delete-all-members.md)()
delete all members for non-strict type object. | -| [deleteMember](delete-member.md) | public [deleteMember](delete-member.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
delete a member for non-strict type object. | -| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromFile](from-file.md) | public [fromFile](from-file.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
load a file into a file member | -| [fromString](../-variable/from-string.md) | public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | -| [fromXML](from-x-m-l.md) | public [fromXML](from-x-m-l.md)(xmlStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
update the object from an XML string | -| [getBooleanArrayMemberValue](get-boolean-array-member-value.md) | public [getBooleanArrayMemberValue](get-boolean-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
get the value of an 1D boolean array element
public [getBooleanArrayMemberValue](get-boolean-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
get the value of a boolean array element | -| [getBooleanArrayMemberValueAbsolute](get-boolean-array-member-value-absolute.md) | public [getBooleanArrayMemberValueAbsolute](get-boolean-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
get the value of an 1D boolean array element without validating it
public [getBooleanArrayMemberValueAbsolute](get-boolean-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
get the value of a boolean array element without validating it | -| [getBooleanMemberValue](get-boolean-member-value.md) | public [getBooleanMemberValue](get-boolean-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the value of boolean member | -| [getBooleanMemberValueAbsolute](get-boolean-member-value-absolute.md) | public [getBooleanMemberValueAbsolute](get-boolean-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the value of boolean member without validating it | -| [getClassURL](get-class-u-r-l.md) | public [getClassURL](get-class-u-r-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets class URL | -| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | -| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | -| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | -| [getDoubleArrayMemberValue](get-double-array-member-value.md) | public [getDoubleArrayMemberValue](get-double-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
get the value of an 1D double array element
public [getDoubleArrayMemberValue](get-double-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
get the value of a double array element | -| [getDoubleArrayMemberValueAbsolute](get-double-array-member-value-absolute.md) | public [getDoubleArrayMemberValueAbsolute](get-double-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
get the value of an 1D double array element without validating it
public [getDoubleArrayMemberValueAbsolute](get-double-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
get the value of a double array element without validating it | -| [getDoubleMemberValue](get-double-member-value.md) | public [getDoubleMemberValue](get-double-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the value of a double member | -| [getDoubleMemberValueAbsolute](get-double-member-value-absolute.md) | public [getDoubleMemberValueAbsolute](get-double-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the value of a double member without validating it | -| [getFileExtension](get-file-extension.md) | public [getFileExtension](get-file-extension.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
return file extension of a file member | -| [getFileName](get-file-name.md) | public [getFileName](get-file-name.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
return file name of a file member | -| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | -| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | -| [getIndexStr](get-index-str.md) | public [getIndexStr](get-index-str.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getIndexStr](get-index-str.md)(index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
return ModelCenter style array index as a string | -| [getIntArrayMemberValue](get-int-array-member-value.md) | public [getIntArrayMemberValue](get-int-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the value of an 1D integer array element
public [getIntArrayMemberValue](get-int-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the value of an integer array element | -| [getIntArrayMemberValueAbsolute](get-int-array-member-value-absolute.md) | public [getIntArrayMemberValueAbsolute](get-int-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the value of an 1D integer array element without validating it
public [getIntArrayMemberValueAbsolute](get-int-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the value of an integer array element without validating it | -| [getIntMemberValue](get-int-member-value.md) | public [getIntMemberValue](get-int-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the value of an integer member | -| [getIntMemberValueAbsolute](get-int-member-value-absolute.md) | public [getIntMemberValueAbsolute](get-int-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the value of an integer member without validating it | -| [getIsBinary](get-is-binary.md) | public [getIsBinary](get-is-binary.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
return true if the file member contains a binary file | -| [getMemberDescription](get-member-description.md) | public [getMemberDescription](get-member-description.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get description of the member | -| [getMemberDimensions](get-member-dimensions.md) | public [getMemberDimensions](get-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)>
get dimensions and size of an array member | -| [getMemberEnumAliases](get-member-enum-aliases.md) | public [getMemberEnumAliases](get-member-enum-aliases.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get enum aliases of the member | -| [getMemberEnumValues](get-member-enum-values.md) | public [getMemberEnumValues](get-member-enum-values.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
return enum values of the member | -| [getMemberIndex](get-member-index.md) | public [getMemberIndex](get-member-index.md)(fullMemberName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
return member name from a full variable name | -| [getMemberLength](get-member-length.md) | public [getMemberLength](get-member-length.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
get length of an array member | -| [getMemberList](get-member-list.md) | public [getMemberList](get-member-list.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>
get a list of child members. | -| [getMemberLowerBound](get-member-lower-bound.md) | public [getMemberLowerBound](get-member-lower-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
get lowerBound of a member | -| [getMemberNumDimensions](get-member-num-dimensions.md) | public [getMemberNumDimensions](get-member-num-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
get number of dimensions of an array member | -| [getMemberProperty](get-member-property.md) | public [getMemberProperty](get-member-property.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), propertyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get value of a property of the member | -| [getMemberType](get-member-type.md) | public [getMemberType](get-member-type.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
return type of the member | -| [getMemberUnits](get-member-units.md) | public [getMemberUnits](get-member-units.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get units of the member | -| [getMemberUpperBound](get-member-upper-bound.md) | public [getMemberUpperBound](get-member-upper-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
return upperBound of the member | -| [getMemberValueAbsoluteAsString](get-member-value-absolute-as-string.md) | public [getMemberValueAbsoluteAsString](get-member-value-absolute-as-string.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the value of a member as a string without validating it | -| [getMemberValueAsString](get-member-value-as-string.md) | public [getMemberValueAsString](get-member-value-as-string.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the value of a member as a string | -| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getMethodList](get-method-list.md) | public [getMethodList](get-method-list.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>
get a list of methods | -| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | -| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | -| [getStringArrayMemberValue](get-string-array-member-value.md) | public [getStringArrayMemberValue](get-string-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the value of an 1D String array element
public [getStringArrayMemberValue](get-string-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the value of a string array element | -| [getStringArrayMemberValueAbsolute](get-string-array-member-value-absolute.md) | public [getStringArrayMemberValueAbsolute](get-string-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the value of an 1D String array element without validating it
public [getStringArrayMemberValueAbsolute](get-string-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the value of a string array element without validating it | -| [getStringMemberValue](get-string-member-value.md) | public [getStringMemberValue](get-string-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the value of string member | -| [getStringMemberValueAbsolute](get-string-member-value-absolute.md) | public [getStringMemberValueAbsolute](get-string-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the value of string member without validating it | -| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | -| [hasMember](has-member.md) | public [hasMember](has-member.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
check if a member exists | -| [hasMemberLowerBound](has-member-lower-bound.md) | public [hasMemberLowerBound](has-member-lower-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
check if a member has lower bound defined | -| [hasMemberUpperBound](has-member-upper-bound.md) | public [hasMemberUpperBound](has-member-upper-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
check if a member has lower bound defined | -| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | -| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | -| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | -| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | -| [isNonStrictType](is-non-strict-type.md) | public [isNonStrictType](is-non-strict-type.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
check whether a class is a non-strict type | -| [isNumericMember](is-numeric-member.md) | public [isNumericMember](is-numeric-member.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
check if a member is a numeric type | -| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | -| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | -| [reinitialize](reinitialize.md) | public [reinitialize](reinitialize.md)()
reinitialize the object using the current class type | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setBooleanArrayMemberValue](set-boolean-array-member-value.md) | public [setBooleanArrayMemberValue](set-boolean-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the value of an 1D boolean array member
public [setBooleanArrayMemberValue](set-boolean-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the value of a boolean array member | -| [setBooleanMemberValue](set-boolean-member-value.md) | public [setBooleanMemberValue](set-boolean-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the value of a boolean member | -| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | -| [setDoubleArrayMemberValue](set-double-array-member-value.md) | public [setDoubleArrayMemberValue](set-double-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
sets the value of a 1D double array member
public [setDoubleArrayMemberValue](set-double-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
sets the value of a double array member | -| [setDoubleMemberValue](set-double-member-value.md) | public [setDoubleMemberValue](set-double-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
sets the value of a double member | -| [setFileExtension](set-file-extension.md) | public [setFileExtension](set-file-extension.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileExtension: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set file extension of a file member | -| [setFileName](set-file-name.md) | public [setFileName](set-file-name.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set file name of a file member | -| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | -| [setIntArrayMemberValue](set-int-array-member-value.md) | public [setIntArrayMemberValue](set-int-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
sets the value of an 1D integer array member
public [setIntArrayMemberValue](set-int-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, value: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
sets the value of an integer array member | -| [setIntMemberValue](set-int-member-value.md) | public [setIntMemberValue](set-int-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
sets the value of an integer member | -| [setIsBinary](set-is-binary.md) | public [setIsBinary](set-is-binary.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isBinary: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
set binary flag for a file member | -| [setMemberDescription](set-member-description.md) | public [setMemberDescription](set-member-description.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set description of the member | -| [setMemberDimensions](set-member-dimensions.md) | public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
set dimension of an array member | -| [setMemberEnumAliases](set-member-enum-aliases.md) | public [setMemberEnumAliases](set-member-enum-aliases.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set enum aliases of the member | -| [setMemberEnumValues](set-member-enum-values.md) | public [setMemberEnumValues](set-member-enum-values.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set enum values of the member | -| [setMemberFromString](set-member-from-string.md) | public [setMemberFromString](set-member-from-string.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value of a member. | -| [setMemberLength](set-member-length.md) | public [setMemberLength](set-member-length.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), length: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
set length of an array member | -| [setMemberLowerBound](set-member-lower-bound.md) | public [setMemberLowerBound](set-member-lower-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), lowerBound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
set lowerBound of the member | -| [setMemberProperty](set-member-property.md) | public [setMemberProperty](set-member-property.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), propertyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), propertyValue: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set value of a property of the member | -| [setMemberUnits](set-member-units.md) | public [setMemberUnits](set-member-units.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set units of the member | -| [setMemberUpperBound](set-member-upper-bound.md) | public [setMemberUpperBound](set-member-upper-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), upperBound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
set upperBound of the member | -| [setMemberValueFromString](set-member-value-from-string.md) | public [setMemberValueFromString](set-member-value-from-string.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value of a member from string | -| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setStringArrayMemberValue](set-string-array-member-value.md) | public [setStringArrayMemberValue](set-string-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value of a 1D string array member
public [setStringArrayMemberValue](set-string-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value of a string array member | -| [setStringMemberValue](set-string-member-value.md) | public [setStringMemberValue](set-string-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value of a string member | -| [toFile](to-file.md) | public [toFile](to-file.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
write a file member to a file | -| [toFileAbsolute](to-file-absolute.md) | public [toFileAbsolute](to-file-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
write a file member to a file without validating the variable | -| [toString](../-variable/to-string.md) | public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [toStringAbsolute](../-variable/to-string-absolute.md) | public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [toXML](to-x-m-l.md) | public [toXML](to-x-m-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | -| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | +# ObjectVariable + + +public class [ObjectVariable](index.md) : [Variable](../-variable/index.md) + +An array type class for ModelCenter + +#### Author + +Woyak, 10/2001 + +## Functions + +| Name | Summary | +|---|---| +| [callMethod](call-method.md) | public [callMethod](call-method.md)(method: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
call a method | +| [deleteAllMembers](delete-all-members.md) | public [deleteAllMembers](delete-all-members.md)()
delete all members for non-strict type object. | +| [deleteMember](delete-member.md) | public [deleteMember](delete-member.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
delete a member for non-strict type object. | +| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromFile](from-file.md) | public [fromFile](from-file.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
load a file into a file member | +| [fromString](../-variable/from-string.md) | public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | +| [fromXML](from-x-m-l.md) | public [fromXML](from-x-m-l.md)(xmlStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
update the object from an XML string | +| [getBooleanArrayMemberValue](get-boolean-array-member-value.md) | public [getBooleanArrayMemberValue](get-boolean-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
get the value of an 1D boolean array element
public [getBooleanArrayMemberValue](get-boolean-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
get the value of a boolean array element | +| [getBooleanArrayMemberValueAbsolute](get-boolean-array-member-value-absolute.md) | public [getBooleanArrayMemberValueAbsolute](get-boolean-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
get the value of an 1D boolean array element without validating it
public [getBooleanArrayMemberValueAbsolute](get-boolean-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
get the value of a boolean array element without validating it | +| [getBooleanMemberValue](get-boolean-member-value.md) | public [getBooleanMemberValue](get-boolean-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the value of boolean member | +| [getBooleanMemberValueAbsolute](get-boolean-member-value-absolute.md) | public [getBooleanMemberValueAbsolute](get-boolean-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the value of boolean member without validating it | +| [getClassURL](get-class-u-r-l.md) | public [getClassURL](get-class-u-r-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets class URL | +| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | +| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | +| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | +| [getDoubleArrayMemberValue](get-double-array-member-value.md) | public [getDoubleArrayMemberValue](get-double-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
get the value of an 1D double array element
public [getDoubleArrayMemberValue](get-double-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
get the value of a double array element | +| [getDoubleArrayMemberValueAbsolute](get-double-array-member-value-absolute.md) | public [getDoubleArrayMemberValueAbsolute](get-double-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
get the value of an 1D double array element without validating it
public [getDoubleArrayMemberValueAbsolute](get-double-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
get the value of a double array element without validating it | +| [getDoubleMemberValue](get-double-member-value.md) | public [getDoubleMemberValue](get-double-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the value of a double member | +| [getDoubleMemberValueAbsolute](get-double-member-value-absolute.md) | public [getDoubleMemberValueAbsolute](get-double-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the value of a double member without validating it | +| [getFileExtension](get-file-extension.md) | public [getFileExtension](get-file-extension.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
return file extension of a file member | +| [getFileName](get-file-name.md) | public [getFileName](get-file-name.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
return file name of a file member | +| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | +| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | +| [getIndexStr](get-index-str.md) | public [getIndexStr](get-index-str.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getIndexStr](get-index-str.md)(index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
return ModelCenter style array index as a string | +| [getIntArrayMemberValue](get-int-array-member-value.md) | public [getIntArrayMemberValue](get-int-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the value of an 1D integer array element
public [getIntArrayMemberValue](get-int-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the value of an integer array element | +| [getIntArrayMemberValueAbsolute](get-int-array-member-value-absolute.md) | public [getIntArrayMemberValueAbsolute](get-int-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the value of an 1D integer array element without validating it
public [getIntArrayMemberValueAbsolute](get-int-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the value of an integer array element without validating it | +| [getIntMemberValue](get-int-member-value.md) | public [getIntMemberValue](get-int-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the value of an integer member | +| [getIntMemberValueAbsolute](get-int-member-value-absolute.md) | public [getIntMemberValueAbsolute](get-int-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the value of an integer member without validating it | +| [getIsBinary](get-is-binary.md) | public [getIsBinary](get-is-binary.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
return true if the file member contains a binary file | +| [getMemberDescription](get-member-description.md) | public [getMemberDescription](get-member-description.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get description of the member | +| [getMemberDimensions](get-member-dimensions.md) | public [getMemberDimensions](get-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)>
get dimensions and size of an array member | +| [getMemberEnumAliases](get-member-enum-aliases.md) | public [getMemberEnumAliases](get-member-enum-aliases.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get enum aliases of the member | +| [getMemberEnumValues](get-member-enum-values.md) | public [getMemberEnumValues](get-member-enum-values.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
return enum values of the member | +| [getMemberIndex](get-member-index.md) | public [getMemberIndex](get-member-index.md)(fullMemberName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
return member name from a full variable name | +| [getMemberLength](get-member-length.md) | public [getMemberLength](get-member-length.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
get length of an array member | +| [getMemberList](get-member-list.md) | public [getMemberList](get-member-list.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>
get a list of child members. | +| [getMemberLowerBound](get-member-lower-bound.md) | public [getMemberLowerBound](get-member-lower-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
get lowerBound of a member | +| [getMemberNumDimensions](get-member-num-dimensions.md) | public [getMemberNumDimensions](get-member-num-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
get number of dimensions of an array member | +| [getMemberProperty](get-member-property.md) | public [getMemberProperty](get-member-property.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), propertyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get value of a property of the member | +| [getMemberType](get-member-type.md) | public [getMemberType](get-member-type.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
return type of the member | +| [getMemberUnits](get-member-units.md) | public [getMemberUnits](get-member-units.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get units of the member | +| [getMemberUpperBound](get-member-upper-bound.md) | public [getMemberUpperBound](get-member-upper-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
return upperBound of the member | +| [getMemberValueAbsoluteAsString](get-member-value-absolute-as-string.md) | public [getMemberValueAbsoluteAsString](get-member-value-absolute-as-string.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the value of a member as a string without validating it | +| [getMemberValueAsString](get-member-value-as-string.md) | public [getMemberValueAsString](get-member-value-as-string.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the value of a member as a string | +| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getMethodList](get-method-list.md) | public [getMethodList](get-method-list.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)>
get a list of methods | +| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | +| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | +| [getStringArrayMemberValue](get-string-array-member-value.md) | public [getStringArrayMemberValue](get-string-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the value of an 1D String array element
public [getStringArrayMemberValue](get-string-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the value of a string array element | +| [getStringArrayMemberValueAbsolute](get-string-array-member-value-absolute.md) | public [getStringArrayMemberValueAbsolute](get-string-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the value of an 1D String array element without validating it
public [getStringArrayMemberValueAbsolute](get-string-array-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the value of a string array element without validating it | +| [getStringMemberValue](get-string-member-value.md) | public [getStringMemberValue](get-string-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the value of string member | +| [getStringMemberValueAbsolute](get-string-member-value-absolute.md) | public [getStringMemberValueAbsolute](get-string-member-value-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the value of string member without validating it | +| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | +| [hasMember](has-member.md) | public [hasMember](has-member.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
check if a member exists | +| [hasMemberLowerBound](has-member-lower-bound.md) | public [hasMemberLowerBound](has-member-lower-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
check if a member has lower bound defined | +| [hasMemberUpperBound](has-member-upper-bound.md) | public [hasMemberUpperBound](has-member-upper-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
check if a member has lower bound defined | +| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | +| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | +| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | +| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | +| [isNonStrictType](is-non-strict-type.md) | public [isNonStrictType](is-non-strict-type.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
check whether a class is a non-strict type | +| [isNumericMember](is-numeric-member.md) | public [isNumericMember](is-numeric-member.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
check if a member is a numeric type | +| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | +| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | +| [reinitialize](reinitialize.md) | public [reinitialize](reinitialize.md)()
reinitialize the object using the current class type | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setBooleanArrayMemberValue](set-boolean-array-member-value.md) | public [setBooleanArrayMemberValue](set-boolean-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the value of an 1D boolean array member
public [setBooleanArrayMemberValue](set-boolean-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the value of a boolean array member | +| [setBooleanMemberValue](set-boolean-member-value.md) | public [setBooleanMemberValue](set-boolean-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the value of a boolean member | +| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | +| [setDoubleArrayMemberValue](set-double-array-member-value.md) | public [setDoubleArrayMemberValue](set-double-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
sets the value of a 1D double array member
public [setDoubleArrayMemberValue](set-double-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
sets the value of a double array member | +| [setDoubleMemberValue](set-double-member-value.md) | public [setDoubleMemberValue](set-double-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
sets the value of a double member | +| [setFileExtension](set-file-extension.md) | public [setFileExtension](set-file-extension.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileExtension: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set file extension of a file member | +| [setFileName](set-file-name.md) | public [setFileName](set-file-name.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set file name of a file member | +| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | +| [setIntArrayMemberValue](set-int-array-member-value.md) | public [setIntArrayMemberValue](set-int-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
sets the value of an 1D integer array member
public [setIntArrayMemberValue](set-int-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, value: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
sets the value of an integer array member | +| [setIntMemberValue](set-int-member-value.md) | public [setIntMemberValue](set-int-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
sets the value of an integer member | +| [setIsBinary](set-is-binary.md) | public [setIsBinary](set-is-binary.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isBinary: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
set binary flag for a file member | +| [setMemberDescription](set-member-description.md) | public [setMemberDescription](set-member-description.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set description of the member | +| [setMemberDimensions](set-member-dimensions.md) | public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
set dimension of an array member | +| [setMemberEnumAliases](set-member-enum-aliases.md) | public [setMemberEnumAliases](set-member-enum-aliases.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set enum aliases of the member | +| [setMemberEnumValues](set-member-enum-values.md) | public [setMemberEnumValues](set-member-enum-values.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set enum values of the member | +| [setMemberFromString](set-member-from-string.md) | public [setMemberFromString](set-member-from-string.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value of a member. | +| [setMemberLength](set-member-length.md) | public [setMemberLength](set-member-length.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), length: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
set length of an array member | +| [setMemberLowerBound](set-member-lower-bound.md) | public [setMemberLowerBound](set-member-lower-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), lowerBound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
set lowerBound of the member | +| [setMemberProperty](set-member-property.md) | public [setMemberProperty](set-member-property.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), propertyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), propertyValue: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set value of a property of the member | +| [setMemberUnits](set-member-units.md) | public [setMemberUnits](set-member-units.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
set units of the member | +| [setMemberUpperBound](set-member-upper-bound.md) | public [setMemberUpperBound](set-member-upper-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), upperBound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
set upperBound of the member | +| [setMemberValueFromString](set-member-value-from-string.md) | public [setMemberValueFromString](set-member-value-from-string.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value of a member from string | +| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setStringArrayMemberValue](set-string-array-member-value.md) | public [setStringArrayMemberValue](set-string-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value of a 1D string array member
public [setStringArrayMemberValue](set-string-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value of a string array member | +| [setStringMemberValue](set-string-member-value.md) | public [setStringMemberValue](set-string-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value of a string member | +| [toFile](to-file.md) | public [toFile](to-file.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
write a file member to a file | +| [toFileAbsolute](to-file-absolute.md) | public [toFileAbsolute](to-file-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
write a file member to a file without validating the variable | +| [toString](../-variable/to-string.md) | public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [toStringAbsolute](../-variable/to-string-absolute.md) | public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [toXML](to-x-m-l.md) | public [toXML](to-x-m-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | +| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/is-non-strict-type.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/is-non-strict-type.md index 110c5e93c8..639c6e3d86 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/is-non-strict-type.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/is-non-strict-type.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[isNonStrictType](is-non-strict-type.md) - -# isNonStrictType - - -public [isNonStrictType](is-non-strict-type.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -check whether a class is a non-strict type - -#### Return - -true if the class is a non-strict type - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isNonStrictType + + +public [isNonStrictType](is-non-strict-type.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +check whether a class is a non-strict type + +#### Return + +true if the class is a non-strict type + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/is-numeric-member.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/is-numeric-member.md index 4bb6ac7c6e..a6680a38e1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/is-numeric-member.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/is-numeric-member.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[isNumericMember](is-numeric-member.md) - -# isNumericMember - - -public [isNumericMember](is-numeric-member.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -check if a member is a numeric type - -#### Return - -true if the member is a numeric type - -#### Parameters - - - -| | | -|---|---| -| mIndex | member name | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isNumericMember + + +public [isNumericMember](is-numeric-member.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +check if a member is a numeric type + +#### Return + +true if the member is a numeric type + +#### Parameters + + + +| | | +|---|---| +| mIndex | member name | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/reinitialize.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/reinitialize.md index 18a1d47146..0b088ba7ab 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/reinitialize.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/reinitialize.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[reinitialize](reinitialize.md) - -# reinitialize - - -public [reinitialize](reinitialize.md)() - -reinitialize the object using the current class type - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# reinitialize + + +public [reinitialize](reinitialize.md)() + +reinitialize the object using the current class type + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-boolean-array-member-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-boolean-array-member-value.md index b93f3d0438..924abceabe 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-boolean-array-member-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-boolean-array-member-value.md @@ -1,45 +1,43 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setBooleanArrayMemberValue](set-boolean-array-member-value.md) - -# setBooleanArrayMemberValue - - -public [setBooleanArrayMemberValue](set-boolean-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets the value of an 1D boolean array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | -| value | value of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setBooleanArrayMemberValue](set-boolean-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets the value of a boolean array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | -| value | value of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setBooleanArrayMemberValue + + +public [setBooleanArrayMemberValue](set-boolean-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets the value of an 1D boolean array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | +| value | value of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setBooleanArrayMemberValue](set-boolean-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets the value of a boolean array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | +| value | value of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-boolean-member-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-boolean-member-value.md index 704d21a473..338e259841 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-boolean-member-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-boolean-member-value.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setBooleanMemberValue](set-boolean-member-value.md) - -# setBooleanMemberValue - - -public [setBooleanMemberValue](set-boolean-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets the value of a boolean member - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| value | value of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setBooleanMemberValue + + +public [setBooleanMemberValue](set-boolean-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets the value of a boolean member + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| value | value of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-description.md index a767d002fe..0147b158ab 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-description.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setDescription](set-description.md) - -# setDescription - - -public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the description for the variable - -#### Parameters - - - -| | | -|---|---| -| description | the description of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDescription + + +public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the description for the variable + +#### Parameters + + + +| | | +|---|---| +| description | the description of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-double-array-member-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-double-array-member-value.md index 652cdb7037..8f96dff622 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-double-array-member-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-double-array-member-value.md @@ -1,45 +1,43 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setDoubleArrayMemberValue](set-double-array-member-value.md) - -# setDoubleArrayMemberValue - - -public [setDoubleArrayMemberValue](set-double-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) - -sets the value of a 1D double array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | -| value | value of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setDoubleArrayMemberValue](set-double-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) - -sets the value of a double array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | -| value | value of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDoubleArrayMemberValue + + +public [setDoubleArrayMemberValue](set-double-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) + +sets the value of a 1D double array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | +| value | value of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setDoubleArrayMemberValue](set-double-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) + +sets the value of a double array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | +| value | value of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-double-member-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-double-member-value.md index 0ca961f617..825698f4ee 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-double-member-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-double-member-value.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setDoubleMemberValue](set-double-member-value.md) - -# setDoubleMemberValue - - -public [setDoubleMemberValue](set-double-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) - -sets the value of a double member - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| value | value of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDoubleMemberValue + + +public [setDoubleMemberValue](set-double-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) + +sets the value of a double member + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| value | value of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-file-extension.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-file-extension.md index 919d9919d3..6bde5886ff 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-file-extension.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-file-extension.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setFileExtension](set-file-extension.md) - -# setFileExtension - - -public [setFileExtension](set-file-extension.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileExtension: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -set file extension of a file member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setFileExtension + + +public [setFileExtension](set-file-extension.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileExtension: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +set file extension of a file member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-file-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-file-name.md index f57fb4d1fc..7d85aa5cfe 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-file-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-file-name.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setFileName](set-file-name.md) - -# setFileName - - -public [setFileName](set-file-name.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -set file name of a file member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setFileName + + +public [setFileName](set-file-name.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +set file name of a file member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-int-array-member-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-int-array-member-value.md index b0bc7d39bb..445b181d33 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-int-array-member-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-int-array-member-value.md @@ -1,45 +1,43 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setIntArrayMemberValue](set-int-array-member-value.md) - -# setIntArrayMemberValue - - -public [setIntArrayMemberValue](set-int-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -sets the value of an 1D integer array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | -| value | value of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setIntArrayMemberValue](set-int-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, value: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -sets the value of an integer array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | -| value | value of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setIntArrayMemberValue + + +public [setIntArrayMemberValue](set-int-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +sets the value of an 1D integer array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | +| value | value of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setIntArrayMemberValue](set-int-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, value: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +sets the value of an integer array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | +| value | value of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-int-member-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-int-member-value.md index 0ae155a50f..cd40b91a89 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-int-member-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-int-member-value.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setIntMemberValue](set-int-member-value.md) - -# setIntMemberValue - - -public [setIntMemberValue](set-int-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -sets the value of an integer member - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| value | value of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setIntMemberValue + + +public [setIntMemberValue](set-int-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +sets the value of an integer member + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| value | value of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-is-binary.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-is-binary.md index 5511cdfe88..027d663972 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-is-binary.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-is-binary.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setIsBinary](set-is-binary.md) - -# setIsBinary - - -public [setIsBinary](set-is-binary.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isBinary: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -set binary flag for a file member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setIsBinary + + +public [setIsBinary](set-is-binary.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isBinary: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +set binary flag for a file member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-description.md index 1b8d1fad5c..41e666f5c7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-description.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setMemberDescription](set-member-description.md) - -# setMemberDescription - - -public [setMemberDescription](set-member-description.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -set description of the member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| description | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setMemberDescription + + +public [setMemberDescription](set-member-description.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +set description of the member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| description | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md index 09c5b71001..91bc493645 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md @@ -1,248 +1,246 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setMemberDimensions](set-member-dimensions.md) - -# setMemberDimensions - - -public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -set dimension of an array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| d1 | length of the 1st dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -set dimension of an array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| d1 | length of the 1st dimension | -| d2 | length of the 2nd dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -set dimension of an array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| d1 | length of the 1st dimension | -| d2 | length of the 2nd dimension | -| d3 | length of the 3rd dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -set dimension of an array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| d1 | length of the 1st dimension | -| d2 | length of the 2nd dimension | -| d3 | length of the 3rd dimension | -| d4 | length of the 4th dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -set dimension of an array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| d1 | length of the 1st dimension | -| d2 | length of the 2nd dimension | -| d3 | length of the 3rd dimension | -| d4 | length of the 4th dimension | -| d5 | length of the 5th dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -set dimension of an array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| d1 | length of the 1st dimension | -| d2 | length of the 2nd dimension | -| d3 | length of the 3rd dimension | -| d4 | length of the 4th dimension | -| d5 | length of the 5th dimension | -| d6 | length of the 6th dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -set dimension of an array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| d1 | length of the 1st dimension | -| d2 | length of the 2nd dimension | -| d3 | length of the 3rd dimension | -| d4 | length of the 4th dimension | -| d5 | length of the 5th dimension | -| d6 | length of the 6th dimension | -| d7 | length of the 7th dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -set dimension of an array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| d1 | length of the 1st dimension | -| d2 | length of the 2nd dimension | -| d3 | length of the 3rd dimension | -| d4 | length of the 4th dimension | -| d5 | length of the 5th dimension | -| d6 | length of the 6th dimension | -| d7 | length of the 7th dimension | -| d8 | length of the 8th dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -set dimension of an array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| d1 | length of the 1st dimension | -| d2 | length of the 2nd dimension | -| d3 | length of the 3rd dimension | -| d4 | length of the 4th dimension | -| d5 | length of the 5th dimension | -| d6 | length of the 6th dimension | -| d7 | length of the 7th dimension | -| d8 | length of the 8th dimension | -| d9 | length of the 9th dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -set dimension of an array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| d1 | length of the 1st dimension | -| d2 | length of the 2nd dimension | -| d3 | length of the 3rd dimension | -| d4 | length of the 4th dimension | -| d5 | length of the 5th dimension | -| d6 | length of the 6th dimension | -| d7 | length of the 7th dimension | -| d8 | length of the 8th dimension | -| d9 | length of the 9th dimension | -| d10 | length of the 10th dimension | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setMemberDimensions + + +public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +set dimension of an array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| d1 | length of the 1st dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +set dimension of an array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| d1 | length of the 1st dimension | +| d2 | length of the 2nd dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +set dimension of an array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| d1 | length of the 1st dimension | +| d2 | length of the 2nd dimension | +| d3 | length of the 3rd dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +set dimension of an array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| d1 | length of the 1st dimension | +| d2 | length of the 2nd dimension | +| d3 | length of the 3rd dimension | +| d4 | length of the 4th dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +set dimension of an array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| d1 | length of the 1st dimension | +| d2 | length of the 2nd dimension | +| d3 | length of the 3rd dimension | +| d4 | length of the 4th dimension | +| d5 | length of the 5th dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +set dimension of an array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| d1 | length of the 1st dimension | +| d2 | length of the 2nd dimension | +| d3 | length of the 3rd dimension | +| d4 | length of the 4th dimension | +| d5 | length of the 5th dimension | +| d6 | length of the 6th dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +set dimension of an array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| d1 | length of the 1st dimension | +| d2 | length of the 2nd dimension | +| d3 | length of the 3rd dimension | +| d4 | length of the 4th dimension | +| d5 | length of the 5th dimension | +| d6 | length of the 6th dimension | +| d7 | length of the 7th dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +set dimension of an array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| d1 | length of the 1st dimension | +| d2 | length of the 2nd dimension | +| d3 | length of the 3rd dimension | +| d4 | length of the 4th dimension | +| d5 | length of the 5th dimension | +| d6 | length of the 6th dimension | +| d7 | length of the 7th dimension | +| d8 | length of the 8th dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +set dimension of an array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| d1 | length of the 1st dimension | +| d2 | length of the 2nd dimension | +| d3 | length of the 3rd dimension | +| d4 | length of the 4th dimension | +| d5 | length of the 5th dimension | +| d6 | length of the 6th dimension | +| d7 | length of the 7th dimension | +| d8 | length of the 8th dimension | +| d9 | length of the 9th dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setMemberDimensions](set-member-dimensions.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +set dimension of an array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| d1 | length of the 1st dimension | +| d2 | length of the 2nd dimension | +| d3 | length of the 3rd dimension | +| d4 | length of the 4th dimension | +| d5 | length of the 5th dimension | +| d6 | length of the 6th dimension | +| d7 | length of the 7th dimension | +| d8 | length of the 8th dimension | +| d9 | length of the 9th dimension | +| d10 | length of the 10th dimension | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-enum-aliases.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-enum-aliases.md index 387f861e97..53718b708f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-enum-aliases.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-enum-aliases.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setMemberEnumAliases](set-member-enum-aliases.md) - -# setMemberEnumAliases - - -public [setMemberEnumAliases](set-member-enum-aliases.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -set enum aliases of the member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| enumAliases | enumerated aliases as a comma separated string | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setMemberEnumAliases + + +public [setMemberEnumAliases](set-member-enum-aliases.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +set enum aliases of the member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| enumAliases | enumerated aliases as a comma separated string | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-enum-values.md index cc73da8cff..f92bbfbdb3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-enum-values.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setMemberEnumValues](set-member-enum-values.md) - -# setMemberEnumValues - - -public [setMemberEnumValues](set-member-enum-values.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -set enum values of the member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| enumValues | enumerated values as a comma separated string | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setMemberEnumValues + + +public [setMemberEnumValues](set-member-enum-values.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +set enum values of the member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| enumValues | enumerated values as a comma separated string | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-from-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-from-string.md index 7acfd12533..0f001a2d2e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-from-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-from-string.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setMemberFromString](set-member-from-string.md) - -# setMemberFromString - - -public [setMemberFromString](set-member-from-string.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the value of a member. A new member will be create if the member does not exist or the current type is not the same as the type specified. - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| value | the value of the member | -| type | type of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setMemberFromString + + +public [setMemberFromString](set-member-from-string.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the value of a member. A new member will be create if the member does not exist or the current type is not the same as the type specified. + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| value | the value of the member | +| type | type of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-length.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-length.md index 6016dff607..e315f3e877 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-length.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-length.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setMemberLength](set-member-length.md) - -# setMemberLength - - -public [setMemberLength](set-member-length.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), length: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -set length of an array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| length | of the array | -| dimension | dimension id of the array member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setMemberLength + + +public [setMemberLength](set-member-length.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), length: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +set length of an array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| length | of the array | +| dimension | dimension id of the array member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-lower-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-lower-bound.md index d794cdcf96..1acdadc6c5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-lower-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-lower-bound.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setMemberLowerBound](set-member-lower-bound.md) - -# setMemberLowerBound - - -public [setMemberLowerBound](set-member-lower-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), lowerBound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) - -set lowerBound of the member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| lowerBound | lower bound | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setMemberLowerBound + + +public [setMemberLowerBound](set-member-lower-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), lowerBound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) + +set lowerBound of the member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| lowerBound | lower bound | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-property.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-property.md index 7d38d6b67f..10e2dd4ec5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-property.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-property.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setMemberProperty](set-member-property.md) - -# setMemberProperty - - -public [setMemberProperty](set-member-property.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), propertyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), propertyValue: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -set value of a property of the member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| propertyName | name of the property | -| propertyValue | value of the property | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setMemberProperty + + +public [setMemberProperty](set-member-property.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), propertyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), propertyValue: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +set value of a property of the member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| propertyName | name of the property | +| propertyValue | value of the property | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-units.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-units.md index fbb59b630f..aa53c0e9c9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-units.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-units.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setMemberUnits](set-member-units.md) - -# setMemberUnits - - -public [setMemberUnits](set-member-units.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -set units of the member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| units | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setMemberUnits + + +public [setMemberUnits](set-member-units.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), units: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +set units of the member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| units | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-upper-bound.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-upper-bound.md index 021b227dd2..c091df03dc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-upper-bound.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-upper-bound.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setMemberUpperBound](set-member-upper-bound.md) - -# setMemberUpperBound - - -public [setMemberUpperBound](set-member-upper-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), upperBound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) - -set upperBound of the member - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| upperBound | upper bound | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setMemberUpperBound + + +public [setMemberUpperBound](set-member-upper-bound.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), upperBound: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) + +set upperBound of the member + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| upperBound | upper bound | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-value-from-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-value-from-string.md index 3d7d7b968a..5e60595965 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-value-from-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-value-from-string.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setMemberValueFromString](set-member-value-from-string.md) - -# setMemberValueFromString - - -public [setMemberValueFromString](set-member-value-from-string.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the value of a member from string - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| value | the value of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setMemberValueFromString + + +public [setMemberValueFromString](set-member-value-from-string.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the value of a member from string + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| value | the value of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-string-array-member-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-string-array-member-value.md index 7c530567c0..af9183593e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-string-array-member-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-string-array-member-value.md @@ -1,45 +1,43 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setStringArrayMemberValue](set-string-array-member-value.md) - -# setStringArrayMemberValue - - -public [setStringArrayMemberValue](set-string-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the value of a 1D string array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | -| value | value of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setStringArrayMemberValue](set-string-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the value of a string array member - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| index | array index | -| value | value of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setStringArrayMemberValue + + +public [setStringArrayMemberValue](set-string-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the value of a 1D string array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | +| value | value of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setStringArrayMemberValue](set-string-array-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)>, value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the value of a string array member + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| index | array index | +| value | value of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-string-member-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-string-member-value.md index 1b4277e88e..db13895c35 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-string-member-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-string-member-value.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[setStringMemberValue](set-string-member-value.md) - -# setStringMemberValue - - -public [setStringMemberValue](set-string-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the value of a string member - -#### Parameters - - - -| | | -|---|---| -| mIndex | member index | -| value | value of the member | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setStringMemberValue + + +public [setStringMemberValue](set-string-member-value.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the value of a string member + +#### Parameters + + + +| | | +|---|---| +| mIndex | member index | +| value | value of the member | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/to-file-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/to-file-absolute.md index 63d67de3be..9f83f58216 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/to-file-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/to-file-absolute.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[toFileAbsolute](to-file-absolute.md) - -# toFileAbsolute - - -public [toFileAbsolute](to-file-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -write a file member to a file without validating the variable - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| fileName | destination file name | -| encoding | (e.g., utf8, binary, ascii) ascii is assumed if empty | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toFileAbsolute + + +public [toFileAbsolute](to-file-absolute.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +write a file member to a file without validating the variable + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| fileName | destination file name | +| encoding | (e.g., utf8, binary, ascii) ascii is assumed if empty | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/to-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/to-file.md index 9954db98cc..5285e6f02d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/to-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/to-file.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[toFile](to-file.md) - -# toFile - - -public [toFile](to-file.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -write a file member to a file - -#### Parameters - - - -| | | -|---|---| -| mIndex | name of the member | -| fileName | destination file name | -| encoding | (e.g., utf8, binary, ascii) ascii is assumed if empty | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toFile + + +public [toFile](to-file.md)(mIndex: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), encoding: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +write a file member to a file + +#### Parameters + + + +| | | +|---|---| +| mIndex | name of the member | +| fileName | destination file name | +| encoding | (e.g., utf8, binary, ascii) ascii is assumed if empty | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/to-x-m-l.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/to-x-m-l.md index 8f8dc916d8..7e7fdb5573 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/to-x-m-l.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-object-variable/to-x-m-l.md @@ -1,16 +1,14 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ObjectVariable](index.md)/[toXML](to-x-m-l.md) - -# toXML - - -public [toXML](to-x-m-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -#### Return - -XML representation of the object - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toXML + + +public [toXML](to-x-m-l.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +#### Return + +XML representation of the object + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-p-h-x-java-com-object-stored/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-p-h-x-java-com-object-stored/index.md index 7b0643d895..362994553f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-p-h-x-java-com-object-stored/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-p-h-x-java-com-object-stored/index.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[PHXJavaComObjectStored](index.md) - -# PHXJavaComObjectStored - - -interface [PHXJavaComObjectStored](index.md) - -## Functions - -| Name | Summary | -|---|---| -| [releaseCOMObjects](release-c-o-m-objects.md) | abstract fun [releaseCOMObjects](release-c-o-m-objects.md)()
release ModelCenter COM objects stored in the implementing object | +# PHXJavaComObjectStored + + +interface [PHXJavaComObjectStored](index.md) + +## Functions + +| Name | Summary | +|---|---| +| [releaseCOMObjects](release-c-o-m-objects.md) | abstract fun [releaseCOMObjects](release-c-o-m-objects.md)()
release ModelCenter COM objects stored in the implementing object | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-p-h-x-java-com-object-stored/release-c-o-m-objects.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-p-h-x-java-com-object-stored/release-c-o-m-objects.md index 7d90634daa..ed226e1716 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-p-h-x-java-com-object-stored/release-c-o-m-objects.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-p-h-x-java-com-object-stored/release-c-o-m-objects.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[PHXJavaComObjectStored](index.md)/[releaseCOMObjects](release-c-o-m-objects.md) - -# releaseCOMObjects - - -abstract fun [releaseCOMObjects](release-c-o-m-objects.md)() - -release ModelCenter COM objects stored in the implementing object - -#### Throws - -| | -|---| -| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | +# releaseCOMObjects + + +abstract fun [releaseCOMObjects](release-c-o-m-objects.md)() + +release ModelCenter COM objects stored in the implementing object + +#### Throws + +| | +|---| +| [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-description.md index 06504d8f17..07eea70228 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-description.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefArrayProp](index.md)/[getDescription](get-description.md) - -# getDescription - - -public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the description value - -#### Return - -the description value - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDescription + + +public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the description value + +#### Return + +the description value + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-enum-values.md index e752db2164..4f3d65e1f2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-enum-values.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefArrayProp](index.md)/[getEnumValues](get-enum-values.md) - -# getEnumValues - - -public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the enumerated value set - -#### Return - -a comma-separated list of enumerated values - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEnumValues + + +public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the enumerated value set + +#### Return + +a comma-separated list of enumerated values + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-is-input.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-is-input.md index e35bc15bfe..4b930af6fe 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-is-input.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-is-input.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefArrayProp](index.md)/[getIsInput](get-is-input.md) - -# getIsInput - - -public [getIsInput](get-is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets a flag indicating if the property is an input or output - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getIsInput + + +public [getIsInput](get-is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets a flag indicating if the property is an input or output + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-name.md index 84dd5c27ec..9900aeb224 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-name.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefArrayProp](index.md)/[getName](get-name.md) - -# getName - - -public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the name of the property - -#### Return - -the property title - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getName + + +public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the name of the property + +#### Return + +the property title + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-title.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-title.md index d08470d282..244471075e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-title.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-title.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefArrayProp](index.md)/[getTitle](get-title.md) - -# getTitle - - -public [getTitle](get-title.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the title value - -#### Return - -the title value - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getTitle + + +public [getTitle](get-title.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the title value + +#### Return + +the title value + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-type.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-type.md index 8711bcf89b..d3359a9013 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-type.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-type.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefArrayProp](index.md)/[getType](get-type.md) - -# getType - - -public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -get the type of the property ("double", "long", "string", or "boolean") - -#### Return - -the property type - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getType + + +public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +get the type of the property ("double", "long", "string", or "boolean") + +#### Return + +the property type + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/index.md index 95220d94d7..7800478526 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/index.md @@ -1,31 +1,29 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefArrayProp](index.md) - -# RefArrayProp - - -public class [RefArrayProp](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -A Reference Array Property class for ModelCenter - -#### Author - -Woyak, 10/2001 - -## Functions - -| Name | Summary | -|---|---| -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description value | -| [getEnumValues](get-enum-values.md) | public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated value set | -| [getIsInput](get-is-input.md) | public [getIsInput](get-is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets a flag indicating if the property is an input or output | -| [getName](get-name.md) | public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the property | -| [getTitle](get-title.md) | public [getTitle](get-title.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the title value | -| [getType](get-type.md) | public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the type of the property ("double", "long", "string", or "boolean") | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description value | -| [setEnumValues](set-enum-values.md) | public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated value set | -| [setIsInput](set-is-input.md) | public [setIsInput](set-is-input.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets a flag indicating if the property is an input or output | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setTitle](set-title.md) | public [setTitle](set-title.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the title value | +# RefArrayProp + + +public class [RefArrayProp](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +A Reference Array Property class for ModelCenter + +#### Author + +Woyak, 10/2001 + +## Functions + +| Name | Summary | +|---|---| +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description value | +| [getEnumValues](get-enum-values.md) | public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated value set | +| [getIsInput](get-is-input.md) | public [getIsInput](get-is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets a flag indicating if the property is an input or output | +| [getName](get-name.md) | public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the property | +| [getTitle](get-title.md) | public [getTitle](get-title.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the title value | +| [getType](get-type.md) | public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the type of the property ("double", "long", "string", or "boolean") | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description value | +| [setEnumValues](set-enum-values.md) | public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated value set | +| [setIsInput](set-is-input.md) | public [setIsInput](set-is-input.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets a flag indicating if the property is an input or output | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setTitle](set-title.md) | public [setTitle](set-title.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the title value | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-description.md index 7ca72f7a83..b34e6054e4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-description.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefArrayProp](index.md)/[setDescription](set-description.md) - -# setDescription - - -public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the description value - -#### Parameters - - - -| | | -|---|---| -| description | the description value | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDescription + + +public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the description value + +#### Parameters + + + +| | | +|---|---| +| description | the description value | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-enum-values.md index 5a828ff655..d20f84740d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-enum-values.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefArrayProp](index.md)/[setEnumValues](set-enum-values.md) - -# setEnumValues - - -public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the enumerated value set - -#### Parameters - - - -| | | -|---|---| -| enumValues | a comma-separated list of enumerated values | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setEnumValues + + +public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the enumerated value set + +#### Parameters + + + +| | | +|---|---| +| enumValues | a comma-separated list of enumerated values | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-is-input.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-is-input.md index fe24571af1..6ae907a68f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-is-input.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-is-input.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefArrayProp](index.md)/[setIsInput](set-is-input.md) - -# setIsInput - - -public [setIsInput](set-is-input.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets a flag indicating if the property is an input or output - -#### Parameters - - - -| | | -|---|---| -| flag | true or false | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setIsInput + + +public [setIsInput](set-is-input.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets a flag indicating if the property is an input or output + +#### Parameters + + + +| | | +|---|---| +| flag | true or false | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-title.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-title.md index 4b46ca9d34..babe7992bb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-title.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-title.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefArrayProp](index.md)/[setTitle](set-title.md) - -# setTitle - - -public [setTitle](set-title.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the title value - -#### Parameters - - - -| | | -|---|---| -| title | the title value | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setTitle + + +public [setTitle](set-title.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the title value + +#### Parameters + + + +| | | +|---|---| +| title | the title value | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-description.md index ee93a3a177..07eea70228 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-description.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefProp](index.md)/[getDescription](get-description.md) - -# getDescription - - -public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the description value - -#### Return - -the description value - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDescription + + +public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the description value + +#### Return + +the description value + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-enum-values.md index 7bcf597359..4f3d65e1f2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-enum-values.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefProp](index.md)/[getEnumValues](get-enum-values.md) - -# getEnumValues - - -public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the enumerated value set - -#### Return - -a comma-separated list of enumerated values - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEnumValues + + +public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the enumerated value set + +#### Return + +a comma-separated list of enumerated values + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-is-input.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-is-input.md index 46b0cb67ff..4b930af6fe 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-is-input.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-is-input.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefProp](index.md)/[getIsInput](get-is-input.md) - -# getIsInput - - -public [getIsInput](get-is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -gets a flag indicating if the property is an input or output - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getIsInput + + +public [getIsInput](get-is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +gets a flag indicating if the property is an input or output + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-name.md index c1dfefbb76..9900aeb224 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-name.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefProp](index.md)/[getName](get-name.md) - -# getName - - -public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the name of the property - -#### Return - -the property title - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getName + + +public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the name of the property + +#### Return + +the property title + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-title.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-title.md index 833887366a..244471075e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-title.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-title.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefProp](index.md)/[getTitle](get-title.md) - -# getTitle - - -public [getTitle](get-title.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the title value - -#### Return - -the title value - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getTitle + + +public [getTitle](get-title.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the title value + +#### Return + +the title value + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-type.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-type.md index 27e4f9dfe4..d3359a9013 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-type.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-type.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefProp](index.md)/[getType](get-type.md) - -# getType - - -public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -get the type of the property ("double", "long", "string", or "boolean") - -#### Return - -the property type - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getType + + +public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +get the type of the property ("double", "long", "string", or "boolean") + +#### Return + +the property type + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/index.md index 4212df3d1b..c73f7564d0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/index.md @@ -1,31 +1,29 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefProp](index.md) - -# RefProp - - -public class [RefProp](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -A Reference Property class for ModelCenter - -#### Author - -Woyak, 10/2001 - -## Functions - -| Name | Summary | -|---|---| -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description value | -| [getEnumValues](get-enum-values.md) | public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated value set | -| [getIsInput](get-is-input.md) | public [getIsInput](get-is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets a flag indicating if the property is an input or output | -| [getName](get-name.md) | public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the property | -| [getTitle](get-title.md) | public [getTitle](get-title.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the title value | -| [getType](get-type.md) | public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the type of the property ("double", "long", "string", or "boolean") | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description value | -| [setEnumValues](set-enum-values.md) | public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated value set | -| [setIsInput](set-is-input.md) | public [setIsInput](set-is-input.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets a flag indicating if the property is an input or output | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setTitle](set-title.md) | public [setTitle](set-title.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the title value | +# RefProp + + +public class [RefProp](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +A Reference Property class for ModelCenter + +#### Author + +Woyak, 10/2001 + +## Functions + +| Name | Summary | +|---|---| +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description value | +| [getEnumValues](get-enum-values.md) | public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated value set | +| [getIsInput](get-is-input.md) | public [getIsInput](get-is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets a flag indicating if the property is an input or output | +| [getName](get-name.md) | public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the property | +| [getTitle](get-title.md) | public [getTitle](get-title.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the title value | +| [getType](get-type.md) | public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
get the type of the property ("double", "long", "string", or "boolean") | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description value | +| [setEnumValues](set-enum-values.md) | public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated value set | +| [setIsInput](set-is-input.md) | public [setIsInput](set-is-input.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets a flag indicating if the property is an input or output | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setTitle](set-title.md) | public [setTitle](set-title.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the title value | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-description.md index 4a59107519..b34e6054e4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-description.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefProp](index.md)/[setDescription](set-description.md) - -# setDescription - - -public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the description value - -#### Parameters - - - -| | | -|---|---| -| description | the description value | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDescription + + +public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the description value + +#### Parameters + + + +| | | +|---|---| +| description | the description value | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-enum-values.md index 7197cc5504..d20f84740d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-enum-values.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefProp](index.md)/[setEnumValues](set-enum-values.md) - -# setEnumValues - - -public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the enumerated value set - -#### Parameters - - - -| | | -|---|---| -| enumValues | a comma-separated list of enumerated values | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setEnumValues + + +public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the enumerated value set + +#### Parameters + + + +| | | +|---|---| +| enumValues | a comma-separated list of enumerated values | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-is-input.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-is-input.md index 4e4ee625e4..6ae907a68f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-is-input.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-is-input.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefProp](index.md)/[setIsInput](set-is-input.md) - -# setIsInput - - -public [setIsInput](set-is-input.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -sets a flag indicating if the property is an input or output - -#### Parameters - - - -| | | -|---|---| -| flag | true or false | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setIsInput + + +public [setIsInput](set-is-input.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +sets a flag indicating if the property is an input or output + +#### Parameters + + + +| | | +|---|---| +| flag | true or false | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-title.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-title.md index b19f0dc3c9..babe7992bb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-title.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-title.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[RefProp](index.md)/[setTitle](set-title.md) - -# setTitle - - -public [setTitle](set-title.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the title value - -#### Parameters - - - -| | | -|---|---| -| title | the title value | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setTitle + + +public [setTitle](set-title.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the title value + +#### Parameters + + + +| | | +|---|---| +| title | the title value | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/create-ref-prop.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/create-ref-prop.md index 851115f4ad..9788a84590 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/create-ref-prop.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/create-ref-prop.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceArray](index.md)/[createRefProp](create-ref-prop.md) - -# createRefProp - - -public [createRefProp](create-ref-prop.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [RefArrayProp](../-ref-array-prop/index.md) - -creates a reference property - -#### Parameters - - - -| | | -|---|---| -| name | the name of the property | -| type | the type for the property: "double", "long", "string", or "boolean" | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# createRefProp + + +public [createRefProp](create-ref-prop.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [RefArrayProp](../-ref-array-prop/index.md) + +creates a reference property + +#### Parameters + + + +| | | +|---|---| +| name | the name of the property | +| type | the type for the property: "double", "long", "string", or "boolean" | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-num-referenced-variables.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-num-referenced-variables.md index e285e3baa9..8196b201fd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-num-referenced-variables.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-num-referenced-variables.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceArray](index.md)/[getNumReferencedVariables](get-num-referenced-variables.md) - -# getNumReferencedVariables - - -public [getNumReferencedVariables](get-num-referenced-variables.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -get the number of variables referenced by this object at the specificed array index - -#### Return - -the number of referenced variables - -#### Parameters - - - -| | -|---| -| index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumReferencedVariables + + +public [getNumReferencedVariables](get-num-referenced-variables.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +get the number of variables referenced by this object at the specificed array index + +#### Return + +the number of referenced variables + +#### Parameters + + + +| | +|---| +| index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-ref-prop-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-ref-prop-value-absolute.md index a34b48c9d2..339a7cad00 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-ref-prop-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-ref-prop-value-absolute.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceArray](index.md)/[getRefPropValueAbsolute](get-ref-prop-value-absolute.md) - -# getRefPropValueAbsolute - - -public [getRefPropValueAbsolute](get-ref-prop-value-absolute.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets a value for a reference property - -#### Parameters - - - -| | | -|---|---| -| name | the reference property | -| index | the array element index (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getRefPropValueAbsolute + + +public [getRefPropValueAbsolute](get-ref-prop-value-absolute.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets a value for a reference property + +#### Parameters + + + +| | | +|---|---| +| name | the reference property | +| index | the array element index (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-ref-prop-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-ref-prop-value.md index b790061829..cf29dd9e99 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-ref-prop-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-ref-prop-value.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceArray](index.md)/[getRefPropValue](get-ref-prop-value.md) - -# getRefPropValue - - -public [getRefPropValue](get-ref-prop-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets a value for a reference property - -#### Parameters - - - -| | | -|---|---| -| name | the reference property | -| index | the array element index (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getRefPropValue + + +public [getRefPropValue](get-ref-prop-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets a value for a reference property + +#### Parameters + + + +| | | +|---|---| +| name | the reference property | +| index | the array element index (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-reference.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-reference.md index 2d0abb398d..bf5f7421a5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-reference.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-reference.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceArray](index.md)/[getReference](get-reference.md) - -# getReference - - -public [getReference](get-reference.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the reference equation - -#### Return - -the reference equation - -#### Parameters - - - -| | | -|---|---| -| index | the array element index (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getReference + + +public [getReference](get-reference.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the reference equation + +#### Return + +the reference equation + +#### Parameters + + + +| | | +|---|---| +| index | the array element index (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-referenced-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-referenced-variable.md index 433534ac0b..000303b089 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-referenced-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-referenced-variable.md @@ -1,50 +1,48 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceArray](index.md)/[getReferencedVariable](get-referenced-variable.md) - -# getReferencedVariable - - -public [getReferencedVariable](get-referenced-variable.md)(arrayIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), varIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md) - -gets the specified referenced variable - -#### Return - -the specified variable - -#### Parameters - - - -| | | -|---|---| -| arrayIndex | (0-based index) | -| varIndex | the variable index (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getReferencedVariable](get-referenced-variable.md)(arrayIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md) - -Convenience method to return the referenced variable. Should only be used if there is only one reference variable. - -#### Return - -the specified variable - -#### Parameters - - - -| | | -|---|---| -| arrayIndex | (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getReferencedVariable + + +public [getReferencedVariable](get-referenced-variable.md)(arrayIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), varIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md) + +gets the specified referenced variable + +#### Return + +the specified variable + +#### Parameters + + + +| | | +|---|---| +| arrayIndex | (0-based index) | +| varIndex | the variable index (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getReferencedVariable](get-referenced-variable.md)(arrayIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md) + +Convenience method to return the referenced variable. Should only be used if there is only one reference variable. + +#### Return + +the specified variable + +#### Parameters + + + +| | | +|---|---| +| arrayIndex | (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-value-absolute.md index 1f53b67d01..4151e98e27 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-value-absolute.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceArray](index.md)/[getValueAbsolute](get-value-absolute.md) - -# getValueAbsolute - - -public [getValueAbsolute](get-value-absolute.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the reference - -#### Return - -the reference value - -#### Parameters - - - -| | | -|---|---| -| index | the array element index (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValueAbsolute + + +public [getValueAbsolute](get-value-absolute.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the reference + +#### Return + +the reference value + +#### Parameters + + + +| | | +|---|---| +| index | the array element index (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-value.md index 4755ec680f..12ab59282e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-value.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceArray](index.md)/[getValue](get-value.md) - -# getValue - - -public [getValue](get-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the reference - -#### Return - -the reference value - -#### Parameters - - - -| | | -|---|---| -| index | the array element index (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValue + + +public [getValue](get-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the reference + +#### Return + +the reference value + +#### Parameters + + + +| | | +|---|---| +| index | the array element index (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/index.md index 3345667dee..feba441176 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/index.md @@ -1,65 +1,63 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceArray](index.md) - -# ReferenceArray - - -public class [ReferenceArray](index.md) : [Array](../-array/index.md) - -A Array type class for ModelCenter - -#### Author - -Woyak, 10/2001 - -## Functions - -| Name | Summary | -|---|---| -| [createRefProp](create-ref-prop.md) | public [createRefProp](create-ref-prop.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [RefArrayProp](../-ref-array-prop/index.md)
creates a reference property | -| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromString](../-array/from-string.md) | public [fromString](../-array/from-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value for the variable from a string
public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | -| [getAutoSize](../-array/get-auto-size.md) | public [getAutoSize](../-array/get-auto-size.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the autoSize flag. | -| [getDimensions](../-array/get-dimensions.md) | public [getDimensions](../-array/get-dimensions.md)(): [Variant](../-variant/index.md)
gets the dimensions of an array | -| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | -| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | -| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | -| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | -| [getLength](../-array/get-length.md) | public [getLength](../-array/get-length.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getLength](../-array/get-length.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | -| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | -| [getNumDimensions](../-array/get-num-dimensions.md) | public [getNumDimensions](../-array/get-num-dimensions.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of dimensions | -| [getNumReferencedVariables](get-num-referenced-variables.md) | public [getNumReferencedVariables](get-num-referenced-variables.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of variables referenced by this object at the specificed array index | -| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | -| [getReference](get-reference.md) | public [getReference](get-reference.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the reference equation | -| [getReferencedVariable](get-referenced-variable.md) | public [getReferencedVariable](get-referenced-variable.md)(arrayIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
Convenience method to return the referenced variable.
public [getReferencedVariable](get-referenced-variable.md)(arrayIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), varIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
gets the specified referenced variable | -| [getRefPropValue](get-ref-prop-value.md) | public [getRefPropValue](get-ref-prop-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets a value for a reference property | -| [getRefPropValueAbsolute](get-ref-prop-value-absolute.md) | public [getRefPropValueAbsolute](get-ref-prop-value-absolute.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets a value for a reference property | -| [getSize](../-array/get-size.md) | public [getSize](../-array/get-size.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getSize](../-array/get-size.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | -| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | -| [getValue](get-value.md) | public [getValue](get-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the value of the reference | -| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the value of the reference | -| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | -| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | -| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | -| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | -| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | -| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setAutoSize](../-array/set-auto-size.md) | public [setAutoSize](../-array/set-auto-size.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the autoSize flag. | -| [setDimensions](../-array/set-dimensions.md) | public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the dimensions of the array | -| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | -| [setLength](../-array/set-length.md) | public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | -| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | -| [setNumDimensions](../-array/set-num-dimensions.md) | public [setNumDimensions](../-array/set-num-dimensions.md)(num: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the number of dimensions | -| [setReference](set-reference.md) | public [setReference](set-reference.md)(reference: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
sets the reference equation | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setRefPropValue](set-ref-prop-value.md) | public [setRefPropValue](set-ref-prop-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets a value for a reference property | -| [setSize](../-array/set-size.md) | public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | -| [setValue](set-value.md) | public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
set the value of the reference | -| [toString](../-array/to-string.md) | public [toString](../-array/to-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [toStringAbsolute](../-array/to-string-absolute.md) | public [toStringAbsolute](../-array/to-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | +# ReferenceArray + + +public class [ReferenceArray](index.md) : [Array](../-array/index.md) + +A Array type class for ModelCenter + +#### Author + +Woyak, 10/2001 + +## Functions + +| Name | Summary | +|---|---| +| [createRefProp](create-ref-prop.md) | public [createRefProp](create-ref-prop.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [RefArrayProp](../-ref-array-prop/index.md)
creates a reference property | +| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromString](../-array/from-string.md) | public [fromString](../-array/from-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value for the variable from a string
public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | +| [getAutoSize](../-array/get-auto-size.md) | public [getAutoSize](../-array/get-auto-size.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the autoSize flag. | +| [getDimensions](../-array/get-dimensions.md) | public [getDimensions](../-array/get-dimensions.md)(): [Variant](../-variant/index.md)
gets the dimensions of an array | +| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | +| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | +| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | +| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | +| [getLength](../-array/get-length.md) | public [getLength](../-array/get-length.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getLength](../-array/get-length.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | +| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | +| [getNumDimensions](../-array/get-num-dimensions.md) | public [getNumDimensions](../-array/get-num-dimensions.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of dimensions | +| [getNumReferencedVariables](get-num-referenced-variables.md) | public [getNumReferencedVariables](get-num-referenced-variables.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of variables referenced by this object at the specificed array index | +| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | +| [getReference](get-reference.md) | public [getReference](get-reference.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the reference equation | +| [getReferencedVariable](get-referenced-variable.md) | public [getReferencedVariable](get-referenced-variable.md)(arrayIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
Convenience method to return the referenced variable.
public [getReferencedVariable](get-referenced-variable.md)(arrayIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), varIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
gets the specified referenced variable | +| [getRefPropValue](get-ref-prop-value.md) | public [getRefPropValue](get-ref-prop-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets a value for a reference property | +| [getRefPropValueAbsolute](get-ref-prop-value-absolute.md) | public [getRefPropValueAbsolute](get-ref-prop-value-absolute.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets a value for a reference property | +| [getSize](../-array/get-size.md) | public [getSize](../-array/get-size.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getSize](../-array/get-size.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | +| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | +| [getValue](get-value.md) | public [getValue](get-value.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the value of the reference | +| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the value of the reference | +| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | +| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | +| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | +| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | +| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | +| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setAutoSize](../-array/set-auto-size.md) | public [setAutoSize](../-array/set-auto-size.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the autoSize flag. | +| [setDimensions](../-array/set-dimensions.md) | public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the dimensions of the array | +| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | +| [setLength](../-array/set-length.md) | public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | +| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | +| [setNumDimensions](../-array/set-num-dimensions.md) | public [setNumDimensions](../-array/set-num-dimensions.md)(num: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the number of dimensions | +| [setReference](set-reference.md) | public [setReference](set-reference.md)(reference: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
sets the reference equation | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setRefPropValue](set-ref-prop-value.md) | public [setRefPropValue](set-ref-prop-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets a value for a reference property | +| [setSize](../-array/set-size.md) | public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | +| [setValue](set-value.md) | public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))
set the value of the reference | +| [toString](../-array/to-string.md) | public [toString](../-array/to-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [toStringAbsolute](../-array/to-string-absolute.md) | public [toStringAbsolute](../-array/to-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/set-ref-prop-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/set-ref-prop-value.md index 1f2a5e9227..3e9a8cb72a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/set-ref-prop-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/set-ref-prop-value.md @@ -1,24 +1,22 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceArray](index.md)/[setRefPropValue](set-ref-prop-value.md) - -# setRefPropValue - - -public [setRefPropValue](set-ref-prop-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets a value for a reference property - -#### Parameters - - - -| | | -|---|---| -| name | the reference property | -| value | the value to set the property to | -| index | the array element index (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setRefPropValue + + +public [setRefPropValue](set-ref-prop-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets a value for a reference property + +#### Parameters + + + +| | | +|---|---| +| name | the reference property | +| value | the value to set the property to | +| index | the array element index (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/set-reference.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/set-reference.md index 9c035fee97..0383461aff 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/set-reference.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/set-reference.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceArray](index.md)/[setReference](set-reference.md) - -# setReference - - -public [setReference](set-reference.md)(reference: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -sets the reference equation - -#### Parameters - - - -| | | -|---|---| -| reference | the reference equation | -| index | the array element index (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setReference + + +public [setReference](set-reference.md)(reference: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +sets the reference equation + +#### Parameters + + + +| | | +|---|---| +| reference | the reference equation | +| index | the array element index (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/set-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/set-value.md index 1b173be272..32efba8a8e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/set-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-array/set-value.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceArray](index.md)/[setValue](set-value.md) - -# setValue - - -public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) - -set the value of the reference - -#### Parameters - - - -| | | -|---|---| -| index | the array element index (0-based index) | -| value | the new reference value | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setValue + + +public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)) + +set the value of the reference + +#### Parameters + + + +| | | +|---|---| +| index | the array element index (0-based index) | +| value | the new reference value | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/create-ref-prop.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/create-ref-prop.md index 1ffc338c59..ee496f39a1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/create-ref-prop.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/create-ref-prop.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceVariable](index.md)/[createRefProp](create-ref-prop.md) - -# createRefProp - - -public [createRefProp](create-ref-prop.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [RefProp](../-ref-prop/index.md) - -creates a reference property - -#### Parameters - - - -| | | -|---|---| -| name | the name of the property | -| type | the type for the property: "double", "long", "string", or "boolean" | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# createRefProp + + +public [createRefProp](create-ref-prop.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [RefProp](../-ref-prop/index.md) + +creates a reference property + +#### Parameters + + + +| | | +|---|---| +| name | the name of the property | +| type | the type for the property: "double", "long", "string", or "boolean" | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-num-referenced-variables.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-num-referenced-variables.md index f0d70b27ec..9b89a9b64d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-num-referenced-variables.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-num-referenced-variables.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceVariable](index.md)/[getNumReferencedVariables](get-num-referenced-variables.md) - -# getNumReferencedVariables - - -public [getNumReferencedVariables](get-num-referenced-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -get the number of variables referenced by this object - -#### Return - -the number of referenced variables - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getNumReferencedVariables + + +public [getNumReferencedVariables](get-num-referenced-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +get the number of variables referenced by this object + +#### Return + +the number of referenced variables + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-ref-prop-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-ref-prop-value-absolute.md index 73126c64cf..21e48cce1b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-ref-prop-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-ref-prop-value-absolute.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceVariable](index.md)/[getRefPropValueAbsolute](get-ref-prop-value-absolute.md) - -# getRefPropValueAbsolute - - -public [getRefPropValueAbsolute](get-ref-prop-value-absolute.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets a value for a reference property - -#### Parameters - - - -| | | -|---|---| -| name | the reference property | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getRefPropValueAbsolute + + +public [getRefPropValueAbsolute](get-ref-prop-value-absolute.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets a value for a reference property + +#### Parameters + + + +| | | +|---|---| +| name | the reference property | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-ref-prop-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-ref-prop-value.md index cdda485c51..69f8246089 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-ref-prop-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-ref-prop-value.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceVariable](index.md)/[getRefPropValue](get-ref-prop-value.md) - -# getRefPropValue - - -public [getRefPropValue](get-ref-prop-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets a value for a reference property - -#### Parameters - - - -| | | -|---|---| -| name | the reference property | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getRefPropValue + + +public [getRefPropValue](get-ref-prop-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets a value for a reference property + +#### Parameters + + + +| | | +|---|---| +| name | the reference property | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-reference.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-reference.md index 06dcfe6b5e..c708ae913f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-reference.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-reference.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceVariable](index.md)/[getReference](get-reference.md) - -# getReference - - -public [getReference](get-reference.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the reference equation - -#### Return - -the reference equation - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getReference + + +public [getReference](get-reference.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the reference equation + +#### Return + +the reference equation + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-referenced-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-referenced-variable.md index f6c73587ad..3ad9a5b0c5 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-referenced-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-referenced-variable.md @@ -1,41 +1,39 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceVariable](index.md)/[getReferencedVariable](get-referenced-variable.md) - -# getReferencedVariable - - -public [getReferencedVariable](get-referenced-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md) - -gets the specified referenced variable - -#### Return - -the specified variable - -#### Parameters - - - -| | | -|---|---| -| index | the variable index (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getReferencedVariable](get-referenced-variable.md)(): [Variable](../-variable/index.md) - -Convenience method to return the referenced variable. Should only be used if there is only one reference variable. - -#### Return - -the specified variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getReferencedVariable + + +public [getReferencedVariable](get-referenced-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md) + +gets the specified referenced variable + +#### Return + +the specified variable + +#### Parameters + + + +| | | +|---|---| +| index | the variable index (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getReferencedVariable](get-referenced-variable.md)(): [Variable](../-variable/index.md) + +Convenience method to return the referenced variable. Should only be used if there is only one reference variable. + +#### Return + +the specified variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-value.md index 053f846c1b..5bdd302dbf 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-value.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceVariable](index.md)/[getValue](get-value.md) - -# getValue - - -public [getValue](get-value.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -gets the value of the reference - -#### Return - -the reference value - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValue + + +public [getValue](get-value.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +gets the value of the reference + +#### Return + +the reference value + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/index.md index e3c2e0ea4a..2b0c6cec3b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/index.md @@ -1,54 +1,52 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceVariable](index.md) - -# ReferenceVariable - - -public class [ReferenceVariable](index.md) : [Variable](../-variable/index.md) - -A variable type class for ModelCenter - -#### Author - -Woyak, 10/2001 - -## Functions - -| Name | Summary | -|---|---| -| [createRefProp](create-ref-prop.md) | public [createRefProp](create-ref-prop.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [RefProp](../-ref-prop/index.md)
creates a reference property | -| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromString](../-variable/from-string.md) | public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | -| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | -| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | -| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | -| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | -| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | -| [getNumReferencedVariables](get-num-referenced-variables.md) | public [getNumReferencedVariables](get-num-referenced-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of variables referenced by this object | -| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | -| [getReference](get-reference.md) | public [getReference](get-reference.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the reference equation | -| [getReferencedVariable](get-referenced-variable.md) | public [getReferencedVariable](get-referenced-variable.md)(): [Variable](../-variable/index.md)
Convenience method to return the referenced variable.
public [getReferencedVariable](get-referenced-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
gets the specified referenced variable | -| [getRefPropValue](get-ref-prop-value.md) | public [getRefPropValue](get-ref-prop-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets a value for a reference property | -| [getRefPropValueAbsolute](get-ref-prop-value-absolute.md) | public [getRefPropValueAbsolute](get-ref-prop-value-absolute.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets a value for a reference property | -| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | -| [getValue](get-value.md) | public [getValue](get-value.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the value of the reference | -| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | -| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | -| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | -| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | -| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | -| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | -| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | -| [setReference](set-reference.md) | public [setReference](set-reference.md)(reference: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the reference equation | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setRefPropValue](set-ref-prop-value.md) | public [setRefPropValue](set-ref-prop-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets a value for a reference property | -| [setValue](set-value.md) | public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
set the value of the reference | -| [toString](../-variable/to-string.md) | public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [toStringAbsolute](../-variable/to-string-absolute.md) | public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | +# ReferenceVariable + + +public class [ReferenceVariable](index.md) : [Variable](../-variable/index.md) + +A variable type class for ModelCenter + +#### Author + +Woyak, 10/2001 + +## Functions + +| Name | Summary | +|---|---| +| [createRefProp](create-ref-prop.md) | public [createRefProp](create-ref-prop.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [RefProp](../-ref-prop/index.md)
creates a reference property | +| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromString](../-variable/from-string.md) | public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | +| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | +| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | +| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | +| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | +| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | +| [getNumReferencedVariables](get-num-referenced-variables.md) | public [getNumReferencedVariables](get-num-referenced-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of variables referenced by this object | +| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | +| [getReference](get-reference.md) | public [getReference](get-reference.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the reference equation | +| [getReferencedVariable](get-referenced-variable.md) | public [getReferencedVariable](get-referenced-variable.md)(): [Variable](../-variable/index.md)
Convenience method to return the referenced variable.
public [getReferencedVariable](get-referenced-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
gets the specified referenced variable | +| [getRefPropValue](get-ref-prop-value.md) | public [getRefPropValue](get-ref-prop-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets a value for a reference property | +| [getRefPropValueAbsolute](get-ref-prop-value-absolute.md) | public [getRefPropValueAbsolute](get-ref-prop-value-absolute.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets a value for a reference property | +| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | +| [getValue](get-value.md) | public [getValue](get-value.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
gets the value of the reference | +| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | +| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | +| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | +| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | +| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | +| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | +| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | +| [setReference](set-reference.md) | public [setReference](set-reference.md)(reference: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the reference equation | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setRefPropValue](set-ref-prop-value.md) | public [setRefPropValue](set-ref-prop-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets a value for a reference property | +| [setValue](set-value.md) | public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
set the value of the reference | +| [toString](../-variable/to-string.md) | public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [toStringAbsolute](../-variable/to-string-absolute.md) | public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/set-ref-prop-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/set-ref-prop-value.md index 0074012335..af0fae9702 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/set-ref-prop-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/set-ref-prop-value.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceVariable](index.md)/[setRefPropValue](set-ref-prop-value.md) - -# setRefPropValue - - -public [setRefPropValue](set-ref-prop-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets a value for a reference property - -#### Parameters - - - -| | | -|---|---| -| name | the reference property | -| value | the value to set the property to | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setRefPropValue + + +public [setRefPropValue](set-ref-prop-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets a value for a reference property + +#### Parameters + + + +| | | +|---|---| +| name | the reference property | +| value | the value to set the property to | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/set-reference.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/set-reference.md index a15d187963..265da749cc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/set-reference.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/set-reference.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceVariable](index.md)/[setReference](set-reference.md) - -# setReference - - -public [setReference](set-reference.md)(reference: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the reference equation - -#### Parameters - - - -| | | -|---|---| -| reference | the reference equation | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setReference + + +public [setReference](set-reference.md)(reference: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the reference equation + +#### Parameters + + + +| | | +|---|---| +| reference | the reference equation | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/set-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/set-value.md index 17d8601d02..84a834a14f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/set-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-reference-variable/set-value.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ReferenceVariable](index.md)/[setValue](set-value.md) - -# setValue - - -public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) - -set the value of the reference - -#### Parameters - - - -| | | -|---|---| -| value | the new reference value | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setValue + + +public [setValue](set-value.md)(value: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) + +set the value of the reference + +#### Parameters + + + +| | | +|---|---| +| value | the new reference value | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/close.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/close.md index f47219037c..487d371165 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/close.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/close.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[SaveContext](index.md)/[close](close.md) - -# close - - -public [close](close.md)() - -***************************************************************************** Closes the save context. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# close + + +public [close](close.md)() + +***************************************************************************** Closes the save context. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/get-save-location.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/get-save-location.md index d0e4aab605..d55bd68bec 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/get-save-location.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/get-save-location.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[SaveContext](index.md)/[getSaveLocation](get-save-location.md) - -# getSaveLocation - - -public [getSaveLocation](get-save-location.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -***************************************************************************** Gets the disk location this save context saves. - -#### Return - -save context file path - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getSaveLocation + + +public [getSaveLocation](get-save-location.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +***************************************************************************** Gets the disk location this save context saves. + +#### Return + +save context file path + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/index.md index 21e5357a13..283e36d3a6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/index.md @@ -1,27 +1,25 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[SaveContext](index.md) - -# SaveContext - - -public class [SaveContext](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -Class for generically saving and loading files in ModelCenter. - -#### Author - -Boutwell, 1/2014 - -## Functions - -| Name | Summary | -|---|---| -| [close](close.md) | public [close](close.md)()
***************************************************************************** Closes the save context. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [getSaveLocation](get-save-location.md) | public [getSaveLocation](get-save-location.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
***************************************************************************** Gets the disk location this save context saves. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [restoreFile](restore-file.md) | public [restoreFile](restore-file.md)(fileID: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), targetLocation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
***************************************************************************** Restores the file by ID to the given location. | -| [restoreFileStream](restore-file-stream.md) | public [restoreFileStream](restore-file-stream.md)(fileID: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
***************************************************************************** Gets a stream that can be used for restoring a file saved into the context with the given ID. | -| [saveFile](save-file.md) | public [saveFile](save-file.md)(sourceLocation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), context: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
***************************************************************************** Save a file into the context. | -| [saveFileStream](save-file-stream.md) | public [saveFileStream](save-file-stream.md)(context: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
***************************************************************************** Gets a stream that can be used for saving a file to the context. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +# SaveContext + + +public class [SaveContext](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +Class for generically saving and loading files in ModelCenter. + +#### Author + +Boutwell, 1/2014 + +## Functions + +| Name | Summary | +|---|---| +| [close](close.md) | public [close](close.md)()
***************************************************************************** Closes the save context. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [getSaveLocation](get-save-location.md) | public [getSaveLocation](get-save-location.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
***************************************************************************** Gets the disk location this save context saves. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [restoreFile](restore-file.md) | public [restoreFile](restore-file.md)(fileID: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), targetLocation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
***************************************************************************** Restores the file by ID to the given location. | +| [restoreFileStream](restore-file-stream.md) | public [restoreFileStream](restore-file-stream.md)(fileID: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
***************************************************************************** Gets a stream that can be used for restoring a file saved into the context with the given ID. | +| [saveFile](save-file.md) | public [saveFile](save-file.md)(sourceLocation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), context: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
***************************************************************************** Save a file into the context. | +| [saveFileStream](save-file-stream.md) | public [saveFileStream](save-file-stream.md)(context: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
***************************************************************************** Gets a stream that can be used for saving a file to the context. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/restore-file-stream.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/restore-file-stream.md index 2a723dd26d..2a6e1ac4d9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/restore-file-stream.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/restore-file-stream.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[SaveContext](index.md)/[restoreFileStream](restore-file-stream.md) - -# restoreFileStream - - -public [restoreFileStream](restore-file-stream.md)(fileID: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -***************************************************************************** Gets a stream that can be used for restoring a file saved into the context with the given ID. Only one stream may be open at a time. - -#### Return - -input stream for restoring - -#### Parameters - - - -| | | -|---|---| -| fileID | id of the file to restore | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# restoreFileStream + + +public [restoreFileStream](restore-file-stream.md)(fileID: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +***************************************************************************** Gets a stream that can be used for restoring a file saved into the context with the given ID. Only one stream may be open at a time. + +#### Return + +input stream for restoring + +#### Parameters + + + +| | | +|---|---| +| fileID | id of the file to restore | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/restore-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/restore-file.md index 703122195b..c4f1ba3d68 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/restore-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/restore-file.md @@ -1,27 +1,25 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[SaveContext](index.md)/[restoreFile](restore-file.md) - -# restoreFile - - -public [restoreFile](restore-file.md)(fileID: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), targetLocation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -***************************************************************************** Restores the file by ID to the given location. - -#### Return - -true if a file with the given id was restored, false on failure - -#### Parameters - - - -| | | -|---|---| -| fileID | id of the file to restore | -| targetLocation | disk location to restore the file | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# restoreFile + + +public [restoreFile](restore-file.md)(fileID: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), targetLocation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +***************************************************************************** Restores the file by ID to the given location. + +#### Return + +true if a file with the given id was restored, false on failure + +#### Parameters + + + +| | | +|---|---| +| fileID | id of the file to restore | +| targetLocation | disk location to restore the file | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/save-file-stream.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/save-file-stream.md index 9298c68661..d08b55ecf4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/save-file-stream.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/save-file-stream.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[SaveContext](index.md)/[saveFileStream](save-file-stream.md) - -# saveFileStream - - -public [saveFileStream](save-file-stream.md)(context: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -***************************************************************************** Gets a stream that can be used for saving a file to the context. Only one stream may be open at a time. - -#### Return - -output stream for saving - -#### Parameters - - - -| | | -|---|---| -| context | context by which to save | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# saveFileStream + + +public [saveFileStream](save-file-stream.md)(context: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +***************************************************************************** Gets a stream that can be used for saving a file to the context. Only one stream may be open at a time. + +#### Return + +output stream for saving + +#### Parameters + + + +| | | +|---|---| +| context | context by which to save | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/save-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/save-file.md index 14aa56017b..ccbd0fe75a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/save-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-save-context/save-file.md @@ -1,27 +1,25 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[SaveContext](index.md)/[saveFile](save-file.md) - -# saveFile - - -public [saveFile](save-file.md)(sourceLocation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), context: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -***************************************************************************** Save a file into the context. If the save is successful passing the context to restore as the file ID will return the saved file. - -#### Return - -true if the file was saved successfully; false otherwise - -#### Parameters - - - -| | | -|---|---| -| sourceLocation | source file to save | -| context | context by which to save | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# saveFile + + +public [saveFile](save-file.md)(sourceLocation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), context: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +***************************************************************************** Save a file into the context. If the save is successful passing the context to restore as the file ID will return the saved file. + +#### Return + +true if the file was saved successfully; false otherwise + +#### Parameters + + + +| | | +|---|---| +| sourceLocation | source file to save | +| context | context by which to save | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/add-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/add-variable.md index ecb86fbfa5..814eeb2555 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/add-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/add-variable.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ScriptComponent](index.md)/[addVariable](add-variable.md) - -# addVariable - - -public [addVariable](add-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) - -Adds the variable from the script component. - -#### Return - -the IVariable added to the component - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# addVariable + + +public [addVariable](add-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) + +Adds the variable from the script component. + +#### Return + +the IVariable added to the component + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-forward-schedule.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-forward-schedule.md index ff1df837be..33cdc57a77 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-forward-schedule.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-forward-schedule.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ScriptComponent](index.md)/[getForwardSchedule](get-forward-schedule.md) - -# getForwardSchedule - - -public [getForwardSchedule](get-forward-schedule.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Gets the state of the script's forward scheduling mode. - -#### Return - -true if the script is set to forward schedule - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getForwardSchedule + + +public [getForwardSchedule](get-forward-schedule.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Gets the state of the script's forward scheduling mode. + +#### Return + +true if the script is set to forward schedule + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-language.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-language.md index 2f1e7989d8..5f0cc91334 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-language.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-language.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ScriptComponent](index.md)/[getLanguage](get-language.md) - -# getLanguage - - -public [getLanguage](get-language.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the script's source language. - -#### Return - -the current source language - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getLanguage + + +public [getLanguage](get-language.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the script's source language. + +#### Return + +the current source language + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-prevalidate.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-prevalidate.md index b5277a7f08..e117ba50d3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-prevalidate.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-prevalidate.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ScriptComponent](index.md)/[getPrevalidate](get-prevalidate.md) - -# getPrevalidate - - -public [getPrevalidate](get-prevalidate.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Gets the state of the script's prevalidate mode. - -#### Return - -true if the script is set to prevalide - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getPrevalidate + + +public [getPrevalidate](get-prevalidate.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Gets the state of the script's prevalidate mode. + +#### Return + +true if the script is set to prevalide + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-source-script.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-source-script.md index d08610d966..81294b18c6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-source-script.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-source-script.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ScriptComponent](index.md)/[getSourceScript](get-source-script.md) - -# getSourceScript - - -public [getSourceScript](get-source-script.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the source script code associated with this script component. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getSourceScript + + +public [getSourceScript](get-source-script.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the source script code associated with this script component. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-timeout.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-timeout.md index 922e7e94e0..e7aac6b5cb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-timeout.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/get-timeout.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ScriptComponent](index.md)/[getTimeout](get-timeout.md) - -# getTimeout - - -public [getTimeout](get-timeout.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) - -Gets the script's run timeout. - -#### Return - -the current run timeout for this component - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getTimeout + + +public [getTimeout](get-timeout.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) + +Gets the script's run timeout. + +#### Return + +the current run timeout for this component + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/index.md index 54bad6864b..8276a1e07e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/index.md @@ -1,74 +1,72 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ScriptComponent](index.md) - -# ScriptComponent - - -public class [ScriptComponent](index.md) : [Component](../-component/index.md) - -This is the wrapper class that handles the native COM calls to a ScriptComponent object. - -#### Author - -jboutwell, 8-2011 - -## Properties - -| Name | Summary | -|---|---| -| [COMPONENT_TYPE_ASSEMBLY](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md) | val [COMPONENT_TYPE_ASSEMBLY](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Assembly" | -| [COMPONENT_TYPE_COMPONENT](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md) | val [COMPONENT_TYPE_COMPONENT](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Component" | -| [COMPONENT_TYPE_EMPTY](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md) | val [COMPONENT_TYPE_EMPTY](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Empty" | -| [COMPONENT_TYPE_FOR_EACH](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md) | val [~~COMPONENT_TYPE_FOR_EACH~~](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ForEach" | -| [COMPONENT_TYPE_IF](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md) | val [COMPONENT_TYPE_IF](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "If" | -| [COMPONENT_TYPE_LOOP](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md) | val [COMPONENT_TYPE_LOOP](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Loop" | -| [COMPONENT_TYPE_PARALLEL](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md) | val [COMPONENT_TYPE_PARALLEL](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Parallel" | -| [COMPONENT_TYPE_SCRIPTCOMPONENT](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md) | val [COMPONENT_TYPE_SCRIPTCOMPONENT](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ScriptComponent" | -| [COMPONENT_TYPE_SEQUENCE](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md) | val [COMPONENT_TYPE_SEQUENCE](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Sequence" | - -## Functions - -| Name | Summary | -|---|---| -| [addVariable](add-variable.md) | public [addVariable](add-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
Adds the variable from the script component. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [downloadValues](../-component/download-values.md) | public [downloadValues](../-component/download-values.md)()
downloads the component's variable values from Analysis Server, if it's an Analysis Server component | -| [getAssociatedFiles](../-component/get-associated-files.md) | public [getAssociatedFiles](../-component/get-associated-files.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
gets the associated files of the component | -| [getForwardSchedule](get-forward-schedule.md) | public [getForwardSchedule](get-forward-schedule.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets the state of the script's forward scheduling mode. | -| [getFullName](../-component/get-full-name.md) | public [getFullName](../-component/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the full name of the current object, e.g. | -| [getGroup](../-component/get-group.md) | public [getGroup](../-component/get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](../-group/index.md)
public [getGroup](../-component/get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](../-group/index.md)
gets the specified group | -| [getIndexInParent](../-component/get-index-in-parent.md) | public [getIndexInParent](../-component/get-index-in-parent.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the index of the component in its parent assembly. | -| [getLanguage](get-language.md) | public [getLanguage](get-language.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the script's source language. | -| [getMetadata](../-component/get-metadata.md) | public [getMetadata](../-component/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](../-component/get-name.md) | public [getName](../-component/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the current object, e.g. | -| [getNumGroups](../-component/get-num-groups.md) | public [getNumGroups](../-component/get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of groups stored in this object | -| [getNumVariables](../-component/get-num-variables.md) | public [getNumVariables](../-component/get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of variables stored in this object | -| [getParentAssembly](../-component/get-parent-assembly.md) | public [getParentAssembly](../-component/get-parent-assembly.md)(): [Assembly](../-assembly/index.md)
gets the parent assembly of this component (fails if this is the model/root assembly) | -| [getPositionX](../-component/get-position-x.md) | public [getPositionX](../-component/get-position-x.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the X co-ordinate value of the current object, | -| [getPositionY](../-component/get-position-y.md) | public [getPositionY](../-component/get-position-y.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the Y co-ordinate value of the current object, | -| [getPrevalidate](get-prevalidate.md) | public [getPrevalidate](get-prevalidate.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets the state of the script's prevalidate mode. | -| [getSource](../-component/get-source.md) | public [getSource](../-component/get-source.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the server path for the component, e.g. | -| [getSourceScript](get-source-script.md) | public [getSourceScript](get-source-script.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the source script code associated with this script component. | -| [getTimeout](get-timeout.md) | public [getTimeout](get-timeout.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Gets the script's run timeout. | -| [getType](../-component/get-type.md) | public [getType](../-component/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the type of the component: COMPONENT_TYPE_COMPONENT = "Component" COMPONENT_TYPE_SCRIPTCOMPONENT = "ScriptComponent" COMPONENT_TYPE_ASSEMBLY = "Assembly" COMPONENT_TYPE_SEQUENCE = "Sequence" COMPONENT_TYPE_IF = "If" COMPONENT_TYPE_PARALLEL = "Parallel" COMPONENT_TYPE_EMPTY = "Empty" COMPONENT_TYPE_FOR_EACH = "ForEach" | -| [getUserData](../-component/get-user-data.md) | public [getUserData](../-component/get-user-data.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Get user data of the component. | -| [getVariable](../-component/get-variable.md) | public [getVariable](../-component/get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
gets the specified variable
public [getVariable](../-component/get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
gets the specified variable. | -| [invalidate](../-component/invalidate.md) | public [invalidate](../-component/invalidate.md)()
causes the component to be invalidated | -| [invokeMethod](../-component/invoke-method.md) | public [invokeMethod](../-component/invoke-method.md)(method: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
invokes a method of the Component | -| [reconnect](../-component/reconnect.md) | public [reconnect](../-component/reconnect.md)()
reconnects the component | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [removeVariable](remove-variable.md) | public [removeVariable](remove-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Removes the variable from the script component. | -| [rename](../-component/rename.md) | public [rename](../-component/rename.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Rename the component | -| [run](../-component/run.md) | public [run](../-component/run.md)()
causes the component to run | -| [setAssociatedFiles](../-component/set-associated-files.md) | public [setAssociatedFiles](../-component/set-associated-files.md)(val: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>)
sets the associated files of the component | -| [setForwardSchedule](set-forward-schedule.md) | public [setForwardSchedule](set-forward-schedule.md)(forwardSchedule: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Turns on/off the script's forward scheduling mode. | -| [setLanguage](set-language.md) | public [setLanguage](set-language.md)(language: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the script's source language. | -| [setMetadata](../-component/set-metadata.md) | public [setMetadata](../-component/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a component | -| [setPrevalidate](set-prevalidate.md) | public [setPrevalidate](set-prevalidate.md)(prevalidate: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets the script's prevalidate mode. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setSourceFromFile](set-source-from-file.md) | public [setSourceFromFile](set-source-from-file.md)(file: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the script source code to the value of the given file. | -| [setSourceFromString](set-source-from-string.md) | public [setSourceFromString](set-source-from-string.md)(script: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the script source code to the given string. | -| [setTimeout](set-timeout.md) | public [setTimeout](set-timeout.md)(timeout: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Sets the script's run timeout. | -| [setUserData](../-component/set-user-data.md) | public [setUserData](../-component/set-user-data.md)(val: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
Set user data of the Component | -| [setVariables](set-variables.md) | public [setVariables](set-variables.md)(inputs: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), outputs: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the variables in the script to only those passed into this function. | -| [show](../-component/show.md) | public [show](../-component/show.md)()
Show the GUI form associated with the component, if any. | +# ScriptComponent + + +public class [ScriptComponent](index.md) : [Component](../-component/index.md) + +This is the wrapper class that handles the native COM calls to a ScriptComponent object. + +#### Author + +jboutwell, 8-2011 + +## Properties + +| Name | Summary | +|---|---| +| [COMPONENT_TYPE_ASSEMBLY](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md) | val [COMPONENT_TYPE_ASSEMBLY](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Assembly" | +| [COMPONENT_TYPE_COMPONENT](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md) | val [COMPONENT_TYPE_COMPONENT](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Component" | +| [COMPONENT_TYPE_EMPTY](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md) | val [COMPONENT_TYPE_EMPTY](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Empty" | +| [COMPONENT_TYPE_FOR_EACH](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md) | val [~~COMPONENT_TYPE_FOR_EACH~~](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ForEach" | +| [COMPONENT_TYPE_IF](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md) | val [COMPONENT_TYPE_IF](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "If" | +| [COMPONENT_TYPE_LOOP](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md) | val [COMPONENT_TYPE_LOOP](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Loop" | +| [COMPONENT_TYPE_PARALLEL](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md) | val [COMPONENT_TYPE_PARALLEL](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Parallel" | +| [COMPONENT_TYPE_SCRIPTCOMPONENT](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md) | val [COMPONENT_TYPE_SCRIPTCOMPONENT](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ScriptComponent" | +| [COMPONENT_TYPE_SEQUENCE](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md) | val [COMPONENT_TYPE_SEQUENCE](../-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Sequence" | + +## Functions + +| Name | Summary | +|---|---| +| [addVariable](add-variable.md) | public [addVariable](add-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), state: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
Adds the variable from the script component. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [downloadValues](../-component/download-values.md) | public [downloadValues](../-component/download-values.md)()
downloads the component's variable values from Analysis Server, if it's an Analysis Server component | +| [getAssociatedFiles](../-component/get-associated-files.md) | public [getAssociatedFiles](../-component/get-associated-files.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
gets the associated files of the component | +| [getForwardSchedule](get-forward-schedule.md) | public [getForwardSchedule](get-forward-schedule.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets the state of the script's forward scheduling mode. | +| [getFullName](../-component/get-full-name.md) | public [getFullName](../-component/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the full name of the current object, e.g. | +| [getGroup](../-component/get-group.md) | public [getGroup](../-component/get-group.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Group](../-group/index.md)
public [getGroup](../-component/get-group.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Group](../-group/index.md)
gets the specified group | +| [getIndexInParent](../-component/get-index-in-parent.md) | public [getIndexInParent](../-component/get-index-in-parent.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
Gets the index of the component in its parent assembly. | +| [getLanguage](get-language.md) | public [getLanguage](get-language.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the script's source language. | +| [getMetadata](../-component/get-metadata.md) | public [getMetadata](../-component/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](../-component/get-name.md) | public [getName](../-component/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the current object, e.g. | +| [getNumGroups](../-component/get-num-groups.md) | public [getNumGroups](../-component/get-num-groups.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of groups stored in this object | +| [getNumVariables](../-component/get-num-variables.md) | public [getNumVariables](../-component/get-num-variables.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
get the number of variables stored in this object | +| [getParentAssembly](../-component/get-parent-assembly.md) | public [getParentAssembly](../-component/get-parent-assembly.md)(): [Assembly](../-assembly/index.md)
gets the parent assembly of this component (fails if this is the model/root assembly) | +| [getPositionX](../-component/get-position-x.md) | public [getPositionX](../-component/get-position-x.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the X co-ordinate value of the current object, | +| [getPositionY](../-component/get-position-y.md) | public [getPositionY](../-component/get-position-y.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the Y co-ordinate value of the current object, | +| [getPrevalidate](get-prevalidate.md) | public [getPrevalidate](get-prevalidate.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets the state of the script's prevalidate mode. | +| [getSource](../-component/get-source.md) | public [getSource](../-component/get-source.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the server path for the component, e.g. | +| [getSourceScript](get-source-script.md) | public [getSourceScript](get-source-script.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the source script code associated with this script component. | +| [getTimeout](get-timeout.md) | public [getTimeout](get-timeout.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)
Gets the script's run timeout. | +| [getType](../-component/get-type.md) | public [getType](../-component/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the type of the component: COMPONENT_TYPE_COMPONENT = "Component" COMPONENT_TYPE_SCRIPTCOMPONENT = "ScriptComponent" COMPONENT_TYPE_ASSEMBLY = "Assembly" COMPONENT_TYPE_SEQUENCE = "Sequence" COMPONENT_TYPE_IF = "If" COMPONENT_TYPE_PARALLEL = "Parallel" COMPONENT_TYPE_EMPTY = "Empty" COMPONENT_TYPE_FOR_EACH = "ForEach" | +| [getUserData](../-component/get-user-data.md) | public [getUserData](../-component/get-user-data.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Get user data of the component. | +| [getVariable](../-component/get-variable.md) | public [getVariable](../-component/get-variable.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
gets the specified variable
public [getVariable](../-component/get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
gets the specified variable. | +| [invalidate](../-component/invalidate.md) | public [invalidate](../-component/invalidate.md)()
causes the component to be invalidated | +| [invokeMethod](../-component/invoke-method.md) | public [invokeMethod](../-component/invoke-method.md)(method: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
invokes a method of the Component | +| [reconnect](../-component/reconnect.md) | public [reconnect](../-component/reconnect.md)()
reconnects the component | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [removeVariable](remove-variable.md) | public [removeVariable](remove-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Removes the variable from the script component. | +| [rename](../-component/rename.md) | public [rename](../-component/rename.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Rename the component | +| [run](../-component/run.md) | public [run](../-component/run.md)()
causes the component to run | +| [setAssociatedFiles](../-component/set-associated-files.md) | public [setAssociatedFiles](../-component/set-associated-files.md)(val: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>)
sets the associated files of the component | +| [setForwardSchedule](set-forward-schedule.md) | public [setForwardSchedule](set-forward-schedule.md)(forwardSchedule: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Turns on/off the script's forward scheduling mode. | +| [setLanguage](set-language.md) | public [setLanguage](set-language.md)(language: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the script's source language. | +| [setMetadata](../-component/set-metadata.md) | public [setMetadata](../-component/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a component | +| [setPrevalidate](set-prevalidate.md) | public [setPrevalidate](set-prevalidate.md)(prevalidate: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets the script's prevalidate mode. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setSourceFromFile](set-source-from-file.md) | public [setSourceFromFile](set-source-from-file.md)(file: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the script source code to the value of the given file. | +| [setSourceFromString](set-source-from-string.md) | public [setSourceFromString](set-source-from-string.md)(script: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the script source code to the given string. | +| [setTimeout](set-timeout.md) | public [setTimeout](set-timeout.md)(timeout: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))
Sets the script's run timeout. | +| [setUserData](../-component/set-user-data.md) | public [setUserData](../-component/set-user-data.md)(val: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
Set user data of the Component | +| [setVariables](set-variables.md) | public [setVariables](set-variables.md)(inputs: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), outputs: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the variables in the script to only those passed into this function. | +| [show](../-component/show.md) | public [show](../-component/show.md)()
Show the GUI form associated with the component, if any. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/remove-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/remove-variable.md index acef5f1d18..e4755d27fb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/remove-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/remove-variable.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ScriptComponent](index.md)/[removeVariable](remove-variable.md) - -# removeVariable - - -public [removeVariable](remove-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Removes the variable from the script component. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# removeVariable + + +public [removeVariable](remove-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Removes the variable from the script component. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-forward-schedule.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-forward-schedule.md index a2eb93a9f1..7805e79da4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-forward-schedule.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-forward-schedule.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ScriptComponent](index.md)/[setForwardSchedule](set-forward-schedule.md) - -# setForwardSchedule - - -public [setForwardSchedule](set-forward-schedule.md)(forwardSchedule: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Turns on/off the script's forward scheduling mode. - -#### Parameters - - - -| | | -|---|---| -| forwardSchedule | true to turn on forward scheduling, false to turn off | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setForwardSchedule + + +public [setForwardSchedule](set-forward-schedule.md)(forwardSchedule: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Turns on/off the script's forward scheduling mode. + +#### Parameters + + + +| | | +|---|---| +| forwardSchedule | true to turn on forward scheduling, false to turn off | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-language.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-language.md index 025e5d1103..9107da96e9 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-language.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-language.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ScriptComponent](index.md)/[setLanguage](set-language.md) - -# setLanguage - - -public [setLanguage](set-language.md)(language: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Sets the script's source language. Should be called before setting the script source. - -#### Parameters - - - -| | | -|---|---| -| language | the language to use | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setLanguage + + +public [setLanguage](set-language.md)(language: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Sets the script's source language. Should be called before setting the script source. + +#### Parameters + + + +| | | +|---|---| +| language | the language to use | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-prevalidate.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-prevalidate.md index 7c725c8f92..fb44bcdf47 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-prevalidate.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-prevalidate.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ScriptComponent](index.md)/[setPrevalidate](set-prevalidate.md) - -# setPrevalidate - - -public [setPrevalidate](set-prevalidate.md)(prevalidate: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Sets the script's prevalidate mode. - -#### Parameters - - - -| | | -|---|---| -| prevalidate | true to turn on prevalidate, false to turn off | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setPrevalidate + + +public [setPrevalidate](set-prevalidate.md)(prevalidate: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Sets the script's prevalidate mode. + +#### Parameters + + + +| | | +|---|---| +| prevalidate | true to turn on prevalidate, false to turn off | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-source-from-file.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-source-from-file.md index aa38f5006c..8bc2373bcc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-source-from-file.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-source-from-file.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ScriptComponent](index.md)/[setSourceFromFile](set-source-from-file.md) - -# setSourceFromFile - - -public [setSourceFromFile](set-source-from-file.md)(file: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Sets the script source code to the value of the given file. The source code is parsed baesd on the current language setting. The script language should be set before calling this function. - -#### Parameters - - - -| | | -|---|---| -| file | full path to the source file | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setSourceFromFile + + +public [setSourceFromFile](set-source-from-file.md)(file: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Sets the script source code to the value of the given file. The source code is parsed baesd on the current language setting. The script language should be set before calling this function. + +#### Parameters + + + +| | | +|---|---| +| file | full path to the source file | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-source-from-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-source-from-string.md index 37bc3b7be2..295e985f78 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-source-from-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-source-from-string.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ScriptComponent](index.md)/[setSourceFromString](set-source-from-string.md) - -# setSourceFromString - - -public [setSourceFromString](set-source-from-string.md)(script: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Sets the script source code to the given string. The source code is parsed baesd on the current language setting. The script language should be set before calling this function. - -#### Parameters - - - -| | | -|---|---| -| script | the source code | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setSourceFromString + + +public [setSourceFromString](set-source-from-string.md)(script: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Sets the script source code to the given string. The source code is parsed baesd on the current language setting. The script language should be set before calling this function. + +#### Parameters + + + +| | | +|---|---| +| script | the source code | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-timeout.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-timeout.md index 5cafdcece3..d5bedb8b2d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-timeout.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-timeout.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ScriptComponent](index.md)/[setTimeout](set-timeout.md) - -# setTimeout - - -public [setTimeout](set-timeout.md)(timeout: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) - -Sets the script's run timeout. - -#### Parameters - - - -| | | -|---|---| -| timeout | the run timeout to use for this component | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setTimeout + + +public [setTimeout](set-timeout.md)(timeout: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)) + +Sets the script's run timeout. + +#### Parameters + + + +| | | +|---|---| +| timeout | the run timeout to use for this component | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-variables.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-variables.md index 576d5de5ff..dc574db3a6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-variables.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-script-component/set-variables.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[ScriptComponent](index.md)/[setVariables](set-variables.md) - -# setVariables - - -public [setVariables](set-variables.md)(inputs: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), outputs: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Sets the variables in the script to only those passed into this function. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setVariables + + +public [setVariables](set-variables.md)(inputs: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), outputs: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Sets the variables in the script to only those passed into this function. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-description.md index fa84b36758..f0c010045f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-description.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringArray](index.md)/[getDescription](get-description.md) - -# getDescription - - -public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the description for the variable - -#### Return - -the description of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDescription + + +public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the description for the variable + +#### Return + +the description of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-enum-aliases.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-enum-aliases.md index ababa8e3ea..2c0d029f18 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-enum-aliases.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-enum-aliases.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringArray](index.md)/[getEnumAliases](get-enum-aliases.md) - -# getEnumAliases - - -public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the enumerated aliases for the variable - -#### Return - -a comma separated list of enumerated aliases - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEnumAliases + + +public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the enumerated aliases for the variable + +#### Return + +a comma separated list of enumerated aliases + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-enum-values.md index de36fbb0a4..f3b1305238 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-enum-values.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringArray](index.md)/[getEnumValues](get-enum-values.md) - -# getEnumValues - - -public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the enumerated values for the variable - -#### Return - -a comma separated list of enumerated values - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEnumValues + + +public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the enumerated values for the variable + +#### Return + +a comma separated list of enumerated values + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md index af10737eed..9a0f64d356 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md @@ -1,301 +1,299 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringArray](index.md)/[getValueAbsolute](get-value-absolute.md) - -# getValueAbsolute - - -public [getValueAbsolute](get-value-absolute.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| index | index in string form, i.e. [1][2][3] | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location without validating. - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | -| d10 | index in the 10th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValueAbsolute + + +public [getValueAbsolute](get-value-absolute.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| index | index in string form, i.e. [1][2][3] | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location without validating. + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | +| d10 | index in the 10th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md index b52a1eec9b..fe58ab3dc4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md @@ -1,301 +1,299 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringArray](index.md)/[getValue](get-value.md) - -# getValue - - -public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| index | index in string form, i.e. [1][2][3] | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable at a specific location - -#### Return - -the value of the variable - -#### Parameters - - - -| | | -|---|---| -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | -| d10 | index in the 10th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValue + + +public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| index | index in string form, i.e. [1][2][3] | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable at a specific location + +#### Return + +the value of the variable + +#### Parameters + + + +| | | +|---|---| +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | +| d10 | index in the 10th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/index.md index add4743e43..0a514db144 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/index.md @@ -1,63 +1,61 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringArray](index.md) - -# StringArray - - -public class [StringArray](index.md) : [Array](../-array/index.md) - -A array type class for ModelCenter - -#### Author - -Woyak, 10/2001 - -## Functions - -| Name | Summary | -|---|---| -| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromString](../-array/from-string.md) | public [fromString](../-array/from-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value for the variable from a string
public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | -| [getAutoSize](../-array/get-auto-size.md) | public [getAutoSize](../-array/get-auto-size.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the autoSize flag. | -| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | -| [getDimensions](../-array/get-dimensions.md) | public [getDimensions](../-array/get-dimensions.md)(): [Variant](../-variant/index.md)
gets the dimensions of an array | -| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | -| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | -| [getEnumAliases](get-enum-aliases.md) | public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated aliases for the variable | -| [getEnumValues](get-enum-values.md) | public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated values for the variable | -| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | -| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | -| [getLength](../-array/get-length.md) | public [getLength](../-array/get-length.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getLength](../-array/get-length.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | -| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | -| [getNumDimensions](../-array/get-num-dimensions.md) | public [getNumDimensions](../-array/get-num-dimensions.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of dimensions | -| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | -| [getSize](../-array/get-size.md) | public [getSize](../-array/get-size.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getSize](../-array/get-size.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | -| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | -| [getValue](get-value.md) | public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the value of the variable at a specific location | -| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the value of the variable at a specific location without validating. | -| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | -| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | -| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | -| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | -| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | -| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setAutoSize](../-array/set-auto-size.md) | public [setAutoSize](../-array/set-auto-size.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the autoSize flag. | -| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | -| [setDimensions](../-array/set-dimensions.md) | public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the dimensions of the array | -| [setEnumAliases](set-enum-aliases.md) | public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated aliases for the variable. | -| [setEnumValues](set-enum-values.md) | public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated values for the variable | -| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | -| [setLength](../-array/set-length.md) | public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | -| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | -| [setNumDimensions](../-array/set-num-dimensions.md) | public [setNumDimensions](../-array/set-num-dimensions.md)(num: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the number of dimensions | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setSize](../-array/set-size.md) | public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | -| [setValue](set-value.md) | public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value of the variable at a specific location | -| [toString](../-array/to-string.md) | public [toString](../-array/to-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [toStringAbsolute](../-array/to-string-absolute.md) | public [toStringAbsolute](../-array/to-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | +# StringArray + + +public class [StringArray](index.md) : [Array](../-array/index.md) + +A array type class for ModelCenter + +#### Author + +Woyak, 10/2001 + +## Functions + +| Name | Summary | +|---|---| +| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromString](../-array/from-string.md) | public [fromString](../-array/from-string.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value for the variable from a string
public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | +| [getAutoSize](../-array/get-auto-size.md) | public [getAutoSize](../-array/get-auto-size.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
gets the autoSize flag. | +| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | +| [getDimensions](../-array/get-dimensions.md) | public [getDimensions](../-array/get-dimensions.md)(): [Variant](../-variant/index.md)
gets the dimensions of an array | +| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | +| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | +| [getEnumAliases](get-enum-aliases.md) | public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated aliases for the variable | +| [getEnumValues](get-enum-values.md) | public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated values for the variable | +| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | +| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | +| [getLength](../-array/get-length.md) | public [getLength](../-array/get-length.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getLength](../-array/get-length.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | +| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | +| [getNumDimensions](../-array/get-num-dimensions.md) | public [getNumDimensions](../-array/get-num-dimensions.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the number of dimensions | +| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | +| [getSize](../-array/get-size.md) | public [getSize](../-array/get-size.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of the array.
public [getSize](../-array/get-size.md)(dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)
gets the size of a specific dimension in the array. | +| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | +| [getValue](get-value.md) | public [getValue](get-value.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValue](get-value.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the value of the variable at a specific location | +| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
public [getValueAbsolute](get-value-absolute.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the value of the variable at a specific location without validating. | +| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | +| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | +| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | +| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | +| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | +| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setAutoSize](../-array/set-auto-size.md) | public [setAutoSize](../-array/set-auto-size.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
sets the autoSize flag. | +| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | +| [setDimensions](../-array/set-dimensions.md) | public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setDimensions](../-array/set-dimensions.md)(d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the dimensions of the array | +| [setEnumAliases](set-enum-aliases.md) | public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated aliases for the variable. | +| [setEnumValues](set-enum-values.md) | public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated values for the variable | +| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | +| [setLength](../-array/set-length.md) | public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setLength](../-array/set-length.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | +| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | +| [setNumDimensions](../-array/set-num-dimensions.md) | public [setNumDimensions](../-array/set-num-dimensions.md)(num: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the number of dimensions | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setSize](../-array/set-size.md) | public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of the array.
public [setSize](../-array/set-size.md)(size: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), dimension: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the size of a specific dimension in the array. | +| [setValue](set-value.md) | public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))
sets the value of the variable at a specific location | +| [toString](../-array/to-string.md) | public [toString](../-array/to-string.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [toStringAbsolute](../-array/to-string-absolute.md) | public [toStringAbsolute](../-array/to-string-absolute.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
converts the variable value to a string representation.
public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/set-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/set-description.md index c82c3ad392..0147b158ab 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/set-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/set-description.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringArray](index.md)/[setDescription](set-description.md) - -# setDescription - - -public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the description for the variable - -#### Parameters - - - -| | | -|---|---| -| description | the description of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDescription + + +public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the description for the variable + +#### Parameters + + + +| | | +|---|---| +| description | the description of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/set-enum-aliases.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/set-enum-aliases.md index 10550de798..6539bf2c47 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/set-enum-aliases.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/set-enum-aliases.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringArray](index.md)/[setEnumAliases](set-enum-aliases.md) - -# setEnumAliases - - -public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the enumerated aliases for the variable. If specified, the enumerated aliases are alias values for enumerated values. For example, if the enumerated values are set to "1,2,3", and the enumerated aliases are set to "one,two,three", then calling fromString( "three" ) will result in the value being set to 3. - -#### Parameters - - - -| | | -|---|---| -| enumAliases | a comma separated list of enumerated aliases | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setEnumAliases + + +public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the enumerated aliases for the variable. If specified, the enumerated aliases are alias values for enumerated values. For example, if the enumerated values are set to "1,2,3", and the enumerated aliases are set to "one,two,three", then calling fromString( "three" ) will result in the value being set to 3. + +#### Parameters + + + +| | | +|---|---| +| enumAliases | a comma separated list of enumerated aliases | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/set-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/set-enum-values.md index 49b8a32a03..cd284612b6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/set-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/set-enum-values.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringArray](index.md)/[setEnumValues](set-enum-values.md) - -# setEnumValues - - -public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the enumerated values for the variable - -#### Parameters - - - -| | | -|---|---| -| enumValues | a comma separated list of values | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setEnumValues + + +public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the enumerated values for the variable + +#### Parameters + + + +| | | +|---|---| +| enumValues | a comma separated list of values | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md index f2581315f2..3939c5034d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md @@ -1,268 +1,266 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringArray](index.md)/[setValue](set-value.md) - -# setValue - - -public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| index | index in string form, i.e. [1][2][3] | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) - -sets the value of the variable at a specific location - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | -| d1 | index in the 1st dimension (0-based index) | -| d2 | index in the 2nd dimension (0-based index) | -| d3 | index in the 3rd dimension (0-based index) | -| d4 | index in the 4th dimension (0-based index) | -| d5 | index in the 5th dimension (0-based index) | -| d6 | index in the 6th dimension (0-based index) | -| d7 | index in the 7th dimension (0-based index) | -| d8 | index in the 8th dimension (0-based index) | -| d9 | index in the 9th dimension (0-based index) | -| d10 | index in the 10th dimension (0-based index) | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setValue + + +public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| index | index in string form, i.e. [1][2][3] | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), d1: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d2: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d3: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d4: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d5: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d6: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d7: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d8: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d9: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), d10: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) + +sets the value of the variable at a specific location + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | +| d1 | index in the 1st dimension (0-based index) | +| d2 | index in the 2nd dimension (0-based index) | +| d3 | index in the 3rd dimension (0-based index) | +| d4 | index in the 4th dimension (0-based index) | +| d5 | index in the 5th dimension (0-based index) | +| d6 | index in the 6th dimension (0-based index) | +| d7 | index in the 7th dimension (0-based index) | +| d8 | index in the 8th dimension (0-based index) | +| d9 | index in the 9th dimension (0-based index) | +| d10 | index in the 10th dimension (0-based index) | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-description.md index 7b3deeb487..f0c010045f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-description.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringVariable](index.md)/[getDescription](get-description.md) - -# getDescription - - -public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the description for the variable - -#### Return - -the description of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDescription + + +public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the description for the variable + +#### Return + +the description of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-enum-aliases.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-enum-aliases.md index acf1cc3409..2c0d029f18 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-enum-aliases.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-enum-aliases.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringVariable](index.md)/[getEnumAliases](get-enum-aliases.md) - -# getEnumAliases - - -public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the enumerated aliases for the variable - -#### Return - -a comma separated list of enumerated aliases - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEnumAliases + + +public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the enumerated aliases for the variable + +#### Return + +a comma separated list of enumerated aliases + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-enum-values.md index 0e85d39b19..f3b1305238 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-enum-values.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringVariable](index.md)/[getEnumValues](get-enum-values.md) - -# getEnumValues - - -public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the enumerated values for the variable - -#### Return - -a comma separated list of enumerated values - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEnumValues + + +public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the enumerated values for the variable + +#### Return + +a comma separated list of enumerated values + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-value-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-value-absolute.md index e19c015bb8..3dcf05e537 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-value-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-value-absolute.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringVariable](index.md)/[getValueAbsolute](get-value-absolute.md) - -# getValueAbsolute - - -public [getValueAbsolute](get-value-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable without validating it - -#### Return - -the value of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValueAbsolute + + +public [getValueAbsolute](get-value-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable without validating it + +#### Return + +the value of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-value.md index 2b832189a3..f2aa424a85 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-value.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringVariable](index.md)/[getValue](get-value.md) - -# getValue - - -public [getValue](get-value.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the value of the variable - -#### Return - -the value of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getValue + + +public [getValue](get-value.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the value of the variable + +#### Return + +the value of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/index.md index 554e78e06b..cfdd1c1590 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/index.md @@ -1,53 +1,51 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringVariable](index.md) - -# StringVariable - - -public class [StringVariable](index.md) : [Variable](../-variable/index.md) - -A variable type class for ModelCenter - -#### Author - -Woyak, 9/2001 - -## Functions - -| Name | Summary | -|---|---| -| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromString](../-variable/from-string.md) | public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | -| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | -| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | -| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | -| [getEnumAliases](get-enum-aliases.md) | public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated aliases for the variable | -| [getEnumValues](get-enum-values.md) | public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated values for the variable | -| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | -| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | -| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | -| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | -| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | -| [getValue](get-value.md) | public [getValue](get-value.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the value of the variable | -| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the value of the variable without validating it | -| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | -| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | -| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | -| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | -| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | -| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | -| [setEnumAliases](set-enum-aliases.md) | public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated aliases for the variable. | -| [setEnumValues](set-enum-values.md) | public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated values for the variable | -| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | -| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setValue](set-value.md) | public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value of the variable | -| [toString](../-variable/to-string.md) | public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [toStringAbsolute](../-variable/to-string-absolute.md) | public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | +# StringVariable + + +public class [StringVariable](index.md) : [Variable](../-variable/index.md) + +A variable type class for ModelCenter + +#### Author + +Woyak, 9/2001 + +## Functions + +| Name | Summary | +|---|---| +| [dependentLinks](../-variable/dependent-links.md) | public [dependentLinks](../-variable/dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromString](../-variable/from-string.md) | public [fromString](../-variable/from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | +| [getDescription](get-description.md) | public [getDescription](get-description.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the description for the variable | +| [getDirectDependents](../-variable/get-direct-dependents.md) | public [getDirectDependents](../-variable/get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](../-variable/get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | +| [getDirectPrecedents](../-variable/get-direct-precedents.md) | public [getDirectPrecedents](../-variable/get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](../-variable/get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | +| [getEnumAliases](get-enum-aliases.md) | public [getEnumAliases](get-enum-aliases.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated aliases for the variable | +| [getEnumValues](get-enum-values.md) | public [getEnumValues](get-enum-values.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the enumerated values for the variable | +| [getFullName](../-variable/get-full-name.md) | public [getFullName](../-variable/get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | +| [getHasChanged](../-variable/get-has-changed.md) | public [getHasChanged](../-variable/get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [getHide](../-variable/get-hide.md) | public [getHide](../-variable/get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | +| [getMetadata](../-variable/get-metadata.md) | public [getMetadata](../-variable/get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](../-variable/get-name.md) | public [getName](../-variable/get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | +| [getOwningComponent](../-variable/get-owning-component.md) | public [getOwningComponent](../-variable/get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | +| [getType](../-variable/get-type.md) | public [getType](../-variable/get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | +| [getValue](get-value.md) | public [getValue](get-value.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the value of the variable | +| [getValueAbsolute](get-value-absolute.md) | public [getValueAbsolute](get-value-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the value of the variable without validating it | +| [invalidate](../-variable/invalidate.md) | public [invalidate](../-variable/invalidate.md)()
Invalidates the variable | +| [isInput](../-variable/is-input.md) | public [~~isInput~~](../-variable/is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | +| [isInputToComponent](../-variable/is-input-to-component.md) | public [isInputToComponent](../-variable/is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | +| [isInputToModel](../-variable/is-input-to-model.md) | public [isInputToModel](../-variable/is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | +| [isValid](../-variable/is-valid.md) | public [isValid](../-variable/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | +| [precedentLinks](../-variable/precedent-links.md) | public [precedentLinks](../-variable/precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setDescription](set-description.md) | public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the description for the variable | +| [setEnumAliases](set-enum-aliases.md) | public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated aliases for the variable. | +| [setEnumValues](set-enum-values.md) | public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the enumerated values for the variable | +| [setHasChanged](../-variable/set-has-changed.md) | public [setHasChanged](../-variable/set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [setHide](../-variable/set-hide.md) | public [setHide](../-variable/set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | +| [setMetadata](../-variable/set-metadata.md) | public [setMetadata](../-variable/set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](../-variable/-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](../-variable/-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setValue](set-value.md) | public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
sets the value of the variable | +| [toString](../-variable/to-string.md) | public [toString](../-variable/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [toStringAbsolute](../-variable/to-string-absolute.md) | public [toStringAbsolute](../-variable/to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [validate](../-variable/validate.md) | public [validate](../-variable/validate.md)()
Causes the scheduler to get a valid value for this variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-description.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-description.md index c8d01928fc..0147b158ab 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-description.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-description.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringVariable](index.md)/[setDescription](set-description.md) - -# setDescription - - -public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the description for the variable - -#### Parameters - - - -| | | -|---|---| -| description | the description of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setDescription + + +public [setDescription](set-description.md)(description: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the description for the variable + +#### Parameters + + + +| | | +|---|---| +| description | the description of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-enum-aliases.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-enum-aliases.md index 5c612c6c8a..6539bf2c47 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-enum-aliases.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-enum-aliases.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringVariable](index.md)/[setEnumAliases](set-enum-aliases.md) - -# setEnumAliases - - -public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the enumerated aliases for the variable. If specified, the enumerated aliases are alias values for enumerated values. For example, if the enumerated values are set to "1,2,3", and the enumerated aliases are set to "one,two,three", then calling fromString( "three" ) will result in the value being set to 3. - -#### Parameters - - - -| | | -|---|---| -| enumAliases | a comma separated list of enumerated aliases | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setEnumAliases + + +public [setEnumAliases](set-enum-aliases.md)(enumAliases: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the enumerated aliases for the variable. If specified, the enumerated aliases are alias values for enumerated values. For example, if the enumerated values are set to "1,2,3", and the enumerated aliases are set to "one,two,three", then calling fromString( "three" ) will result in the value being set to 3. + +#### Parameters + + + +| | | +|---|---| +| enumAliases | a comma separated list of enumerated aliases | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-enum-values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-enum-values.md index 78fecdc4d1..cd284612b6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-enum-values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-enum-values.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringVariable](index.md)/[setEnumValues](set-enum-values.md) - -# setEnumValues - - -public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the enumerated values for the variable - -#### Parameters - - - -| | | -|---|---| -| enumValues | a comma separated list of values | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setEnumValues + + +public [setEnumValues](set-enum-values.md)(enumValues: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the enumerated values for the variable + +#### Parameters + + + +| | | +|---|---| +| enumValues | a comma separated list of values | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-value.md index 9a04c09de5..3210ea5545 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-value.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[StringVariable](index.md)/[setValue](set-value.md) - -# setValue - - -public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -sets the value of the variable - -#### Parameters - - - -| | | -|---|---| -| value | the value of the variable | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setValue + + +public [setValue](set-value.md)(value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +sets the value of the variable + +#### Parameters + + + +| | | +|---|---| +| value | the value of the variable | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study/from-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study/from-string.md index add0176b7e..d75b1e73d0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study/from-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study/from-string.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[TradeStudy](index.md)/[fromString](from-string.md) - -# fromString - - -public [fromString](from-string.md)(setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Called to restore the state of a plug-in - -#### Parameters - - - -| | | -|---|---| -| setup | the state string | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if there is an error. | +# fromString + + +public [fromString](from-string.md)(setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Called to restore the state of a plug-in + +#### Parameters + + + +| | | +|---|---| +| setup | the state string | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if there is an error. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study/index.md index 44073dea07..ef52299f3a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study/index.md @@ -1,30 +1,28 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[TradeStudy](index.md) - -# TradeStudy - -public class [TradeStudy](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -This is the wrapper class that handles the native COM calls to a TradeStudy object. - -#### Author - -agardner, 08-2012 - -#### Inheritors - -| | -|---| -| [TradeStudy2](../-trade-study2/index.md) | -| [TradeStudy2](../-trade-study2/index.md) | - -## Functions - -| Name | Summary | -|---|---| -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromString](from-string.md) | public [fromString](from-string.md)(setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Called to restore the state of a plug-in | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [show](show.md) | public [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Called to display the trade study. | -| [toString](to-string.md) | public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Called to save the state of the plug-in. | +# TradeStudy + +public class [TradeStudy](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +This is the wrapper class that handles the native COM calls to a TradeStudy object. + +#### Author + +agardner, 08-2012 + +#### Inheritors + +| | +|---| +| [TradeStudy2](../-trade-study2/index.md) | +| [TradeStudy2](../-trade-study2/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromString](from-string.md) | public [fromString](from-string.md)(setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Called to restore the state of a plug-in | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [show](show.md) | public [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Called to display the trade study. | +| [toString](to-string.md) | public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Called to save the state of the plug-in. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study/show.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study/show.md index 9085c27261..1775e18d44 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study/show.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study/show.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[TradeStudy](index.md)/[show](show.md) - -# show - - -public [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Called to display the trade study. - -#### Return - -false always - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if there is an error. | +# show + + +public [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Called to display the trade study. + +#### Return + +false always + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if there is an error. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study/to-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study/to-string.md index f3e8901e8e..9c071b4a47 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study/to-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study/to-string.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[TradeStudy](index.md)/[toString](to-string.md) - -# toString - - -public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Called to save the state of the plug-in. - -#### Return - -a string containing state information +# toString + + +public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Called to save the state of the plug-in. + +#### Return + +a string containing state information diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/add-analyzer-variable.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/add-analyzer-variable.md index 7c11446c9d..110ca48c0f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/add-analyzer-variable.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/add-analyzer-variable.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[TradeStudy2](index.md)/[addAnalyzerVariable](add-analyzer-variable.md) - -# addAnalyzerVariable - - -public [addAnalyzerVariable](add-analyzer-variable.md)(formula: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), analyzerName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Call to add a variable from an analyzer product. If there are any analyzer variables, the plugin should only accept analyzer variables as trade study parameters. - -#### Parameters - - - -| | | -|---|---| -| formula | the formula of the variable or expression in the ModelCenter model | -| analyzerName | the name of the variable used by the analyzer product; if not specified, the formula is used instead. The plugin should only display and accept analyzer names. | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | on error | +# addAnalyzerVariable + + +public [addAnalyzerVariable](add-analyzer-variable.md)(formula: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), analyzerName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Call to add a variable from an analyzer product. If there are any analyzer variables, the plugin should only accept analyzer variables as trade study parameters. + +#### Parameters + + + +| | | +|---|---| +| formula | the formula of the variable or expression in the ModelCenter model | +| analyzerName | the name of the variable used by the analyzer product; if not specified, the formula is used instead. The plugin should only display and accept analyzer names. | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | on error | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/clear-analyzer-variables.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/clear-analyzer-variables.md index 73221447e9..12c777ba59 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/clear-analyzer-variables.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/clear-analyzer-variables.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[TradeStudy2](index.md)/[clearAnalyzerVariables](clear-analyzer-variables.md) - -# clearAnalyzerVariables - - -public [clearAnalyzerVariables](clear-analyzer-variables.md)() - -Remove all analyzer variables. - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | on error | +# clearAnalyzerVariables + + +public [clearAnalyzerVariables](clear-analyzer-variables.md)() + +Remove all analyzer variables. + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | on error | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/from-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/from-string.md index ff80a8adf9..d75b1e73d0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/from-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/from-string.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[TradeStudy2](index.md)/[fromString](from-string.md) - -# fromString - - -public [fromString](from-string.md)(setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Called to restore the state of a plug-in - -#### Parameters - - - -| | | -|---|---| -| setup | the state string | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if there is an error. | +# fromString + + +public [fromString](from-string.md)(setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Called to restore the state of a plug-in + +#### Parameters + + + +| | | +|---|---| +| setup | the state string | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if there is an error. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/get-save-all-analyzer-variables.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/get-save-all-analyzer-variables.md index 2d61ddf06a..38e53f7590 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/get-save-all-analyzer-variables.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/get-save-all-analyzer-variables.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[TradeStudy2](index.md)/[getSaveAllAnalyzerVariables](get-save-all-analyzer-variables.md) - -# getSaveAllAnalyzerVariables - - -public [getSaveAllAnalyzerVariables](get-save-all-analyzer-variables.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Gets whether all analyzer variables are saved in the data history when the trade study is run. Only affects variables added using [addAnalyzerVariable](add-analyzer-variable.md), otherwise the global ModelCenter setting is used (as per usual). The default is false. - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | on error | +# getSaveAllAnalyzerVariables + + +public [getSaveAllAnalyzerVariables](get-save-all-analyzer-variables.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Gets whether all analyzer variables are saved in the data history when the trade study is run. Only affects variables added using [addAnalyzerVariable](add-analyzer-variable.md), otherwise the global ModelCenter setting is used (as per usual). The default is false. + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | on error | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/get-trade-study-callback.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/get-trade-study-callback.md index 1b192d7005..2e59c55017 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/get-trade-study-callback.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/get-trade-study-callback.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[TradeStudy2](index.md)/[getTradeStudyCallback](get-trade-study-callback.md) - -# getTradeStudyCallback - - -public [getTradeStudyCallback](get-trade-study-callback.md)(): [ITradeStudyCallback](../-i-trade-study-callback/index.md) - -Gets the trade study call back object. - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if an error occurs. | +# getTradeStudyCallback + + +public [getTradeStudyCallback](get-trade-study-callback.md)(): [ITradeStudyCallback](../-i-trade-study-callback/index.md) + +Gets the trade study call back object. + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if an error occurs. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/index.md index 5ff0c39213..fc92beed2f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/index.md @@ -1,37 +1,35 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[TradeStudy2](index.md) - -# TradeStudy2 - -public class [TradeStudy2](index.md) : [TradeStudy](../-trade-study/index.md) - -This is the wrapper class that handles the native COM calls to a TradeStudy2 object. - -#### Author - -agardner, 08-2012 - -#### Inheritors - -| | -|---| -| [TradeStudy3](../-trade-study3/index.md) | -| [TradeStudy3](../-trade-study3/index.md) | - -## Functions - -| Name | Summary | -|---|---| -| [addAnalyzerVariable](add-analyzer-variable.md) | public [addAnalyzerVariable](add-analyzer-variable.md)(formula: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), analyzerName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Call to add a variable from an analyzer product. | -| [clearAnalyzerVariables](clear-analyzer-variables.md) | public [clearAnalyzerVariables](clear-analyzer-variables.md)()
Remove all analyzer variables. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromString](from-string.md) | public [fromString](from-string.md)(setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Called to restore the state of a plug-in | -| [getSaveAllAnalyzerVariables](get-save-all-analyzer-variables.md) | public [getSaveAllAnalyzerVariables](get-save-all-analyzer-variables.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether all analyzer variables are saved in the data history when the trade study is run. | -| [getTradeStudyCallback](get-trade-study-callback.md) | public [getTradeStudyCallback](get-trade-study-callback.md)(): [ITradeStudyCallback](../-i-trade-study-callback/index.md)
Gets the trade study call back object. | -| [onEnd](on-end.md) | public [onEnd](on-end.md)()
Called when the plug-in is about to be deleted. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setSaveAllAnalyzerVariables](set-save-all-analyzer-variables.md) | public [setSaveAllAnalyzerVariables](set-save-all-analyzer-variables.md)(saveAll: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets whether all analyzer variables are saved in the data history when the trade study is run. | -| [setTradeStudyCallback](set-trade-study-callback.md) | public [setTradeStudyCallback](set-trade-study-callback.md)(cb: [ITradeStudyCallback](../-i-trade-study-callback/index.md))
Sets the trade study call back object. | -| [show](show.md) | public [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Called to display the trade study. | -| [toString](to-string.md) | public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Called to save the state of the plug-in. | +# TradeStudy2 + +public class [TradeStudy2](index.md) : [TradeStudy](../-trade-study/index.md) + +This is the wrapper class that handles the native COM calls to a TradeStudy2 object. + +#### Author + +agardner, 08-2012 + +#### Inheritors + +| | +|---| +| [TradeStudy3](../-trade-study3/index.md) | +| [TradeStudy3](../-trade-study3/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [addAnalyzerVariable](add-analyzer-variable.md) | public [addAnalyzerVariable](add-analyzer-variable.md)(formula: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), analyzerName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Call to add a variable from an analyzer product. | +| [clearAnalyzerVariables](clear-analyzer-variables.md) | public [clearAnalyzerVariables](clear-analyzer-variables.md)()
Remove all analyzer variables. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromString](from-string.md) | public [fromString](from-string.md)(setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Called to restore the state of a plug-in | +| [getSaveAllAnalyzerVariables](get-save-all-analyzer-variables.md) | public [getSaveAllAnalyzerVariables](get-save-all-analyzer-variables.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether all analyzer variables are saved in the data history when the trade study is run. | +| [getTradeStudyCallback](get-trade-study-callback.md) | public [getTradeStudyCallback](get-trade-study-callback.md)(): [ITradeStudyCallback](../-i-trade-study-callback/index.md)
Gets the trade study call back object. | +| [onEnd](on-end.md) | public [onEnd](on-end.md)()
Called when the plug-in is about to be deleted. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setSaveAllAnalyzerVariables](set-save-all-analyzer-variables.md) | public [setSaveAllAnalyzerVariables](set-save-all-analyzer-variables.md)(saveAll: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets whether all analyzer variables are saved in the data history when the trade study is run. | +| [setTradeStudyCallback](set-trade-study-callback.md) | public [setTradeStudyCallback](set-trade-study-callback.md)(cb: [ITradeStudyCallback](../-i-trade-study-callback/index.md))
Sets the trade study call back object. | +| [show](show.md) | public [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Called to display the trade study. | +| [toString](to-string.md) | public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Called to save the state of the plug-in. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/on-end.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/on-end.md index 4a491a3de7..eb16ba8d35 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/on-end.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/on-end.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[TradeStudy2](index.md)/[onEnd](on-end.md) - -# onEnd - - -public [onEnd](on-end.md)() - -Called when the plug-in is about to be deleted. Informs the Plug-In to do any necessary clean up. - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | thrown if an error occurs | +# onEnd + + +public [onEnd](on-end.md)() + +Called when the plug-in is about to be deleted. Informs the Plug-In to do any necessary clean up. + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | thrown if an error occurs | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/set-save-all-analyzer-variables.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/set-save-all-analyzer-variables.md index e69cc2a083..6c8318034b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/set-save-all-analyzer-variables.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/set-save-all-analyzer-variables.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[TradeStudy2](index.md)/[setSaveAllAnalyzerVariables](set-save-all-analyzer-variables.md) - -# setSaveAllAnalyzerVariables - - -public [setSaveAllAnalyzerVariables](set-save-all-analyzer-variables.md)(saveAll: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Sets whether all analyzer variables are saved in the data history when the trade study is run. Only affects variables added using [addAnalyzerVariable](add-analyzer-variable.md), otherwise the global ModelCenter setting is used (as per usual). The default is false. NOTE: not fully supported in MC 10.2 - you can (and should) set this value as appropriate but setting to true may not have an effect until all of the requisite functionality is added. - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | on error | +# setSaveAllAnalyzerVariables + + +public [setSaveAllAnalyzerVariables](set-save-all-analyzer-variables.md)(saveAll: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Sets whether all analyzer variables are saved in the data history when the trade study is run. Only affects variables added using [addAnalyzerVariable](add-analyzer-variable.md), otherwise the global ModelCenter setting is used (as per usual). The default is false. NOTE: not fully supported in MC 10.2 - you can (and should) set this value as appropriate but setting to true may not have an effect until all of the requisite functionality is added. + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | on error | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/set-trade-study-callback.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/set-trade-study-callback.md index 9d6609e8a2..df5ae2f395 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/set-trade-study-callback.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/set-trade-study-callback.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[TradeStudy2](index.md)/[setTradeStudyCallback](set-trade-study-callback.md) - -# setTradeStudyCallback - - -public [setTradeStudyCallback](set-trade-study-callback.md)(cb: [ITradeStudyCallback](../-i-trade-study-callback/index.md)) - -Sets the trade study call back object. - -#### Parameters - - - -| | | -|---|---| -| cb | the trade study callback | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if an error occurs. | +# setTradeStudyCallback + + +public [setTradeStudyCallback](set-trade-study-callback.md)(cb: [ITradeStudyCallback](../-i-trade-study-callback/index.md)) + +Sets the trade study call back object. + +#### Parameters + + + +| | | +|---|---| +| cb | the trade study callback | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if an error occurs. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/show.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/show.md index c841905803..1775e18d44 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/show.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/show.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[TradeStudy2](index.md)/[show](show.md) - -# show - - -public [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Called to display the trade study. - -#### Return - -false always - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if there is an error. | +# show + + +public [show](show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Called to display the trade study. + +#### Return + +false always + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if there is an error. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/to-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/to-string.md index 414656a8ed..9c071b4a47 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/to-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study2/to-string.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[TradeStudy2](index.md)/[toString](to-string.md) - -# toString - - -public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Called to save the state of the plug-in. - -#### Return - -a string containing state information +# toString + + +public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Called to save the state of the plug-in. + +#### Return + +a string containing state information diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study3/get-job-manager.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study3/get-job-manager.md index 43c8f6ce7a..06f574edd4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study3/get-job-manager.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study3/get-job-manager.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[TradeStudy3](index.md)/[getJobManager](get-job-manager.md) - -# getJobManager - - -public [getJobManager](get-job-manager.md)(): [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md) +# getJobManager + + +public [getJobManager](get-job-manager.md)(): [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study3/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study3/index.md index 6855147560..3827e4bc04 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study3/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study3/index.md @@ -1,33 +1,31 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[TradeStudy3](index.md) - -# TradeStudy3 - - -public class [TradeStudy3](index.md) : [TradeStudy2](../-trade-study2/index.md) - -Class that wraps an ITradeStudy3PlugIn COM object. - -#### Author - -Dave - -## Functions - -| Name | Summary | -|---|---| -| [addAnalyzerVariable](../-trade-study2/add-analyzer-variable.md) | public [addAnalyzerVariable](../-trade-study2/add-analyzer-variable.md)(formula: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), analyzerName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Call to add a variable from an analyzer product. | -| [clearAnalyzerVariables](../-trade-study2/clear-analyzer-variables.md) | public [clearAnalyzerVariables](../-trade-study2/clear-analyzer-variables.md)()
Remove all analyzer variables. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromString](../-trade-study2/from-string.md) | public [fromString](../-trade-study2/from-string.md)(setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Called to restore the state of a plug-in | -| [getJobManager](get-job-manager.md) | public [getJobManager](get-job-manager.md)(): [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md) | -| [getSaveAllAnalyzerVariables](../-trade-study2/get-save-all-analyzer-variables.md) | public [getSaveAllAnalyzerVariables](../-trade-study2/get-save-all-analyzer-variables.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether all analyzer variables are saved in the data history when the trade study is run. | -| [getTradeStudyCallback](../-trade-study2/get-trade-study-callback.md) | public [getTradeStudyCallback](../-trade-study2/get-trade-study-callback.md)(): [ITradeStudyCallback](../-i-trade-study-callback/index.md)
Gets the trade study call back object. | -| [onEnd](../-trade-study2/on-end.md) | public [onEnd](../-trade-study2/on-end.md)()
Called when the plug-in is about to be deleted. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setJobManager](set-job-manager.md) | public [setJobManager](set-job-manager.md)(jobManager: [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md)) | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [setSaveAllAnalyzerVariables](../-trade-study2/set-save-all-analyzer-variables.md) | public [setSaveAllAnalyzerVariables](../-trade-study2/set-save-all-analyzer-variables.md)(saveAll: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets whether all analyzer variables are saved in the data history when the trade study is run. | -| [setTradeStudyCallback](../-trade-study2/set-trade-study-callback.md) | public [setTradeStudyCallback](../-trade-study2/set-trade-study-callback.md)(cb: [ITradeStudyCallback](../-i-trade-study-callback/index.md))
Sets the trade study call back object. | -| [show](../-trade-study2/show.md) | public [show](../-trade-study2/show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Called to display the trade study. | -| [toString](../-trade-study2/to-string.md) | public [toString](../-trade-study2/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Called to save the state of the plug-in. | +# TradeStudy3 + + +public class [TradeStudy3](index.md) : [TradeStudy2](../-trade-study2/index.md) + +Class that wraps an ITradeStudy3PlugIn COM object. + +#### Author + +Dave + +## Functions + +| Name | Summary | +|---|---| +| [addAnalyzerVariable](../-trade-study2/add-analyzer-variable.md) | public [addAnalyzerVariable](../-trade-study2/add-analyzer-variable.md)(formula: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), analyzerName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Call to add a variable from an analyzer product. | +| [clearAnalyzerVariables](../-trade-study2/clear-analyzer-variables.md) | public [clearAnalyzerVariables](../-trade-study2/clear-analyzer-variables.md)()
Remove all analyzer variables. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromString](../-trade-study2/from-string.md) | public [fromString](../-trade-study2/from-string.md)(setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Called to restore the state of a plug-in | +| [getJobManager](get-job-manager.md) | public [getJobManager](get-job-manager.md)(): [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md) | +| [getSaveAllAnalyzerVariables](../-trade-study2/get-save-all-analyzer-variables.md) | public [getSaveAllAnalyzerVariables](../-trade-study2/get-save-all-analyzer-variables.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether all analyzer variables are saved in the data history when the trade study is run. | +| [getTradeStudyCallback](../-trade-study2/get-trade-study-callback.md) | public [getTradeStudyCallback](../-trade-study2/get-trade-study-callback.md)(): [ITradeStudyCallback](../-i-trade-study-callback/index.md)
Gets the trade study call back object. | +| [onEnd](../-trade-study2/on-end.md) | public [onEnd](../-trade-study2/on-end.md)()
Called when the plug-in is about to be deleted. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setJobManager](set-job-manager.md) | public [setJobManager](set-job-manager.md)(jobManager: [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md)) | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [setSaveAllAnalyzerVariables](../-trade-study2/set-save-all-analyzer-variables.md) | public [setSaveAllAnalyzerVariables](../-trade-study2/set-save-all-analyzer-variables.md)(saveAll: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Sets whether all analyzer variables are saved in the data history when the trade study is run. | +| [setTradeStudyCallback](../-trade-study2/set-trade-study-callback.md) | public [setTradeStudyCallback](../-trade-study2/set-trade-study-callback.md)(cb: [ITradeStudyCallback](../-i-trade-study-callback/index.md))
Sets the trade study call back object. | +| [show](../-trade-study2/show.md) | public [show](../-trade-study2/show.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Called to display the trade study. | +| [toString](../-trade-study2/to-string.md) | public [toString](../-trade-study2/to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Called to save the state of the plug-in. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study3/set-job-manager.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study3/set-job-manager.md index 71e80ca974..b2c5411c85 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study3/set-job-manager.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-trade-study3/set-job-manager.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[TradeStudy3](index.md)/[setJobManager](set-job-manager.md) - -# setJobManager - - -public [setJobManager](set-job-manager.md)(jobManager: [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md)) +# setJobManager + + +public [setJobManager](set-job-manager.md)(jobManager: [ITradeStudy3JobManager](../-i-trade-study3-job-manager/index.md)) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/-i-n-p-u-t.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/-i-n-p-u-t.md index 1befcd97bf..2e44bc9a7f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/-i-n-p-u-t.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/-i-n-p-u-t.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableDescription](index.md)/[INPUT](-i-n-p-u-t.md) - -# INPUT - - -val [INPUT](-i-n-p-u-t.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 0 +# INPUT + + +val [INPUT](-i-n-p-u-t.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 0 diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/-o-u-t-p-u-t.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/-o-u-t-p-u-t.md index 77179de850..312c21dfe0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/-o-u-t-p-u-t.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/-o-u-t-p-u-t.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableDescription](index.md)/[OUTPUT](-o-u-t-p-u-t.md) - -# OUTPUT - - -val [OUTPUT](-o-u-t-p-u-t.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 1 +# OUTPUT + + +val [OUTPUT](-o-u-t-p-u-t.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 1 diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-equation.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-equation.md index d410834c12..029f0e35f2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-equation.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-equation.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableDescription](index.md)/[getEquation](get-equation.md) - -# getEquation - - -public [getEquation](get-equation.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -if the variable is a custom variable, this function returns the equation used to compute the value for the variable. This equation may only be a single variable. - -#### Return - -the variable's equation - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getEquation + + +public [getEquation](get-equation.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +if the variable is a custom variable, this function returns the equation used to compute the value for the variable. This equation may only be a single variable. + +#### Return + +the variable's equation + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-full-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-full-name.md index 592cb57b4c..f46cb55bb0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-full-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-full-name.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableDescription](index.md)/[getFullName](get-full-name.md) - -# getFullName - - -public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the full name of the variable, e.g. "Model.Script.x" - -#### Return - -the variable's full name - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getFullName + + +public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the full name of the variable, e.g. "Model.Script.x" + +#### Return + +the variable's full name + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-name.md index 50640926a6..d2460f3eba 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-name.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableDescription](index.md)/[getName](get-name.md) - -# getName - - -public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the name of the variable, e.g. "x" - -#### Return - -the variable's name - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getName + + +public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the name of the variable, e.g. "x" + +#### Return + +the variable's name + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-state.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-state.md index 51f40f4b9a..d5134fbce0 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-state.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-state.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableDescription](index.md)/[getState](get-state.md) - -# getState - - -public [getState](get-state.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -gets the state of the variable, either PHXVariableDescription.INPUT or PHXVariableDescription.OUTPUT. - -#### Return - -the variable's state - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getState + + +public [getState](get-state.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +gets the state of the variable, either PHXVariableDescription.INPUT or PHXVariableDescription.OUTPUT. + +#### Return + +the variable's state + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-type.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-type.md index fb7040e9a6..1209281c5a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-type.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-type.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableDescription](index.md)/[getType](get-type.md) - -# getType - - -public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the type of the variable, e.g. "double" - -#### Return - -the variable's type - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getType + + +public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the type of the variable, e.g. "double" + +#### Return + +the variable's type + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-units.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-units.md index 968d10038a..a50c0acf0e 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-units.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-units.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableDescription](index.md)/[getUnits](get-units.md) - -# getUnits - - -public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the units of the variable, if any - -#### Return - -the variable's units - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getUnits + + +public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the units of the variable, if any + +#### Return + +the variable's units + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/index.md index 4d9eabc56b..f02c5df9d6 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/index.md @@ -1,36 +1,34 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableDescription](index.md) - -# VariableDescription - - -public class [VariableDescription](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -This is the wrapper class that handles the native COM calls to a data item from a Data Collector. The class is used by Java plug-ins to ModelCenter. - -#### Author - -Woyak, 10-01 - -## Properties - -| Name | Summary | -|---|---| -| [INPUT](-i-n-p-u-t.md) | val [INPUT](-i-n-p-u-t.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 0 | -| [OUTPUT](-o-u-t-p-u-t.md) | val [OUTPUT](-o-u-t-p-u-t.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 1 | - -## Functions - -| Name | Summary | -|---|---| -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [getEquation](get-equation.md) | public [getEquation](get-equation.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
if the variable is a custom variable, this function returns the equation used to compute the value for the variable. | -| [getFullName](get-full-name.md) | public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the full name of the variable, e.g. | -| [getName](get-name.md) | public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the variable, e.g. | -| [getState](get-state.md) | public [getState](get-state.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the state of the variable, either PHXVariableDescription.INPUT or PHXVariableDescription.OUTPUT. | -| [getType](get-type.md) | public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the type of the variable, e.g. | -| [getUnits](get-units.md) | public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the units of the variable, if any | -| [isCustom](is-custom.md) | public [isCustom](is-custom.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates if the variable is a custom variable, i.e. | -| [isNumeric](is-numeric.md) | public [isNumeric](is-numeric.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates if the variable is numeric or not | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +# VariableDescription + + +public class [VariableDescription](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +This is the wrapper class that handles the native COM calls to a data item from a Data Collector. The class is used by Java plug-ins to ModelCenter. + +#### Author + +Woyak, 10-01 + +## Properties + +| Name | Summary | +|---|---| +| [INPUT](-i-n-p-u-t.md) | val [INPUT](-i-n-p-u-t.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 0 | +| [OUTPUT](-o-u-t-p-u-t.md) | val [OUTPUT](-o-u-t-p-u-t.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 1 | + +## Functions + +| Name | Summary | +|---|---| +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [getEquation](get-equation.md) | public [getEquation](get-equation.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
if the variable is a custom variable, this function returns the equation used to compute the value for the variable. | +| [getFullName](get-full-name.md) | public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the full name of the variable, e.g. | +| [getName](get-name.md) | public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the name of the variable, e.g. | +| [getState](get-state.md) | public [getState](get-state.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the state of the variable, either PHXVariableDescription.INPUT or PHXVariableDescription.OUTPUT. | +| [getType](get-type.md) | public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the type of the variable, e.g. | +| [getUnits](get-units.md) | public [getUnits](get-units.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the units of the variable, if any | +| [isCustom](is-custom.md) | public [isCustom](is-custom.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates if the variable is a custom variable, i.e. | +| [isNumeric](is-numeric.md) | public [isNumeric](is-numeric.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
indicates if the variable is numeric or not | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/is-custom.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/is-custom.md index aa96884b72..b7b245a6f2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/is-custom.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/is-custom.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableDescription](index.md)/[isCustom](is-custom.md) - -# isCustom - - -public [isCustom](is-custom.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -indicates if the variable is a custom variable, i.e. not directly part of the Model. Custom variables are used to represent design variables for trade studies and may actually be equations of other variables. If the variable is custom, the getName() function will return the label used to identify the variable. - -#### Return - -true or false. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isCustom + + +public [isCustom](is-custom.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +indicates if the variable is a custom variable, i.e. not directly part of the Model. Custom variables are used to represent design variables for trade studies and may actually be equations of other variables. If the variable is custom, the getName() function will return the label used to identify the variable. + +#### Return + +true or false. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/is-numeric.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/is-numeric.md index 83e1a5fbad..18e92f6dc3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/is-numeric.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-description/is-numeric.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableDescription](index.md)/[isNumeric](is-numeric.md) - -# isNumeric - - -public [isNumeric](is-numeric.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -indicates if the variable is numeric or not - -#### Return - -true if the variable is a numeric type - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isNumeric + + +public [isNumeric](is-numeric.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +indicates if the variable is numeric or not + +#### Return + +true if the variable is a numeric type + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/break-link.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/break-link.md index 08027c3078..1370a23518 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/break-link.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/break-link.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableLink](index.md)/[breakLink](break-link.md) - -# breakLink - - -public [breakLink](break-link.md)() - -breaks the link - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# breakLink + + +public [breakLink](break-link.md)() + +breaks the link + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/get-l-h-s.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/get-l-h-s.md index fef9bea713..77568bf556 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/get-l-h-s.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/get-l-h-s.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableLink](index.md)/[getLHS](get-l-h-s.md) - -# getLHS - - -public [getLHS](get-l-h-s.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the left-hand side of the link equation - -#### Return - -the left-hand side of the link equation - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getLHS + + +public [getLHS](get-l-h-s.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the left-hand side of the link equation + +#### Return + +the left-hand side of the link equation + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/get-r-h-s.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/get-r-h-s.md index f8a17b3d09..1acc9459fe 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/get-r-h-s.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/get-r-h-s.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableLink](index.md)/[getRHS](get-r-h-s.md) - -# getRHS - - -public [getRHS](get-r-h-s.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -gets the right-hand side of the link equation - -#### Return - -the right-hand side of the link equation - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getRHS + + +public [getRHS](get-r-h-s.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +gets the right-hand side of the link equation + +#### Return + +the right-hand side of the link equation + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/index.md index 71bf408381..a80cd98b37 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/index.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableLink](index.md) - -# VariableLink - - -public class [VariableLink](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -This is a base class for variable types in ModelCenter - -#### Author - -Woyak, 9/2001 - -## Functions - -| Name | Summary | -|---|---| -| [breakLink](break-link.md) | public [breakLink](break-link.md)()
breaks the link | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [getLHS](get-l-h-s.md) | public [getLHS](get-l-h-s.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the left-hand side of the link equation | -| [getRHS](get-r-h-s.md) | public [getRHS](get-r-h-s.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the right-hand side of the link equation | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [resumeLink](resume-link.md) | public [resumeLink](resume-link.md)()
resumes the link | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [suspendLink](suspend-link.md) | public [suspendLink](suspend-link.md)()
suspends the link | +# VariableLink + + +public class [VariableLink](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +This is a base class for variable types in ModelCenter + +#### Author + +Woyak, 9/2001 + +## Functions + +| Name | Summary | +|---|---| +| [breakLink](break-link.md) | public [breakLink](break-link.md)()
breaks the link | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [getLHS](get-l-h-s.md) | public [getLHS](get-l-h-s.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the left-hand side of the link equation | +| [getRHS](get-r-h-s.md) | public [getRHS](get-r-h-s.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
gets the right-hand side of the link equation | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [resumeLink](resume-link.md) | public [resumeLink](resume-link.md)()
resumes the link | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [suspendLink](suspend-link.md) | public [suspendLink](suspend-link.md)()
suspends the link | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/resume-link.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/resume-link.md index cce81a0bb3..2854c2268d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/resume-link.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/resume-link.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableLink](index.md)/[resumeLink](resume-link.md) - -# resumeLink - - -public [resumeLink](resume-link.md)() - -resumes the link - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# resumeLink + + +public [resumeLink](resume-link.md)() + +resumes the link + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/suspend-link.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/suspend-link.md index aba0ce0135..c0626bb8dd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/suspend-link.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-link/suspend-link.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableLink](index.md)/[suspendLink](suspend-link.md) - -# suspendLink - - -public [suspendLink](suspend-link.md)() - -suspends the link - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# suspendLink + + +public [suspendLink](suspend-link.md)() + +suspends the link + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/get-count.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/get-count.md index f60193f199..8cb3e2ec52 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/get-count.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/get-count.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableLinks](index.md)/[getCount](get-count.md) - -# getCount - - -public [getCount](get-count.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -gets the number of links in this collection - -#### Return - -the number of links in this collection - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getCount + + +public [getCount](get-count.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +gets the number of links in this collection + +#### Return + +the number of links in this collection + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/get-item.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/get-item.md index 8ec9dc711a..d3a6b20585 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/get-item.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/get-item.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableLinks](index.md)/[getItem](get-item.md) - -# getItem - - -public [getItem](get-item.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [VariableLink](../-variable-link/index.md) - -Gets a particular element of this collection - -#### Return - -The requested variable - -#### Parameters - - - -| | | -|---|---| -| index | the array element index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getItem](get-item.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [VariableLink](../-variable-link/index.md) - -Gets a particular element of this collection - -#### Return - -The requested variable - -#### Parameters - - - -| | | -|---|---| -| name | The name of the variable to get. | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getItem + + +public [getItem](get-item.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [VariableLink](../-variable-link/index.md) + +Gets a particular element of this collection + +#### Return + +The requested variable + +#### Parameters + + + +| | | +|---|---| +| index | the array element index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getItem](get-item.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [VariableLink](../-variable-link/index.md) + +Gets a particular element of this collection + +#### Return + +The requested variable + +#### Parameters + + + +| | | +|---|---| +| name | The name of the variable to get. | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/has-next.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/has-next.md index 0bb0923d26..ac84f86249 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/has-next.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/has-next.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableLinks](index.md)/[hasNext](has-next.md) - -# hasNext - - -public [hasNext](has-next.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Returns true if next() can return another valid variable from this iterator - -#### Return - -true if more variables are available +# hasNext + + +public [hasNext](has-next.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Returns true if next() can return another valid variable from this iterator + +#### Return + +true if more variables are available diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/index.md index 44e341d8a6..de6d979403 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/index.md @@ -1,28 +1,26 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableLinks](index.md) - -# VariableLinks - - -public class [VariableLinks](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)<[E](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)> - -A collection of variables - -#### Author - -Sharp, 11/2002 - -## Functions - -| Name | Summary | -|---|---| -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [forEachRemaining](../-variables/index.md#-1223920446%2FFunctions%2F-2117262581) | public [forEachRemaining](../-variables/index.md#-1223920446%2FFunctions%2F-2117262581)(action: [Consumer](https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html)<in [E](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)>) | -| [getCount](get-count.md) | public [getCount](get-count.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the number of links in this collection | -| [getItem](get-item.md) | public [getItem](get-item.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [VariableLink](../-variable-link/index.md)
public [getItem](get-item.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [VariableLink](../-variable-link/index.md)
Gets a particular element of this collection | -| [hasNext](has-next.md) | public [hasNext](has-next.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns true if next() can return another valid variable from this iterator | -| [next](next.md) | public [next](next.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Returns the next available object from this collection. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [remove](remove.md) | public [remove](remove.md)()
Unimplemented. | -| [resetIterator](reset-iterator.md) | public [resetIterator](reset-iterator.md)()
Resets the iterator with respect to the hasNext() and next() functions. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +# VariableLinks + + +public class [VariableLinks](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)<[E](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)> + +A collection of variables + +#### Author + +Sharp, 11/2002 + +## Functions + +| Name | Summary | +|---|---| +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [forEachRemaining](../-variables/index.md#-1223920446%2FFunctions%2F-2117262581) | public [forEachRemaining](../-variables/index.md#-1223920446%2FFunctions%2F-2117262581)(action: [Consumer](https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html)<in [E](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)>) | +| [getCount](get-count.md) | public [getCount](get-count.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the number of links in this collection | +| [getItem](get-item.md) | public [getItem](get-item.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [VariableLink](../-variable-link/index.md)
public [getItem](get-item.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [VariableLink](../-variable-link/index.md)
Gets a particular element of this collection | +| [hasNext](has-next.md) | public [hasNext](has-next.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns true if next() can return another valid variable from this iterator | +| [next](next.md) | public [next](next.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Returns the next available object from this collection. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [remove](remove.md) | public [remove](remove.md)()
Unimplemented. | +| [resetIterator](reset-iterator.md) | public [resetIterator](reset-iterator.md)()
Resets the iterator with respect to the hasNext() and next() functions. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/next.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/next.md index 69487b0eff..d4f44914ec 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/next.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/next.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableLinks](index.md)/[next](next.md) - -# next - - -public [next](next.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -Returns the next available object from this collection. - -#### Return - -The next available variable. Will be a subclass of com.phoenix_int.ModelCenter.Variable - -#### Throws - -| | | -|---|---| -| [NoSuchElementException](https://docs.oracle.com/javase/8/docs/api/java/util/NoSuchElementException.html) | Thrown if there are any problems accessing the variable. | +# next + + +public [next](next.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Returns the next available object from this collection. + +#### Return + +The next available variable. Will be a subclass of com.phoenix_int.ModelCenter.Variable + +#### Throws + +| | | +|---|---| +| [NoSuchElementException](https://docs.oracle.com/javase/8/docs/api/java/util/NoSuchElementException.html) | Thrown if there are any problems accessing the variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/remove.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/remove.md index f68c476fde..44d69d9861 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/remove.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/remove.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableLinks](index.md)/[remove](remove.md) - -# remove - - -public [remove](remove.md)() - -Unimplemented. You cannot delete variables from this iterator. - -#### Throws - -| | | -|---|---| -| [UnsupportedOperationException](https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html) | This exception is always thrown | +# remove + + +public [remove](remove.md)() + +Unimplemented. You cannot delete variables from this iterator. + +#### Throws + +| | | +|---|---| +| [UnsupportedOperationException](https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html) | This exception is always thrown | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/reset-iterator.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/reset-iterator.md index 654dd917f1..3bad036c65 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/reset-iterator.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-links/reset-iterator.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableLinks](index.md)/[resetIterator](reset-iterator.md) - -# resetIterator - - -public [resetIterator](reset-iterator.md)() - -Resets the iterator with respect to the hasNext() and next() functions. +# resetIterator + + +public [resetIterator](reset-iterator.md)() + +Resets the iterator with respect to the hasNext() and next() functions. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-meta-data-provider/get-all-variable-meta-data.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-meta-data-provider/get-all-variable-meta-data.md index 3a041de9c5..65a3b36ffd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-meta-data-provider/get-all-variable-meta-data.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-meta-data-provider/get-all-variable-meta-data.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableMetaDataProvider](index.md)/[getAllVariableMetaData](get-all-variable-meta-data.md) - -# getAllVariableMetaData - - -public [getAllVariableMetaData](get-all-variable-meta-data.md)(path: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DHVariable](../-d-h-variable/index.md)> - -Get the metadata of all variables within a specified path. - -#### Return - -the variable metadatas - -#### Parameters - - - -| | | -|---|---| -| path | the path to retrieve variables for | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if the path does not exist | +# getAllVariableMetaData + + +public [getAllVariableMetaData](get-all-variable-meta-data.md)(path: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DHVariable](../-d-h-variable/index.md)> + +Get the metadata of all variables within a specified path. + +#### Return + +the variable metadatas + +#### Parameters + + + +| | | +|---|---| +| path | the path to retrieve variables for | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if the path does not exist | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-meta-data-provider/get-variable-meta-data.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-meta-data-provider/get-variable-meta-data.md index 23a7626fc2..e2b0b4a490 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-meta-data-provider/get-variable-meta-data.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-meta-data-provider/get-variable-meta-data.md @@ -1,26 +1,24 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableMetaDataProvider](index.md)/[getVariableMetaData](get-variable-meta-data.md) - -# getVariableMetaData - - -public [getVariableMetaData](get-variable-meta-data.md)(fullName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md) - -Get the metadata about a variable. - -#### Return - -the variable's metadata - -#### Parameters - - - -| | | -|---|---| -| fullName | the full name (path) of the variable | - -#### Throws - -| | | -|---|---| -| [ModelCenterException](../-model-center-exception/index.md) | if not found | +# getVariableMetaData + + +public [getVariableMetaData](get-variable-meta-data.md)(fullName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md) + +Get the metadata about a variable. + +#### Return + +the variable's metadata + +#### Parameters + + + +| | | +|---|---| +| fullName | the full name (path) of the variable | + +#### Throws + +| | | +|---|---| +| [ModelCenterException](../-model-center-exception/index.md) | if not found | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-meta-data-provider/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-meta-data-provider/index.md index a6c57ae131..9270f11896 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-meta-data-provider/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable-meta-data-provider/index.md @@ -1,23 +1,21 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[VariableMetaDataProvider](index.md) - -# VariableMetaDataProvider - - -public class [VariableMetaDataProvider](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -Metadata provider for variable data. - -#### Author - -Dave - -## Functions - -| Name | Summary | -|---|---| -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [getAllVariableMetaData](get-all-variable-meta-data.md) | public [getAllVariableMetaData](get-all-variable-meta-data.md)(path: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DHVariable](../-d-h-variable/index.md)>
Get the metadata of all variables within a specified path. | -| [getVariableMetaData](get-variable-meta-data.md) | public [getVariableMetaData](get-variable-meta-data.md)(fullName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md)
Get the metadata about a variable. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +# VariableMetaDataProvider + + +public class [VariableMetaDataProvider](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +Metadata provider for variable data. + +#### Author + +Dave + +## Functions + +| Name | Summary | +|---|---| +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [getAllVariableMetaData](get-all-variable-meta-data.md) | public [getAllVariableMetaData](get-all-variable-meta-data.md)(path: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[DHVariable](../-d-h-variable/index.md)>
Get the metadata of all variables within a specified path. | +| [getVariableMetaData](get-variable-meta-data.md) | public [getVariableMetaData](get-variable-meta-data.md)(fullName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](../-d-h-variable/index.md)
Get the metadata about a variable. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/-private/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/-private/index.md index d7135a297e..ff3f1ec654 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/-private/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/-private/index.md @@ -1,6 +1,4 @@ -//[mc_api](../../../../../index.md)/[com.phoenix_int.ModelCenter](../../../index.md)/[Variable](../../index.md)/[MetadataAccess](../index.md)/[Private](index.md) - -# Private - - -[Private](index.md) +# Private + + +[Private](index.md) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/-public/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/-public/index.md index 828508aa30..ff30e45593 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/-public/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/-public/index.md @@ -1,6 +1,4 @@ -//[mc_api](../../../../../index.md)/[com.phoenix_int.ModelCenter](../../../index.md)/[Variable](../../index.md)/[MetadataAccess](../index.md)/[Public](index.md) - -# Public - - -[Public](index.md) +# Public + + +[Public](index.md) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/-read-only/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/-read-only/index.md index 276285f266..8db4cfc55b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/-read-only/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/-read-only/index.md @@ -1,6 +1,4 @@ -//[mc_api](../../../../../index.md)/[com.phoenix_int.ModelCenter](../../../index.md)/[Variable](../../index.md)/[MetadataAccess](../index.md)/[ReadOnly](index.md) - -# ReadOnly - - -[ReadOnly](index.md) +# ReadOnly + + +[ReadOnly](index.md) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/index.md index dd6ee11c82..043afbb701 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/index.md @@ -1,29 +1,27 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[Variable](../index.md)/[MetadataAccess](index.md) - -# MetadataAccess - - -enum [MetadataAccess](index.md) - -Supported access levels. - -## Entries - -| | | -|---|---| -| [Private](-private/index.md) | [Private](-private/index.md) | -| [ReadOnly](-read-only/index.md) | [ReadOnly](-read-only/index.md) | -| [Public](-public/index.md) | [Public](-public/index.md) | - -## Properties - -| Name | Summary | -|---|---| -| [value](value.md) | val [value](value.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | - -## Functions - -| Name | Summary | -|---|---| -| [valueOf](value-of.md) | public [valueOf](value-of.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable.MetadataAccess](index.md)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) | -| [values](values.md) | public [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Variable.MetadataAccess](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants. | +# MetadataAccess + + +enum [MetadataAccess](index.md) + +Supported access levels. + +## Entries + +| | | +|---|---| +| [Private](-private/index.md) | [Private](-private/index.md) | +| [ReadOnly](-read-only/index.md) | [ReadOnly](-read-only/index.md) | +| [Public](-public/index.md) | [Public](-public/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [value](value.md) | val [value](value.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +## Functions + +| Name | Summary | +|---|---| +| [valueOf](value-of.md) | public [valueOf](value-of.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable.MetadataAccess](index.md)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) | +| [values](values.md) | public [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Variable.MetadataAccess](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/value-of.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/value-of.md index 0b5254601c..ebcf4783bf 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/value-of.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/value-of.md @@ -1,18 +1,16 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[Variable](../index.md)/[MetadataAccess](index.md)/[valueOf](value-of.md) - -# valueOf - - -public [valueOf](value-of.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable.MetadataAccess](index.md) - -Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) - -#### Return - -the enum constant with the specified name - -#### Throws - -| | | -|---|---| -| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if this enum type has no constant with the specified name | +# valueOf + + +public [valueOf](value-of.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable.MetadataAccess](index.md) + +Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) + +#### Return + +the enum constant with the specified name + +#### Throws + +| | | +|---|---| +| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if this enum type has no constant with the specified name | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/value.md index 78e4727988..322b1ffe25 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/value.md @@ -1,6 +1,4 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[Variable](../index.md)/[MetadataAccess](index.md)/[value](value.md) - -# value - - -val [value](value.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) +# value + + +val [value](value.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/values.md index 7bd56726b7..1024cd37a2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/values.md @@ -1,12 +1,10 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[Variable](../index.md)/[MetadataAccess](index.md)/[values](values.md) - -# values - - -public [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Variable.MetadataAccess](index.md)> - -Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants. - -#### Return - -an array containing the constants of this enum type, in the order they're declared +# values + + +public [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Variable.MetadataAccess](index.md)> + +Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants. + +#### Return + +an array containing the constants of this enum type, in the order they're declared diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-boolean/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-boolean/index.md index 419dc58dc0..9fe7f0cc66 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-boolean/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-boolean/index.md @@ -1,6 +1,4 @@ -//[mc_api](../../../../../index.md)/[com.phoenix_int.ModelCenter](../../../index.md)/[Variable](../../index.md)/[MetadataType](../index.md)/[Boolean](index.md) - -# Boolean - - -[Boolean](index.md) +# Boolean + + +[Boolean](index.md) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-double/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-double/index.md index a6ebf49a0b..9bd984b529 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-double/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-double/index.md @@ -1,6 +1,4 @@ -//[mc_api](../../../../../index.md)/[com.phoenix_int.ModelCenter](../../../index.md)/[Variable](../../index.md)/[MetadataType](../index.md)/[Double](index.md) - -# Double - - -[Double](index.md) +# Double + + +[Double](index.md) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-long/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-long/index.md index d8e282b30b..1c6dc55337 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-long/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-long/index.md @@ -1,6 +1,4 @@ -//[mc_api](../../../../../index.md)/[com.phoenix_int.ModelCenter](../../../index.md)/[Variable](../../index.md)/[MetadataType](../index.md)/[Long](index.md) - -# Long - - -[Long](index.md) +# Long + + +[Long](index.md) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-string/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-string/index.md index 8080d00ab1..42bcc96f35 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-string/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-string/index.md @@ -1,6 +1,4 @@ -//[mc_api](../../../../../index.md)/[com.phoenix_int.ModelCenter](../../../index.md)/[Variable](../../index.md)/[MetadataType](../index.md)/[String](index.md) - -# String - - -[String](index.md) +# String + + +[String](index.md) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-xml/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-xml/index.md index 717209d4b5..420fd5025d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-xml/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-xml/index.md @@ -1,6 +1,4 @@ -//[mc_api](../../../../../index.md)/[com.phoenix_int.ModelCenter](../../../index.md)/[Variable](../../index.md)/[MetadataType](../index.md)/[Xml](index.md) - -# Xml - - -[Xml](index.md) +# Xml + + +[Xml](index.md) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/index.md index c26857a647..331758c743 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/index.md @@ -1,31 +1,29 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[Variable](../index.md)/[MetadataType](index.md) - -# MetadataType - - -enum [MetadataType](index.md) - -Supported metadata types. - -## Entries - -| | | -|---|---| -| [String](-string/index.md) | [String](-string/index.md) | -| [Double](-double/index.md) | [Double](-double/index.md) | -| [Long](-long/index.md) | [Long](-long/index.md) | -| [Boolean](-boolean/index.md) | [Boolean](-boolean/index.md) | -| [Xml](-xml/index.md) | [Xml](-xml/index.md) | - -## Properties - -| Name | Summary | -|---|---| -| [value](value.md) | val [value](value.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | - -## Functions - -| Name | Summary | -|---|---| -| [valueOf](value-of.md) | public [valueOf](value-of.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable.MetadataType](index.md)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) | -| [values](values.md) | public [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Variable.MetadataType](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants. | +# MetadataType + + +enum [MetadataType](index.md) + +Supported metadata types. + +## Entries + +| | | +|---|---| +| [String](-string/index.md) | [String](-string/index.md) | +| [Double](-double/index.md) | [Double](-double/index.md) | +| [Long](-long/index.md) | [Long](-long/index.md) | +| [Boolean](-boolean/index.md) | [Boolean](-boolean/index.md) | +| [Xml](-xml/index.md) | [Xml](-xml/index.md) | + +## Properties + +| Name | Summary | +|---|---| +| [value](value.md) | val [value](value.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | + +## Functions + +| Name | Summary | +|---|---| +| [valueOf](value-of.md) | public [valueOf](value-of.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable.MetadataType](index.md)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) | +| [values](values.md) | public [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Variable.MetadataType](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/value-of.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/value-of.md index 80ad910932..cf3d7b9c77 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/value-of.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/value-of.md @@ -1,18 +1,16 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[Variable](../index.md)/[MetadataType](index.md)/[valueOf](value-of.md) - -# valueOf - - -public [valueOf](value-of.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable.MetadataType](index.md) - -Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) - -#### Return - -the enum constant with the specified name - -#### Throws - -| | | -|---|---| -| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if this enum type has no constant with the specified name | +# valueOf + + +public [valueOf](value-of.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable.MetadataType](index.md) + +Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) + +#### Return + +the enum constant with the specified name + +#### Throws + +| | | +|---|---| +| [IllegalArgumentException](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html) | if this enum type has no constant with the specified name | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/value.md index 420e9b924e..322b1ffe25 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/value.md @@ -1,6 +1,4 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[Variable](../index.md)/[MetadataType](index.md)/[value](value.md) - -# value - - -val [value](value.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) +# value + + +val [value](value.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/values.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/values.md index 53a0b0e3b2..5ee6faa582 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/values.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/values.md @@ -1,12 +1,10 @@ -//[mc_api](../../../../index.md)/[com.phoenix_int.ModelCenter](../../index.md)/[Variable](../index.md)/[MetadataType](index.md)/[values](values.md) - -# values - - -public [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Variable.MetadataType](index.md)> - -Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants. - -#### Return - -an array containing the constants of this enum type, in the order they're declared +# values + + +public [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Variable.MetadataType](index.md)> + +Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants. + +#### Return + +an array containing the constants of this enum type, in the order they're declared diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/dependent-links.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/dependent-links.md index 9d197f3418..9f59d53b6f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/dependent-links.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/dependent-links.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[dependentLinks](dependent-links.md) - -# dependentLinks - - -public [dependentLinks](dependent-links.md)(): [VariableLinks](../-variable-links/index.md) - -Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. +# dependentLinks + + +public [dependentLinks](dependent-links.md)(): [VariableLinks](../-variable-links/index.md) + +Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/from-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/from-string.md index 7f06442f87..f2c884e7af 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/from-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/from-string.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[fromString](from-string.md) - -# fromString - - -public [fromString](from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) - -Sets the value for the variable from a string. For 1D arrays, the specification is of the form '1,2,3'. For nD arrays, the specification is of the form 'bounds[2,2,2] {1,2,3,4,5,6,7,8}'. String arrays may optionally have the elements quoted in the form 'bounds[2,3] {"a", "b,c", "d", "", "e", "f"}' - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# fromString + + +public [fromString](from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)) + +Sets the value for the variable from a string. For 1D arrays, the specification is of the form '1,2,3'. For nD arrays, the specification is of the form 'bounds[2,2,2] {1,2,3,4,5,6,7,8}'. String arrays may optionally have the elements quoted in the form 'bounds[2,3] {"a", "b,c", "d", "", "e", "f"}' + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-direct-dependents.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-direct-dependents.md index 9c65bc677e..afd9ca75e4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-direct-dependents.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-direct-dependents.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[getDirectDependents](get-direct-dependents.md) - -# getDirectDependents - - -public [getDirectDependents](get-direct-dependents.md)(): [Variables](../-variables/index.md) - -public [getDirectDependents](get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md) - -Gets all the immediately linked outputs of this variable. - -#### Return - -a Variables object which contains the list of directly linked outputs. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDirectDependents + + +public [getDirectDependents](get-direct-dependents.md)(): [Variables](../-variables/index.md) + +public [getDirectDependents](get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md) + +Gets all the immediately linked outputs of this variable. + +#### Return + +a Variables object which contains the list of directly linked outputs. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-direct-precedents.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-direct-precedents.md index 6ff1c5ed61..797bb625ae 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-direct-precedents.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-direct-precedents.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[getDirectPrecedents](get-direct-precedents.md) - -# getDirectPrecedents - - -public [getDirectPrecedents](get-direct-precedents.md)(): [Variables](../-variables/index.md) - -public [getDirectPrecedents](get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md) - -Gets all the immediately linked inputs of this variable. - -#### Return - -a Variables object which contains the list of directly linked inputs. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getDirectPrecedents + + +public [getDirectPrecedents](get-direct-precedents.md)(): [Variables](../-variables/index.md) + +public [getDirectPrecedents](get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md) + +Gets all the immediately linked inputs of this variable. + +#### Return + +a Variables object which contains the list of directly linked inputs. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-full-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-full-name.md index 2317ea213c..7825604119 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-full-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-full-name.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[getFullName](get-full-name.md) - -# getFullName - - -public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the full name of the variable, e.g. "Model.Script.x" - -#### Return - -the full name of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getFullName + + +public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the full name of the variable, e.g. "Model.Script.x" + +#### Return + +the full name of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-has-changed.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-has-changed.md index 0f35ba474c..beae06290b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-has-changed.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-has-changed.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[getHasChanged](get-has-changed.md) - -# getHasChanged - - -public [getHasChanged](get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Boolean which indicates if the variable has changed since the last time the boolean was reset. Typically used only by Plug-Ins for their own variables (to avoid conflicting use by different Plug-Ins, macros, or tools). Set the value to false and it will automatically flip to true any time the value changes. - -#### Return - -whether the variable has been changed or not - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getHasChanged + + +public [getHasChanged](get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Boolean which indicates if the variable has changed since the last time the boolean was reset. Typically used only by Plug-Ins for their own variables (to avoid conflicting use by different Plug-Ins, macros, or tools). Set the value to false and it will automatically flip to true any time the value changes. + +#### Return + +whether the variable has been changed or not + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-hide.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-hide.md index 9531e0c7e5..529a6ea1b8 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-hide.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-hide.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[getHide](get-hide.md) - -# getHide - - -public [getHide](get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Gets whether the variable is hidden or not - -#### Return - -whether the variable is hidden or not - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getHide + + +public [getHide](get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Gets whether the variable is hidden or not + +#### Return + +whether the variable is hidden or not + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-metadata.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-metadata.md index 71d026299a..b6f4dcd4c3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-metadata.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-metadata.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[getMetadata](get-metadata.md) - -# getMetadata - - -public [getMetadata](get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) - -Get a metadata value. - -#### Return - -the the value, or null if the value is not set or of an unrecognized type - -#### Parameters - - - -| | | -|---|---| -| name | the metadata value's name | +# getMetadata + + +public [getMetadata](get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md) + +Get a metadata value. + +#### Return + +the the value, or null if the value is not set or of an unrecognized type + +#### Parameters + + + +| | | +|---|---| +| name | the metadata value's name | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-name.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-name.md index f80708d4ab..1db46f09cc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-name.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-name.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[getName](get-name.md) - -# getName - - -public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the name of the variable, e.g. "x" - -#### Return - -the name of the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getName + + +public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the name of the variable, e.g. "x" + +#### Return + +the name of the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-owning-component.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-owning-component.md index 1fe181a631..f80adcdb08 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-owning-component.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-owning-component.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[getOwningComponent](get-owning-component.md) - -# getOwningComponent - - -public [getOwningComponent](get-owning-component.md)(): [Component](../-component/index.md) - -Get the component which owns this variable. Will walk up the tree until it finds a component. +# getOwningComponent + + +public [getOwningComponent](get-owning-component.md)(): [Component](../-component/index.md) + +Get the component which owns this variable. Will walk up the tree until it finds a component. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-type.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-type.md index fadc6e3dac..624c6ff76d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-type.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/get-type.md @@ -1,37 +1,35 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[getType](get-type.md) - -# getType - - -public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Gets the type of the variable. Valid types include: - -- double -- long -- string -- boolean -- reference -- file -- quadFacet -- sor -- nurbs -- bspline -- ruled -- skinned -- node -- double[] -- long[] -- string[] -- boolean[] -- reference[] - -#### Return - -the variable type - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getType + + +public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Gets the type of the variable. Valid types include: + +- double +- long +- string +- boolean +- reference +- file +- quadFacet +- sor +- nurbs +- bspline +- ruled +- skinned +- node +- double[] +- long[] +- string[] +- boolean[] +- reference[] + +#### Return + +the variable type + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/index.md index 0a521033fa..f1d3898823 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/index.md @@ -1,73 +1,71 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md) - -# Variable - -public class [Variable](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) - -This is a base class for variable types in ModelCenter - -#### Author - -Woyak, 9/2001 - -#### Inheritors - -| | -|---| -| [Array](../-array/index.md) | -| [BooleanVariable](../-boolean-variable/index.md) | -| [DoubleVariable](../-double-variable/index.md) | -| [FileVariable](../-file-variable/index.md) | -| [GeometryVariable](../-geometry-variable/index.md) | -| [IntegerVariable](../-integer-variable/index.md) | -| [ObjectVariable](../-object-variable/index.md) | -| [ReferenceVariable](../-reference-variable/index.md) | -| [StringVariable](../-string-variable/index.md) | -| [Array](../-array/index.md) | -| [BooleanVariable](../-boolean-variable/index.md) | -| [DoubleVariable](../-double-variable/index.md) | -| [FileVariable](../-file-variable/index.md) | -| [GeometryVariable](../-geometry-variable/index.md) | -| [IntegerVariable](../-integer-variable/index.md) | -| [ObjectVariable](../-object-variable/index.md) | -| [ReferenceVariable](../-reference-variable/index.md) | -| [StringVariable](../-string-variable/index.md) | - -## Types - -| Name | Summary | -|---|---| -| [MetadataAccess](-metadata-access/index.md) | enum [MetadataAccess](-metadata-access/index.md)
Supported access levels. | -| [MetadataType](-metadata-type/index.md) | enum [MetadataType](-metadata-type/index.md)
Supported metadata types. | - -## Functions - -| Name | Summary | -|---|---| -| [dependentLinks](dependent-links.md) | public [dependentLinks](dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [fromString](from-string.md) | public [fromString](from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | -| [getDirectDependents](get-direct-dependents.md) | public [getDirectDependents](get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | -| [getDirectPrecedents](get-direct-precedents.md) | public [getDirectPrecedents](get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | -| [getFullName](get-full-name.md) | public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | -| [getHasChanged](get-has-changed.md) | public [getHasChanged](get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [getHide](get-hide.md) | public [getHide](get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | -| [getMetadata](get-metadata.md) | public [getMetadata](get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | -| [getName](get-name.md) | public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | -| [getOwningComponent](get-owning-component.md) | public [getOwningComponent](get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | -| [getType](get-type.md) | public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | -| [invalidate](invalidate.md) | public [invalidate](invalidate.md)()
Invalidates the variable | -| [isInput](is-input.md) | public [~~isInput~~](is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | -| [isInputToComponent](is-input-to-component.md) | public [isInputToComponent](is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | -| [isInputToModel](is-input-to-model.md) | public [isInputToModel](is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | -| [isValid](is-valid.md) | public [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | -| [precedentLinks](precedent-links.md) | public [precedentLinks](precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [setHasChanged](set-has-changed.md) | public [setHasChanged](set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | -| [setHide](set-hide.md) | public [setHide](set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | -| [setMetadata](set-metadata.md) | public [setMetadata](set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | -| [toString](to-string.md) | public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [toStringAbsolute](to-string-absolute.md) | public [toStringAbsolute](to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | -| [validate](validate.md) | public [validate](validate.md)()
Causes the scheduler to get a valid value for this variable. | +# Variable + +public class [Variable](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) + +This is a base class for variable types in ModelCenter + +#### Author + +Woyak, 9/2001 + +#### Inheritors + +| | +|---| +| [Array](../-array/index.md) | +| [BooleanVariable](../-boolean-variable/index.md) | +| [DoubleVariable](../-double-variable/index.md) | +| [FileVariable](../-file-variable/index.md) | +| [GeometryVariable](../-geometry-variable/index.md) | +| [IntegerVariable](../-integer-variable/index.md) | +| [ObjectVariable](../-object-variable/index.md) | +| [ReferenceVariable](../-reference-variable/index.md) | +| [StringVariable](../-string-variable/index.md) | +| [Array](../-array/index.md) | +| [BooleanVariable](../-boolean-variable/index.md) | +| [DoubleVariable](../-double-variable/index.md) | +| [FileVariable](../-file-variable/index.md) | +| [GeometryVariable](../-geometry-variable/index.md) | +| [IntegerVariable](../-integer-variable/index.md) | +| [ObjectVariable](../-object-variable/index.md) | +| [ReferenceVariable](../-reference-variable/index.md) | +| [StringVariable](../-string-variable/index.md) | + +## Types + +| Name | Summary | +|---|---| +| [MetadataAccess](-metadata-access/index.md) | enum [MetadataAccess](-metadata-access/index.md)
Supported access levels. | +| [MetadataType](-metadata-type/index.md) | enum [MetadataType](-metadata-type/index.md)
Supported metadata types. | + +## Functions + +| Name | Summary | +|---|---| +| [dependentLinks](dependent-links.md) | public [dependentLinks](dependent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that immediately depend on the value of this variable. | +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [fromString](from-string.md) | public [fromString](from-string.md)(str: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))
Sets the value for the variable from a string. | +| [getDirectDependents](get-direct-dependents.md) | public [getDirectDependents](get-direct-dependents.md)(): [Variables](../-variables/index.md)
public [getDirectDependents](get-direct-dependents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked outputs of this variable. | +| [getDirectPrecedents](get-direct-precedents.md) | public [getDirectPrecedents](get-direct-precedents.md)(): [Variables](../-variables/index.md)
public [getDirectPrecedents](get-direct-precedents.md)(followSuspended: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Variables](../-variables/index.md)
Gets all the immediately linked inputs of this variable. | +| [getFullName](get-full-name.md) | public [getFullName](get-full-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the full name of the variable, e.g. | +| [getHasChanged](get-has-changed.md) | public [getHasChanged](get-has-changed.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [getHide](get-hide.md) | public [getHide](get-hide.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Gets whether the variable is hidden or not | +| [getMetadata](get-metadata.md) | public [getMetadata](get-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](../-variant/index.md)
Get a metadata value. | +| [getName](get-name.md) | public [getName](get-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the name of the variable, e.g. | +| [getOwningComponent](get-owning-component.md) | public [getOwningComponent](get-owning-component.md)(): [Component](../-component/index.md)
Get the component which owns this variable. | +| [getType](get-type.md) | public [getType](get-type.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Gets the type of the variable. | +| [invalidate](invalidate.md) | public [invalidate](invalidate.md)()
Invalidates the variable | +| [isInput](is-input.md) | public [~~isInput~~](is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is an input or output | +| [isInputToComponent](is-input-to-component.md) | public [isInputToComponent](is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to a component | +| [isInputToModel](is-input-to-model.md) | public [isInputToModel](is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether a variable is an input to the Model | +| [isValid](is-valid.md) | public [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Indicates whether the variable is currently valid or not | +| [precedentLinks](precedent-links.md) | public [precedentLinks](precedent-links.md)(): [VariableLinks](../-variable-links/index.md)
Returns a list of links that are immediate precedents to the value of this variable. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [setHasChanged](set-has-changed.md) | public [setHasChanged](set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Boolean which indicates if the variable has changed since the last time the boolean was reset. | +| [setHide](set-hide.md) | public [setHide](set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set whether the variable is hidden or not | +| [setMetadata](set-metadata.md) | public [setMetadata](set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Set a metadata value on a variable. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +| [toString](to-string.md) | public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [toStringAbsolute](to-string-absolute.md) | public [toStringAbsolute](to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)
Converts the variable value to a string representation. | +| [validate](validate.md) | public [validate](validate.md)()
Causes the scheduler to get a valid value for this variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/invalidate.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/invalidate.md index f3e552d653..12bd543528 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/invalidate.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/invalidate.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[invalidate](invalidate.md) - -# invalidate - - -public [invalidate](invalidate.md)() - -Invalidates the variable - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# invalidate + + +public [invalidate](invalidate.md)() + +Invalidates the variable + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/is-input-to-component.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/is-input-to-component.md index aaa7bdae2b..4f3a5b851b 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/is-input-to-component.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/is-input-to-component.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[isInputToComponent](is-input-to-component.md) - -# isInputToComponent - - -public [isInputToComponent](is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Indicates whether a variable is an input to a component - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isInputToComponent + + +public [isInputToComponent](is-input-to-component.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Indicates whether a variable is an input to a component + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/is-input-to-model.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/is-input-to-model.md index 16ef5b7093..9e09582cc1 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/is-input-to-model.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/is-input-to-model.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[isInputToModel](is-input-to-model.md) - -# isInputToModel - - -public [isInputToModel](is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Indicates whether a variable is an input to the Model - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isInputToModel + + +public [isInputToModel](is-input-to-model.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Indicates whether a variable is an input to the Model + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/is-input.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/is-input.md index c513e6a0d7..1e9eece7eb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/is-input.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/is-input.md @@ -1,28 +1,26 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[isInput](is-input.md) - -# isInput - - -public [~~isInput~~](is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - ---- - -### Deprecated - ---- - -Indicates whether the variable is an input or output - -#### Return - -true or false - -#### Deprecated - -in favor of [isInputToModel](is-input-to-model.md) - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isInput + + +public [~~isInput~~](is-input.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +--- + +### Deprecated + +--- + +Indicates whether the variable is an input or output + +#### Return + +true or false + +#### Deprecated + +in favor of [isInputToModel](is-input-to-model.md) + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/is-valid.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/is-valid.md index 2656df43a9..251fc257e4 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/is-valid.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/is-valid.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[isValid](is-valid.md) - -# isValid - - -public [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Indicates whether the variable is currently valid or not - -#### Return - -true or false - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# isValid + + +public [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Indicates whether the variable is currently valid or not + +#### Return + +true or false + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/precedent-links.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/precedent-links.md index 2d4de6470f..d9cc275b94 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/precedent-links.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/precedent-links.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[precedentLinks](precedent-links.md) - -# precedentLinks - - -public [precedentLinks](precedent-links.md)(): [VariableLinks](../-variable-links/index.md) - -Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. +# precedentLinks + + +public [precedentLinks](precedent-links.md)(): [VariableLinks](../-variable-links/index.md) + +Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/set-has-changed.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/set-has-changed.md index 37e8e6a103..2f73e2aa1d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/set-has-changed.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/set-has-changed.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[setHasChanged](set-has-changed.md) - -# setHasChanged - - -public [setHasChanged](set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Boolean which indicates if the variable has changed since the last time the boolean was reset. Typically used only by Plug-Ins for their own variables (to avoid conflicting use by different Plug-Ins, macros, or tools). Set the value to false and it will automatically flip to true any time the value changes. - -#### Parameters - - - -| | | -|---|---| -| flag | has the variable changed | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setHasChanged + + +public [setHasChanged](set-has-changed.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Boolean which indicates if the variable has changed since the last time the boolean was reset. Typically used only by Plug-Ins for their own variables (to avoid conflicting use by different Plug-Ins, macros, or tools). Set the value to false and it will automatically flip to true any time the value changes. + +#### Parameters + + + +| | | +|---|---| +| flag | has the variable changed | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/set-hide.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/set-hide.md index 7eb020f984..4200ca0597 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/set-hide.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/set-hide.md @@ -1,22 +1,20 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[setHide](set-hide.md) - -# setHide - - -public [setHide](set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Set whether the variable is hidden or not - -#### Parameters - - - -| | | -|---|---| -| flag | has the variable changed | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# setHide + + +public [setHide](set-hide.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Set whether the variable is hidden or not + +#### Parameters + + + +| | | +|---|---| +| flag | has the variable changed | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/set-metadata.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/set-metadata.md index 31a2a7e565..8defbb7a85 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/set-metadata.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/set-metadata.md @@ -1,20 +1,18 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[setMetadata](set-metadata.md) - -# setMetadata - - -public [setMetadata](set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) - -Set a metadata value on a variable. - -#### Parameters - - - -| | | -|---|---| -| name | the metadata value's name | -| type | the type of metadata | -| value | the string representation of the value to set | -| access | the access (private, readonly, public) | -| archive | whether to save the data with the model | +# setMetadata + + +public [setMetadata](set-metadata.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [Variable.MetadataType](-metadata-type/index.md), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), access: [Variable.MetadataAccess](-metadata-access/index.md), archive: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) + +Set a metadata value on a variable. + +#### Parameters + + + +| | | +|---|---| +| name | the metadata value's name | +| type | the type of metadata | +| value | the string representation of the value to set | +| access | the access (private, readonly, public) | +| archive | whether to save the data with the model | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/to-string-absolute.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/to-string-absolute.md index 16d353dc3f..538e311536 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/to-string-absolute.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/to-string-absolute.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[toStringAbsolute](to-string-absolute.md) - -# toStringAbsolute - - -public [toStringAbsolute](to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Converts the variable value to a string representation. If the variable is not currently valid, it is NOT validated. - -#### Return - -the string value of the variable. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# toStringAbsolute + + +public [toStringAbsolute](to-string-absolute.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Converts the variable value to a string representation. If the variable is not currently valid, it is NOT validated. + +#### Return + +the string value of the variable. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/to-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/to-string.md index e9e0fc2880..567df2af0a 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/to-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/to-string.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[toString](to-string.md) - -# toString - - -public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) - -Converts the variable value to a string representation. If the variable is not currently valid, it is first validated. - -#### Return - -the string value of the variable. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. - -#### Throws - -| | | -|---|---| -| [RuntimeException](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html) | thrown if an error occurs while trying to validate or retrieve the value of the variable. Note that this is a run time exception because Object.toString() cannot be overridden to throw an exception. | +# toString + + +public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) + +Converts the variable value to a string representation. If the variable is not currently valid, it is first validated. + +#### Return + +the string value of the variable. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays. + +#### Throws + +| | | +|---|---| +| [RuntimeException](https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html) | thrown if an error occurs while trying to validate or retrieve the value of the variable. Note that this is a run time exception because Object.toString() cannot be overridden to throw an exception. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/validate.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/validate.md index 78e4d4f16d..a5671d1989 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/validate.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variable/validate.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variable](index.md)/[validate](validate.md) - -# validate - - -public [validate](validate.md)() - -Causes the scheduler to get a valid value for this variable. This may involve running one or more components. - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# validate + + +public [validate](validate.md)() + +Causes the scheduler to get a valid value for this variable. This may involve running one or more components. + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/get-count.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/get-count.md index 9ce82b51ef..8626888e81 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/get-count.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/get-count.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variables](index.md)/[getCount](get-count.md) - -# getCount - - -public [getCount](get-count.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) - -gets the number of variables in this collection - -#### Return - -the number of variables in this collection - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getCount + + +public [getCount](get-count.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) + +gets the number of variables in this collection + +#### Return + +the number of variables in this collection + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/get-item.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/get-item.md index 52f751b5ef..50cdd487cd 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/get-item.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/get-item.md @@ -1,49 +1,47 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variables](index.md)/[getItem](get-item.md) - -# getItem - - -public [getItem](get-item.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md) - -Gets a particular element of this collection - -#### Return - -The requested variable - -#### Parameters - - - -| | | -|---|---| -| index | the array element index | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | - - -public [getItem](get-item.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) - -Gets a particular element of this collection - -#### Return - -The requested variable - -#### Parameters - - - -| | | -|---|---| -| name | The name of the variable to get. | - -#### Throws - -| | -|---| -| [ModelCenterException](../-model-center-exception/index.md) | +# getItem + + +public [getItem](get-item.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md) + +Gets a particular element of this collection + +#### Return + +The requested variable + +#### Parameters + + + +| | | +|---|---| +| index | the array element index | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | + + +public [getItem](get-item.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md) + +Gets a particular element of this collection + +#### Return + +The requested variable + +#### Parameters + + + +| | | +|---|---| +| name | The name of the variable to get. | + +#### Throws + +| | +|---| +| [ModelCenterException](../-model-center-exception/index.md) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/has-next.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/has-next.md index fc2a3e494c..ac84f86249 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/has-next.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/has-next.md @@ -1,12 +1,10 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variables](index.md)/[hasNext](has-next.md) - -# hasNext - - -public [hasNext](has-next.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) - -Returns true if next() can return another valid variable from this iterator - -#### Return - -true if more variables are available +# hasNext + + +public [hasNext](has-next.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) + +Returns true if next() can return another valid variable from this iterator + +#### Return + +true if more variables are available diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/index.md index 6ddd6d9104..3682589457 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/index.md @@ -1,28 +1,26 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variables](index.md) - -# Variables - - -public class [Variables](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)<[E](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)> - -A collection of variables - -#### Author - -Sharp, 11/2002 - -## Functions - -| Name | Summary | -|---|---| -| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | -| [forEachRemaining](index.md#-1223920446%2FFunctions%2F-2117262581) | public [forEachRemaining](index.md#-1223920446%2FFunctions%2F-2117262581)(action: [Consumer](https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html)<in [E](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)>) | -| [getCount](get-count.md) | public [getCount](get-count.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the number of variables in this collection | -| [getItem](get-item.md) | public [getItem](get-item.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
public [getItem](get-item.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
Gets a particular element of this collection | -| [hasNext](has-next.md) | public [hasNext](has-next.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns true if next() can return another valid variable from this iterator | -| [next](next.md) | public [next](next.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Returns the next available object from this collection. | -| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | -| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | -| [remove](remove.md) | public [remove](remove.md)()
Unimplemented. | -| [resetIterator](reset-iterator.md) | public [resetIterator](reset-iterator.md)()
Resets the iterator with respect to the hasNext() and next() functions. | -| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | +# Variables + + +public class [Variables](index.md) : [PHXCOMObject](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)<[E](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)> + +A collection of variables + +#### Author + +Sharp, 11/2002 + +## Functions + +| Name | Summary | +|---|---| +| [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md) | public [disableGC](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
If true, prevents releaseObjects from doing anything. | +| [forEachRemaining](index.md#-1223920446%2FFunctions%2F-2117262581) | public [forEachRemaining](index.md#-1223920446%2FFunctions%2F-2117262581)(action: [Consumer](https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html)<in [E](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)>) | +| [getCount](get-count.md) | public [getCount](get-count.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
gets the number of variables in this collection | +| [getItem](get-item.md) | public [getItem](get-item.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Variable](../-variable/index.md)
public [getItem](get-item.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](../-variable/index.md)
Gets a particular element of this collection | +| [hasNext](has-next.md) | public [hasNext](has-next.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Returns true if next() can return another valid variable from this iterator | +| [next](next.md) | public [next](next.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)
Returns the next available object from this collection. | +| [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md) | public [release](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()
Releases the COM reference to ModelCenter for this object. | +| [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md) | public [releaseObjects](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them. | +| [remove](remove.md) | public [remove](remove.md)()
Unimplemented. | +| [resetIterator](reset-iterator.md) | public [resetIterator](reset-iterator.md)()
Resets the iterator with respect to the hasNext() and next() functions. | +| [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md) | public [setReferenceDebugMode](../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/next.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/next.md index c8bb0c5e06..d4f44914ec 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/next.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/next.md @@ -1,18 +1,16 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variables](index.md)/[next](next.md) - -# next - - -public [next](next.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) - -Returns the next available object from this collection. - -#### Return - -The next available variable. Will be a subclass of com.phoenix_int.ModelCenter.Variable - -#### Throws - -| | | -|---|---| -| [NoSuchElementException](https://docs.oracle.com/javase/8/docs/api/java/util/NoSuchElementException.html) | Thrown if there are any problems accessing the variable. | +# next + + +public [next](next.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) + +Returns the next available object from this collection. + +#### Return + +The next available variable. Will be a subclass of com.phoenix_int.ModelCenter.Variable + +#### Throws + +| | | +|---|---| +| [NoSuchElementException](https://docs.oracle.com/javase/8/docs/api/java/util/NoSuchElementException.html) | Thrown if there are any problems accessing the variable. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/remove.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/remove.md index 2b53954109..44d69d9861 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/remove.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/remove.md @@ -1,14 +1,12 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variables](index.md)/[remove](remove.md) - -# remove - - -public [remove](remove.md)() - -Unimplemented. You cannot delete variables from this iterator. - -#### Throws - -| | | -|---|---| -| [UnsupportedOperationException](https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html) | This exception is always thrown | +# remove + + +public [remove](remove.md)() + +Unimplemented. You cannot delete variables from this iterator. + +#### Throws + +| | | +|---|---| +| [UnsupportedOperationException](https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html) | This exception is always thrown | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/reset-iterator.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/reset-iterator.md index f4b9712dfd..3bad036c65 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/reset-iterator.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variables/reset-iterator.md @@ -1,8 +1,6 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variables](index.md)/[resetIterator](reset-iterator.md) - -# resetIterator - - -public [resetIterator](reset-iterator.md)() - -Resets the iterator with respect to the hasNext() and next() functions. +# resetIterator + + +public [resetIterator](reset-iterator.md)() + +Resets the iterator with respect to the hasNext() and next() functions. diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-b-o-o-l-e-a-n.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-b-o-o-l-e-a-n.md index b1a7ac1b9e..db62a61172 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-b-o-o-l-e-a-n.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-b-o-o-l-e-a-n.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[BOOLEAN](-b-o-o-l-e-a-n.md) - -# BOOLEAN - - -val [BOOLEAN](-b-o-o-l-e-a-n.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 5 +# BOOLEAN + + +val [BOOLEAN](-b-o-o-l-e-a-n.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 5 diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-b-o-o-l-e-a-n_-a-r-r-a-y.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-b-o-o-l-e-a-n_-a-r-r-a-y.md index 4a54b34105..7c4aa43d0d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-b-o-o-l-e-a-n_-a-r-r-a-y.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-b-o-o-l-e-a-n_-a-r-r-a-y.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[BOOLEAN_ARRAY](-b-o-o-l-e-a-n_-a-r-r-a-y.md) - -# BOOLEAN_ARRAY - - -val [BOOLEAN_ARRAY](-b-o-o-l-e-a-n_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 11 +# BOOLEAN_ARRAY + + +val [BOOLEAN_ARRAY](-b-o-o-l-e-a-n_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 11 diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-d-i-s-p-a-t-c-h.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-d-i-s-p-a-t-c-h.md index 76f2f93436..6c3b5837c3 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-d-i-s-p-a-t-c-h.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-d-i-s-p-a-t-c-h.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[DISPATCH](-d-i-s-p-a-t-c-h.md) - -# DISPATCH - - -val [DISPATCH](-d-i-s-p-a-t-c-h.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 13 +# DISPATCH + + +val [DISPATCH](-d-i-s-p-a-t-c-h.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 13 diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-d-o-u-b-l-e.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-d-o-u-b-l-e.md index 31ee554592..cb7038a55f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-d-o-u-b-l-e.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-d-o-u-b-l-e.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[DOUBLE](-d-o-u-b-l-e.md) - -# DOUBLE - - -val [DOUBLE](-d-o-u-b-l-e.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 1 +# DOUBLE + + +val [DOUBLE](-d-o-u-b-l-e.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 1 diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-d-o-u-b-l-e_-a-r-r-a-y.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-d-o-u-b-l-e_-a-r-r-a-y.md index dbf483548d..321b490536 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-d-o-u-b-l-e_-a-r-r-a-y.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-d-o-u-b-l-e_-a-r-r-a-y.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[DOUBLE_ARRAY](-d-o-u-b-l-e_-a-r-r-a-y.md) - -# DOUBLE_ARRAY - - -val [DOUBLE_ARRAY](-d-o-u-b-l-e_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 7 +# DOUBLE_ARRAY + + +val [DOUBLE_ARRAY](-d-o-u-b-l-e_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 7 diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-i-n-t.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-i-n-t.md index 00c4d2c059..adcc92d451 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-i-n-t.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-i-n-t.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[INT](-i-n-t.md) - -# INT - - -val [INT](-i-n-t.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 2 +# INT + + +val [INT](-i-n-t.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 2 diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-i-n-t_-a-r-r-a-y.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-i-n-t_-a-r-r-a-y.md index 4c9ebef702..2e954559dc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-i-n-t_-a-r-r-a-y.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-i-n-t_-a-r-r-a-y.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[INT_ARRAY](-i-n-t_-a-r-r-a-y.md) - -# INT_ARRAY - - -val [INT_ARRAY](-i-n-t_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 8 +# INT_ARRAY + + +val [INT_ARRAY](-i-n-t_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 8 diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-l-o-n-g.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-l-o-n-g.md index ef76b2d4ed..c2212f239c 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-l-o-n-g.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-l-o-n-g.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[LONG](-l-o-n-g.md) - -# LONG - - -val [LONG](-l-o-n-g.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 3 +# LONG + + +val [LONG](-l-o-n-g.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 3 diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-l-o-n-g_-a-r-r-a-y.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-l-o-n-g_-a-r-r-a-y.md index 676b141fb7..a2ebfce503 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-l-o-n-g_-a-r-r-a-y.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-l-o-n-g_-a-r-r-a-y.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[LONG_ARRAY](-l-o-n-g_-a-r-r-a-y.md) - -# LONG_ARRAY - - -val [LONG_ARRAY](-l-o-n-g_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 9 +# LONG_ARRAY + + +val [LONG_ARRAY](-l-o-n-g_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 9 diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-r-e-f-e-r-e-n-c-e.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-r-e-f-e-r-e-n-c-e.md index 49fd859afa..4d535e53ff 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-r-e-f-e-r-e-n-c-e.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-r-e-f-e-r-e-n-c-e.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[REFERENCE](-r-e-f-e-r-e-n-c-e.md) - -# REFERENCE - - -val [REFERENCE](-r-e-f-e-r-e-n-c-e.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 6 +# REFERENCE + + +val [REFERENCE](-r-e-f-e-r-e-n-c-e.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 6 diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-s-t-r-i-n-g.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-s-t-r-i-n-g.md index 856133f588..85dfe6a520 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-s-t-r-i-n-g.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-s-t-r-i-n-g.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[STRING](-s-t-r-i-n-g.md) - -# STRING - - -val [STRING](-s-t-r-i-n-g.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 4 +# STRING + + +val [STRING](-s-t-r-i-n-g.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 4 diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-s-t-r-i-n-g_-a-r-r-a-y.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-s-t-r-i-n-g_-a-r-r-a-y.md index 328d228ac9..b62c254d1f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-s-t-r-i-n-g_-a-r-r-a-y.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-s-t-r-i-n-g_-a-r-r-a-y.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[STRING_ARRAY](-s-t-r-i-n-g_-a-r-r-a-y.md) - -# STRING_ARRAY - - -val [STRING_ARRAY](-s-t-r-i-n-g_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 10 +# STRING_ARRAY + + +val [STRING_ARRAY](-s-t-r-i-n-g_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 10 diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-u-n-k-n-o-w-n.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-u-n-k-n-o-w-n.md index 106fe33700..972140c576 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-u-n-k-n-o-w-n.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-u-n-k-n-o-w-n.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[UNKNOWN](-u-n-k-n-o-w-n.md) - -# UNKNOWN - - -val [UNKNOWN](-u-n-k-n-o-w-n.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 0 +# UNKNOWN + + +val [UNKNOWN](-u-n-k-n-o-w-n.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 0 diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-variant.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-variant.md index 5752b373cb..af1071e788 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-variant.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/-variant.md @@ -1,17 +1,15 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[Variant](-variant.md) - -# Variant - - -constructor(type: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)) - -******************************************* Constructor - -#### Parameters - - - -| | | -|---|---| -| type | - An integer representing the (ModelCenter)type of this variable. Should be one of the following:
- DOUBLE - INT - STRING - BOOLEAN - REFERENCE - DOUBLE_ARRAY - INT_ARRAY - LONG_ARRAY - STRING_ARRAY - BOOLEAN_ARRAY - REFERENCE_ARRAY | -| value | - An Object containing the value of the appropriate type. | +# Variant + + +constructor(type: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)) + +******************************************* Constructor + +#### Parameters + + + +| | | +|---|---| +| type | - An integer representing the (ModelCenter)type of this variable. Should be one of the following:
- DOUBLE - INT - STRING - BOOLEAN - REFERENCE - DOUBLE_ARRAY - INT_ARRAY - LONG_ARRAY - STRING_ARRAY - BOOLEAN_ARRAY - REFERENCE_ARRAY | +| value | - An Object containing the value of the appropriate type. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/boolean-array-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/boolean-array-value.md index c74910836b..701c71f4f2 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/boolean-array-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/boolean-array-value.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[booleanArrayValue](boolean-array-value.md) - -# booleanArrayValue - - -public [booleanArrayValue](boolean-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)> +# booleanArrayValue + + +public [booleanArrayValue](boolean-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)> diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/boolean-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/boolean-value.md index 63319a2534..b68eece38d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/boolean-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/boolean-value.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[booleanValue](boolean-value.md) - -# booleanValue - - -public [booleanValue](boolean-value.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) +# booleanValue + + +public [booleanValue](boolean-value.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/double-array-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/double-array-value.md index 9db49e010e..483525cc79 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/double-array-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/double-array-value.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[doubleArrayValue](double-array-value.md) - -# doubleArrayValue - - -public [doubleArrayValue](double-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)> +# doubleArrayValue + + +public [doubleArrayValue](double-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)> diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/double-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/double-value.md index e031621868..ff9a6c2ad7 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/double-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/double-value.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[doubleValue](double-value.md) - -# doubleValue - - -public [doubleValue](double-value.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) +# doubleValue + + +public [doubleValue](double-value.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/get-type.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/get-type.md index dc3b9c0d14..315562ac83 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/get-type.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/get-type.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[getType](get-type.md) - -# getType - - -public [getType](get-type.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) +# getType + + +public [getType](get-type.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/get-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/get-value.md index 34f998eb28..dbeac8b2ae 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/get-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/get-value.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[getValue](get-value.md) - -# getValue - - -public [getValue](get-value.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) +# getValue + + +public [getValue](get-value.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/index.md index 1c9fd8f2b2..482838c1cc 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/index.md @@ -1,54 +1,52 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md) - -# Variant - - -public class [Variant](index.md) - -This is a small class used to map win32 VARIANTs received by calls to ModelCenter's COM interface. - -#### Author - -Haisma, 2/2000 - -## Constructors - -| | | -|---|---| -| [Variant](-variant.md) | constructor(type: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
******************************************* Constructor | - -## Properties - -| Name | Summary | -|---|---| -| [BOOLEAN](-b-o-o-l-e-a-n.md) | val [BOOLEAN](-b-o-o-l-e-a-n.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 5 | -| [BOOLEAN_ARRAY](-b-o-o-l-e-a-n_-a-r-r-a-y.md) | val [BOOLEAN_ARRAY](-b-o-o-l-e-a-n_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 11 | -| [DISPATCH](-d-i-s-p-a-t-c-h.md) | val [DISPATCH](-d-i-s-p-a-t-c-h.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 13 | -| [DOUBLE](-d-o-u-b-l-e.md) | val [DOUBLE](-d-o-u-b-l-e.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 1 | -| [DOUBLE_ARRAY](-d-o-u-b-l-e_-a-r-r-a-y.md) | val [DOUBLE_ARRAY](-d-o-u-b-l-e_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 7 | -| [INT](-i-n-t.md) | val [INT](-i-n-t.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 2 | -| [INT_ARRAY](-i-n-t_-a-r-r-a-y.md) | val [INT_ARRAY](-i-n-t_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 8 | -| [LONG](-l-o-n-g.md) | val [LONG](-l-o-n-g.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 3 | -| [LONG_ARRAY](-l-o-n-g_-a-r-r-a-y.md) | val [LONG_ARRAY](-l-o-n-g_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 9 | -| [REFERENCE](-r-e-f-e-r-e-n-c-e.md) | val [REFERENCE](-r-e-f-e-r-e-n-c-e.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 6 | -| [STRING](-s-t-r-i-n-g.md) | val [STRING](-s-t-r-i-n-g.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 4 | -| [STRING_ARRAY](-s-t-r-i-n-g_-a-r-r-a-y.md) | val [STRING_ARRAY](-s-t-r-i-n-g_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 10 | -| [UNKNOWN](-u-n-k-n-o-w-n.md) | val [UNKNOWN](-u-n-k-n-o-w-n.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 0 | - -## Functions - -| Name | Summary | -|---|---| -| [booleanArrayValue](boolean-array-value.md) | public [booleanArrayValue](boolean-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)> | -| [booleanValue](boolean-value.md) | public [booleanValue](boolean-value.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | -| [doubleArrayValue](double-array-value.md) | public [doubleArrayValue](double-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)> | -| [doubleValue](double-value.md) | public [doubleValue](double-value.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) | -| [getType](get-type.md) | public [getType](get-type.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | -| [getValue](get-value.md) | public [getValue](get-value.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | -| [intArrayValue](int-array-value.md) | public [intArrayValue](int-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)> | -| [intValue](int-value.md) | public [intValue](int-value.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | -| [longArrayValue](long-array-value.md) | public [longArrayValue](long-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)> | -| [longValue](long-value.md) | public [longValue](long-value.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | -| [stringArrayValue](string-array-value.md) | public [stringArrayValue](string-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> | -| [stringValue](string-value.md) | public [stringValue](string-value.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | -| [toString](to-string.md) | public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | +# Variant + + +public class [Variant](index.md) + +This is a small class used to map win32 VARIANTs received by calls to ModelCenter's COM interface. + +#### Author + +Haisma, 2/2000 + +## Constructors + +| | | +|---|---| +| [Variant](-variant.md) | constructor(type: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), value: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html))
******************************************* Constructor | + +## Properties + +| Name | Summary | +|---|---| +| [BOOLEAN](-b-o-o-l-e-a-n.md) | val [BOOLEAN](-b-o-o-l-e-a-n.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 5 | +| [BOOLEAN_ARRAY](-b-o-o-l-e-a-n_-a-r-r-a-y.md) | val [BOOLEAN_ARRAY](-b-o-o-l-e-a-n_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 11 | +| [DISPATCH](-d-i-s-p-a-t-c-h.md) | val [DISPATCH](-d-i-s-p-a-t-c-h.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 13 | +| [DOUBLE](-d-o-u-b-l-e.md) | val [DOUBLE](-d-o-u-b-l-e.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 1 | +| [DOUBLE_ARRAY](-d-o-u-b-l-e_-a-r-r-a-y.md) | val [DOUBLE_ARRAY](-d-o-u-b-l-e_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 7 | +| [INT](-i-n-t.md) | val [INT](-i-n-t.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 2 | +| [INT_ARRAY](-i-n-t_-a-r-r-a-y.md) | val [INT_ARRAY](-i-n-t_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 8 | +| [LONG](-l-o-n-g.md) | val [LONG](-l-o-n-g.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 3 | +| [LONG_ARRAY](-l-o-n-g_-a-r-r-a-y.md) | val [LONG_ARRAY](-l-o-n-g_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 9 | +| [REFERENCE](-r-e-f-e-r-e-n-c-e.md) | val [REFERENCE](-r-e-f-e-r-e-n-c-e.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 6 | +| [STRING](-s-t-r-i-n-g.md) | val [STRING](-s-t-r-i-n-g.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 4 | +| [STRING_ARRAY](-s-t-r-i-n-g_-a-r-r-a-y.md) | val [STRING_ARRAY](-s-t-r-i-n-g_-a-r-r-a-y.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 10 | +| [UNKNOWN](-u-n-k-n-o-w-n.md) | val [UNKNOWN](-u-n-k-n-o-w-n.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 0 | + +## Functions + +| Name | Summary | +|---|---| +| [booleanArrayValue](boolean-array-value.md) | public [booleanArrayValue](boolean-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)> | +| [booleanValue](boolean-value.md) | public [booleanValue](boolean-value.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [doubleArrayValue](double-array-value.md) | public [doubleArrayValue](double-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)> | +| [doubleValue](double-value.md) | public [doubleValue](double-value.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html) | +| [getType](get-type.md) | public [getType](get-type.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [getValue](get-value.md) | public [getValue](get-value.md)(): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) | +| [intArrayValue](int-array-value.md) | public [intArrayValue](int-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)> | +| [intValue](int-value.md) | public [intValue](int-value.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [longArrayValue](long-array-value.md) | public [longArrayValue](long-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)> | +| [longValue](long-value.md) | public [longValue](long-value.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) | +| [stringArrayValue](string-array-value.md) | public [stringArrayValue](string-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> | +| [stringValue](string-value.md) | public [stringValue](string-value.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | +| [toString](to-string.md) | public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/int-array-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/int-array-value.md index 15e4f193d7..916578b230 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/int-array-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/int-array-value.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[intArrayValue](int-array-value.md) - -# intArrayValue - - -public [intArrayValue](int-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)> +# intArrayValue + + +public [intArrayValue](int-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)> diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/int-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/int-value.md index 8829163204..02236fddff 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/int-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/int-value.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[intValue](int-value.md) - -# intValue - - -public [intValue](int-value.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) +# intValue + + +public [intValue](int-value.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/long-array-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/long-array-value.md index f0fa1a0732..133afef8af 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/long-array-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/long-array-value.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[longArrayValue](long-array-value.md) - -# longArrayValue - - -public [longArrayValue](long-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)> +# longArrayValue + + +public [longArrayValue](long-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)> diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/long-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/long-value.md index c7f69b47af..93336f72fb 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/long-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/long-value.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[longValue](long-value.md) - -# longValue - - -public [longValue](long-value.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) +# longValue + + +public [longValue](long-value.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/string-array-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/string-array-value.md index e2bad71a59..f4e9416112 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/string-array-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/string-array-value.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[stringArrayValue](string-array-value.md) - -# stringArrayValue - - -public [stringArrayValue](string-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> +# stringArrayValue + + +public [stringArrayValue](string-array-value.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)> diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/string-value.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/string-value.md index abf2cfb3e6..e6b3d24d64 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/string-value.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/string-value.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[stringValue](string-value.md) - -# stringValue - - -public [stringValue](string-value.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) +# stringValue + + +public [stringValue](string-value.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/to-string.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/to-string.md index 75acf1d2e5..cd89ef278f 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/to-string.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/-variant/to-string.md @@ -1,6 +1,4 @@ -//[mc_api](../../../index.md)/[com.phoenix_int.ModelCenter](../index.md)/[Variant](index.md)/[toString](to-string.md) - -# toString - - -public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) +# toString + + +public [toString](to-string.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/index.md b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/index.md index 617e484136..ae621ef120 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/index.md +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/com.phoenix_int.ModelCenter/index.md @@ -1,80 +1,78 @@ -//[mc_api](../../index.md)/[com.phoenix_int.ModelCenter](index.md) - -# Package-level declarations - -## Types - -| Name | Summary | -|---|---| -| [AddToModel](-add-to-model/index.md) | public class [AddToModel](-add-to-model/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a AddToModel object. | -| [Array](-array/index.md) | public class [Array](-array/index.md) : [Variable](-variable/index.md)
This is a base class for array types in ModelCenter | -| [Assembly](-assembly/index.md) | public class [Assembly](-assembly/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [IVariableHolder](-i-variable-holder/index.md)
This is the wrapper class that handles the native COM calls to a Component object. | -| [BooleanArray](-boolean-array/index.md) | public class [BooleanArray](-boolean-array/index.md) : [Array](-array/index.md)
A variable type class for ModelCenter | -| [BooleanVariable](-boolean-variable/index.md) | public class [BooleanVariable](-boolean-variable/index.md) : [Variable](-variable/index.md)
A variable type class for ModelCenter | -| [CachePin](-cache-pin/index.md) | public class [CachePin](-cache-pin/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a CachePin. | -| [CompletedRunData](-completed-run-data/index.md) | public class [CompletedRunData](-completed-run-data/index.md)
Structure that contains information about completed runs. | -| [Component](-component/index.md) | public class [Component](-component/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [IVariableHolder](-i-variable-holder/index.md)
This is the wrapper class that handles the native COM calls to a Component object. | -| [CustomDesignPoint](-custom-design-point/index.md) | public class [CustomDesignPoint](-custom-design-point/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a custom design point. | -| [DataCollector](-data-collector/index.md) | public class [DataCollector](-data-collector/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a Data Collector. | -| [DataExplorer](-data-explorer/index.md) | public class [DataExplorer](-data-explorer/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a Data Explorer. | -| [DataHistory](-data-history/index.md) | public class [DataHistory](-data-history/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a Data History. | -| [DataHistoryVariableMetadataStruct](-data-history-variable-metadata-struct/index.md) | public class [DataHistoryVariableMetadataStruct](-data-history-variable-metadata-struct/index.md)
This object is used to pass variable metadata to the addVariableStructs function for data history, which sets the results for a run. | -| [DataHistoryVariableStruct](-data-history-variable-struct/index.md) | public class [DataHistoryVariableStruct](-data-history-variable-struct/index.md)
This object is used to pass a variable's data and metadata to the addVariableStructs function for data history, which sets the results for a run. | -| [DataMonitor](-data-monitor/index.md) | public class [DataMonitor](-data-monitor/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) | -| [DHVariable](-d-h-variable/index.md) | public class [DHVariable](-d-h-variable/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a Data History Variable. | -| [DoubleArray](-double-array/index.md) | public class [DoubleArray](-double-array/index.md) : [Array](-array/index.md)
An array type class for ModelCenter | -| [DoubleVariable](-double-variable/index.md) | public class [DoubleVariable](-double-variable/index.md) : [Variable](-variable/index.md)
A variable type class for ModelCenter | -| [Feature](-feature/index.md) | public class [Feature](-feature/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to PHXFeature. | -| [FileArray](-file-array/index.md) | public class [FileArray](-file-array/index.md) : [Array](-array/index.md)
A variable type class for ModelCenter | -| [FileSystemInfo](-file-system-info/index.md) | public class [FileSystemInfo](-file-system-info/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a FileSystemInfo. | -| [FileVariable](-file-variable/index.md) | public class [FileVariable](-file-variable/index.md) : [Variable](-variable/index.md)
A variable type class for ModelCenter | -| [Format](-format/index.md) | public class [Format](-format/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class for formatting | -| [Format2](-format2/index.md) | public class [Format2](-format2/index.md)
This is the wrapper class for formatting. | -| [GeometryVariable](-geometry-variable/index.md) | public class [GeometryVariable](-geometry-variable/index.md) : [Variable](-variable/index.md)
A variable type class for ModelCenter | -| [GlobalParameters](-global-parameters/index.md) | public class [GlobalParameters](-global-parameters/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
Global Parameters is a hashtable of values that can be set via the ModelCenter API and used for any purpose the client desires. | -| [Group](-group/index.md) | public class [Group](-group/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [IVariableHolder](-i-variable-holder/index.md)
This is the wrapper class that handles the native COM calls to a Registry object. | -| [IComponentPlugIn](-i-component-plug-in/index.md) | interface [IComponentPlugIn](-i-component-plug-in/index.md)
This is the interface that must be implemented by all Java plug-ins for ModelCenter. | -| [IDataCollectorPlugIn](-i-data-collector-plug-in/index.md) | interface [IDataCollectorPlugIn](-i-data-collector-plug-in/index.md)
This is the interface that must be implemented by all Java data collector plug-ins for ModelCenter. | -| [IDataExplorerPlugIn](-i-data-explorer-plug-in/index.md) | interface [IDataExplorerPlugIn](-i-data-explorer-plug-in/index.md)
This is the interface that must be implemented by all Java Data Explorer plug-ins for ModelCenter. | -| [IDataHistoryToModel](-i-data-history-to-model/index.md) | interface [IDataHistoryToModel](-i-data-history-to-model/index.md)
The Data History to Model connector is the piece that connects a Data History to a ModelCenter instance, for the purpose of restoring a run or re-running runs. | -| [IfComponent](-if-component/index.md) | public class [IfComponent](-if-component/index.md) : [Component](-component/index.md)
This is the wrapper class that handles the native COM calls to an IfComponent object. | -| [IHolder](-i-holder/index.md) | interface [IHolder](-i-holder/index.md)
This is an interface for things in ModelCenter that hold other things | -| [ILoginCallback](-i-login-callback/index.md) | interface [ILoginCallback](-i-login-callback/index.md)
Interface for handling login requests from ModelCenter. | -| [IModelCenter](-i-model-center/index.md) | interface [IModelCenter](-i-model-center/index.md)
Interface for ModelCenter class. | -| [IntegerArray](-integer-array/index.md) | public class [IntegerArray](-integer-array/index.md) : [Array](-array/index.md)
An array type class for ModelCenter | -| [IntegerVariable](-integer-variable/index.md) | public class [IntegerVariable](-integer-variable/index.md) : [Variable](-variable/index.md)
A variable type class for ModelCenter | -| [IPlugInMetaData](-i-plug-in-meta-data/index.md) | interface [IPlugInMetaData](-i-plug-in-meta-data/index.md)
This is the interface that must be implemented by all Java plug-in meta data objects for ModelCenter. | -| [IRunDataAction](-i-run-data-action/index.md) | interface [IRunDataAction](-i-run-data-action/index.md)
This is the interface to handle Design Viewer (geometry tooltip) events delegated to certain types of Data Explorer Plug-Ins such as Data Visualizer | -| [ITradeStudy3JobInfo](-i-trade-study3-job-info/index.md) | interface [ITradeStudy3JobInfo](-i-trade-study3-job-info/index.md)
Base interface for ITradeStudy3 job info and results | -| [ITradeStudy3JobManager](-i-trade-study3-job-manager/index.md) | interface [ITradeStudy3JobManager](-i-trade-study3-job-manager/index.md) : [ITradeStudy3JobInfo](-i-trade-study3-job-info/index.md)
Job manager for ITradeStudyPlugIn3 | -| [ITradeStudy3JobResult](-i-trade-study3-job-result/index.md) | interface [ITradeStudy3JobResult](-i-trade-study3-job-result/index.md) : [ITradeStudy3JobInfo](-i-trade-study3-job-info/index.md)
Result of executing a job. | -| [ITradeStudyCallback](-i-trade-study-callback/index.md) | interface [ITradeStudyCallback](-i-trade-study-callback/index.md)
This is the interface used to connect a trade study plug-in to a ModelCenter instance. | -| [ITradeStudyPlugIn](-i-trade-study-plug-in/index.md) | interface [ITradeStudyPlugIn](-i-trade-study-plug-in/index.md)
This is the interface that must be implemented by all Java trade study plug-ins for ModelCenter. | -| [ITradeStudyPlugIn2](-i-trade-study-plug-in2/index.md) | interface [ITradeStudyPlugIn2](-i-trade-study-plug-in2/index.md) : [ITradeStudyPlugIn](-i-trade-study-plug-in/index.md)
This is the interface that must be implemented by all Java trade study plug-ins for ModelCenter that can be used with OEM Analyzer tools. | -| [ITradeStudyPlugIn3](-i-trade-study-plug-in3/index.md) | interface [ITradeStudyPlugIn3](-i-trade-study-plug-in3/index.md) : [ITradeStudyPlugIn2](-i-trade-study-plug-in2/index.md)
Trade Study Plug-In 3 | -| [IVariableHolder](-i-variable-holder/index.md) | interface [IVariableHolder](-i-variable-holder/index.md) : [IHolder](-i-holder/index.md)
This is an interface for ModelCenter components | -| [IVariableMetaDataProvider](-i-variable-meta-data-provider/index.md) | interface [IVariableMetaDataProvider](-i-variable-meta-data-provider/index.md)
Base interface for ITradeStudy3 job info and results | -| [JavaObjectRepository](-java-object-repository/index.md) | public class [JavaObjectRepository](-java-object-repository/index.md) | -| [JobManager](-job-manager/index.md) | public class [JobManager](-job-manager/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a JobManager object. | -| [ModelCenter](-model-center/index.md) | public class [ModelCenter](-model-center/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [IModelCenter](-i-model-center/index.md)
This is the wrapper class that handles the native COM calls to ModelCenter. | -| [ModelCenterException](-model-center-exception/index.md) | public class [ModelCenterException](-model-center-exception/index.md) : [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html)
This class wraps exceptions thrown by the ModelCenter native methods. | -| [ObjectVariable](-object-variable/index.md) | public class [ObjectVariable](-object-variable/index.md) : [Variable](-variable/index.md)
An array type class for ModelCenter | -| [PHXJavaComObjectStored](-p-h-x-java-com-object-stored/index.md) | interface [PHXJavaComObjectStored](-p-h-x-java-com-object-stored/index.md) | -| [RefArrayProp](-ref-array-prop/index.md) | public class [RefArrayProp](-ref-array-prop/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
A Reference Array Property class for ModelCenter | -| [ReferenceArray](-reference-array/index.md) | public class [ReferenceArray](-reference-array/index.md) : [Array](-array/index.md)
A Array type class for ModelCenter | -| [ReferenceVariable](-reference-variable/index.md) | public class [ReferenceVariable](-reference-variable/index.md) : [Variable](-variable/index.md)
A variable type class for ModelCenter | -| [RefProp](-ref-prop/index.md) | public class [RefProp](-ref-prop/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
A Reference Property class for ModelCenter | -| [SaveContext](-save-context/index.md) | public class [SaveContext](-save-context/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
Class for generically saving and loading files in ModelCenter. | -| [ScriptComponent](-script-component/index.md) | public class [ScriptComponent](-script-component/index.md) : [Component](-component/index.md)
This is the wrapper class that handles the native COM calls to a ScriptComponent object. | -| [StringArray](-string-array/index.md) | public class [StringArray](-string-array/index.md) : [Array](-array/index.md)
A array type class for ModelCenter | -| [StringVariable](-string-variable/index.md) | public class [StringVariable](-string-variable/index.md) : [Variable](-variable/index.md)
A variable type class for ModelCenter | -| [TradeStudy](-trade-study/index.md) | public class [TradeStudy](-trade-study/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a TradeStudy object. | -| [TradeStudy2](-trade-study2/index.md) | public class [TradeStudy2](-trade-study2/index.md) : [TradeStudy](-trade-study/index.md)
This is the wrapper class that handles the native COM calls to a TradeStudy2 object. | -| [TradeStudy3](-trade-study3/index.md) | public class [TradeStudy3](-trade-study3/index.md) : [TradeStudy2](-trade-study2/index.md)
Class that wraps an ITradeStudy3PlugIn COM object. | -| [Variable](-variable/index.md) | public class [Variable](-variable/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is a base class for variable types in ModelCenter | -| [VariableDescription](-variable-description/index.md) | public class [VariableDescription](-variable-description/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a data item from a Data Collector. | -| [VariableLink](-variable-link/index.md) | public class [VariableLink](-variable-link/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is a base class for variable types in ModelCenter | -| [VariableLinks](-variable-links/index.md) | public class [VariableLinks](-variable-links/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)<[E](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)>
A collection of variables | -| [VariableMetaDataProvider](-variable-meta-data-provider/index.md) | public class [VariableMetaDataProvider](-variable-meta-data-provider/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
Metadata provider for variable data. | -| [Variables](-variables/index.md) | public class [Variables](-variables/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)<[E](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)>
A collection of variables | -| [Variant](-variant/index.md) | public class [Variant](-variant/index.md)
This is a small class used to map win32 VARIANTs received by calls to ModelCenter's COM interface. | +# Package-level declarations + +## Types + +| Name | Summary | +|---|---| +| [AddToModel](-add-to-model/index.md) | public class [AddToModel](-add-to-model/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a AddToModel object. | +| [Array](-array/index.md) | public class [Array](-array/index.md) : [Variable](-variable/index.md)
This is a base class for array types in ModelCenter | +| [Assembly](-assembly/index.md) | public class [Assembly](-assembly/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [IVariableHolder](-i-variable-holder/index.md)
This is the wrapper class that handles the native COM calls to a Component object. | +| [BooleanArray](-boolean-array/index.md) | public class [BooleanArray](-boolean-array/index.md) : [Array](-array/index.md)
A variable type class for ModelCenter | +| [BooleanVariable](-boolean-variable/index.md) | public class [BooleanVariable](-boolean-variable/index.md) : [Variable](-variable/index.md)
A variable type class for ModelCenter | +| [CachePin](-cache-pin/index.md) | public class [CachePin](-cache-pin/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a CachePin. | +| [CompletedRunData](-completed-run-data/index.md) | public class [CompletedRunData](-completed-run-data/index.md)
Structure that contains information about completed runs. | +| [Component](-component/index.md) | public class [Component](-component/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [IVariableHolder](-i-variable-holder/index.md)
This is the wrapper class that handles the native COM calls to a Component object. | +| [CustomDesignPoint](-custom-design-point/index.md) | public class [CustomDesignPoint](-custom-design-point/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a custom design point. | +| [DataCollector](-data-collector/index.md) | public class [DataCollector](-data-collector/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a Data Collector. | +| [DataExplorer](-data-explorer/index.md) | public class [DataExplorer](-data-explorer/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a Data Explorer. | +| [DataHistory](-data-history/index.md) | public class [DataHistory](-data-history/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a Data History. | +| [DataHistoryVariableMetadataStruct](-data-history-variable-metadata-struct/index.md) | public class [DataHistoryVariableMetadataStruct](-data-history-variable-metadata-struct/index.md)
This object is used to pass variable metadata to the addVariableStructs function for data history, which sets the results for a run. | +| [DataHistoryVariableStruct](-data-history-variable-struct/index.md) | public class [DataHistoryVariableStruct](-data-history-variable-struct/index.md)
This object is used to pass a variable's data and metadata to the addVariableStructs function for data history, which sets the results for a run. | +| [DataMonitor](-data-monitor/index.md) | public class [DataMonitor](-data-monitor/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md) | +| [DHVariable](-d-h-variable/index.md) | public class [DHVariable](-d-h-variable/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a Data History Variable. | +| [DoubleArray](-double-array/index.md) | public class [DoubleArray](-double-array/index.md) : [Array](-array/index.md)
An array type class for ModelCenter | +| [DoubleVariable](-double-variable/index.md) | public class [DoubleVariable](-double-variable/index.md) : [Variable](-variable/index.md)
A variable type class for ModelCenter | +| [Feature](-feature/index.md) | public class [Feature](-feature/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to PHXFeature. | +| [FileArray](-file-array/index.md) | public class [FileArray](-file-array/index.md) : [Array](-array/index.md)
A variable type class for ModelCenter | +| [FileSystemInfo](-file-system-info/index.md) | public class [FileSystemInfo](-file-system-info/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a FileSystemInfo. | +| [FileVariable](-file-variable/index.md) | public class [FileVariable](-file-variable/index.md) : [Variable](-variable/index.md)
A variable type class for ModelCenter | +| [Format](-format/index.md) | public class [Format](-format/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class for formatting | +| [Format2](-format2/index.md) | public class [Format2](-format2/index.md)
This is the wrapper class for formatting. | +| [GeometryVariable](-geometry-variable/index.md) | public class [GeometryVariable](-geometry-variable/index.md) : [Variable](-variable/index.md)
A variable type class for ModelCenter | +| [GlobalParameters](-global-parameters/index.md) | public class [GlobalParameters](-global-parameters/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
Global Parameters is a hashtable of values that can be set via the ModelCenter API and used for any purpose the client desires. | +| [Group](-group/index.md) | public class [Group](-group/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [IVariableHolder](-i-variable-holder/index.md)
This is the wrapper class that handles the native COM calls to a Registry object. | +| [IComponentPlugIn](-i-component-plug-in/index.md) | interface [IComponentPlugIn](-i-component-plug-in/index.md)
This is the interface that must be implemented by all Java plug-ins for ModelCenter. | +| [IDataCollectorPlugIn](-i-data-collector-plug-in/index.md) | interface [IDataCollectorPlugIn](-i-data-collector-plug-in/index.md)
This is the interface that must be implemented by all Java data collector plug-ins for ModelCenter. | +| [IDataExplorerPlugIn](-i-data-explorer-plug-in/index.md) | interface [IDataExplorerPlugIn](-i-data-explorer-plug-in/index.md)
This is the interface that must be implemented by all Java Data Explorer plug-ins for ModelCenter. | +| [IDataHistoryToModel](-i-data-history-to-model/index.md) | interface [IDataHistoryToModel](-i-data-history-to-model/index.md)
The Data History to Model connector is the piece that connects a Data History to a ModelCenter instance, for the purpose of restoring a run or re-running runs. | +| [IfComponent](-if-component/index.md) | public class [IfComponent](-if-component/index.md) : [Component](-component/index.md)
This is the wrapper class that handles the native COM calls to an IfComponent object. | +| [IHolder](-i-holder/index.md) | interface [IHolder](-i-holder/index.md)
This is an interface for things in ModelCenter that hold other things | +| [ILoginCallback](-i-login-callback/index.md) | interface [ILoginCallback](-i-login-callback/index.md)
Interface for handling login requests from ModelCenter. | +| [IModelCenter](-i-model-center/index.md) | interface [IModelCenter](-i-model-center/index.md)
Interface for ModelCenter class. | +| [IntegerArray](-integer-array/index.md) | public class [IntegerArray](-integer-array/index.md) : [Array](-array/index.md)
An array type class for ModelCenter | +| [IntegerVariable](-integer-variable/index.md) | public class [IntegerVariable](-integer-variable/index.md) : [Variable](-variable/index.md)
A variable type class for ModelCenter | +| [IPlugInMetaData](-i-plug-in-meta-data/index.md) | interface [IPlugInMetaData](-i-plug-in-meta-data/index.md)
This is the interface that must be implemented by all Java plug-in meta data objects for ModelCenter. | +| [IRunDataAction](-i-run-data-action/index.md) | interface [IRunDataAction](-i-run-data-action/index.md)
This is the interface to handle Design Viewer (geometry tooltip) events delegated to certain types of Data Explorer Plug-Ins such as Data Visualizer | +| [ITradeStudy3JobInfo](-i-trade-study3-job-info/index.md) | interface [ITradeStudy3JobInfo](-i-trade-study3-job-info/index.md)
Base interface for ITradeStudy3 job info and results | +| [ITradeStudy3JobManager](-i-trade-study3-job-manager/index.md) | interface [ITradeStudy3JobManager](-i-trade-study3-job-manager/index.md) : [ITradeStudy3JobInfo](-i-trade-study3-job-info/index.md)
Job manager for ITradeStudyPlugIn3 | +| [ITradeStudy3JobResult](-i-trade-study3-job-result/index.md) | interface [ITradeStudy3JobResult](-i-trade-study3-job-result/index.md) : [ITradeStudy3JobInfo](-i-trade-study3-job-info/index.md)
Result of executing a job. | +| [ITradeStudyCallback](-i-trade-study-callback/index.md) | interface [ITradeStudyCallback](-i-trade-study-callback/index.md)
This is the interface used to connect a trade study plug-in to a ModelCenter instance. | +| [ITradeStudyPlugIn](-i-trade-study-plug-in/index.md) | interface [ITradeStudyPlugIn](-i-trade-study-plug-in/index.md)
This is the interface that must be implemented by all Java trade study plug-ins for ModelCenter. | +| [ITradeStudyPlugIn2](-i-trade-study-plug-in2/index.md) | interface [ITradeStudyPlugIn2](-i-trade-study-plug-in2/index.md) : [ITradeStudyPlugIn](-i-trade-study-plug-in/index.md)
This is the interface that must be implemented by all Java trade study plug-ins for ModelCenter that can be used with OEM Analyzer tools. | +| [ITradeStudyPlugIn3](-i-trade-study-plug-in3/index.md) | interface [ITradeStudyPlugIn3](-i-trade-study-plug-in3/index.md) : [ITradeStudyPlugIn2](-i-trade-study-plug-in2/index.md)
Trade Study Plug-In 3 | +| [IVariableHolder](-i-variable-holder/index.md) | interface [IVariableHolder](-i-variable-holder/index.md) : [IHolder](-i-holder/index.md)
This is an interface for ModelCenter components | +| [IVariableMetaDataProvider](-i-variable-meta-data-provider/index.md) | interface [IVariableMetaDataProvider](-i-variable-meta-data-provider/index.md)
Base interface for ITradeStudy3 job info and results | +| [JavaObjectRepository](-java-object-repository/index.md) | public class [JavaObjectRepository](-java-object-repository/index.md) | +| [JobManager](-job-manager/index.md) | public class [JobManager](-job-manager/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a JobManager object. | +| [ModelCenter](-model-center/index.md) | public class [ModelCenter](-model-center/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [IModelCenter](-i-model-center/index.md)
This is the wrapper class that handles the native COM calls to ModelCenter. | +| [ModelCenterException](-model-center-exception/index.md) | public class [ModelCenterException](-model-center-exception/index.md) : [Exception](https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html)
This class wraps exceptions thrown by the ModelCenter native methods. | +| [ObjectVariable](-object-variable/index.md) | public class [ObjectVariable](-object-variable/index.md) : [Variable](-variable/index.md)
An array type class for ModelCenter | +| [PHXJavaComObjectStored](-p-h-x-java-com-object-stored/index.md) | interface [PHXJavaComObjectStored](-p-h-x-java-com-object-stored/index.md) | +| [RefArrayProp](-ref-array-prop/index.md) | public class [RefArrayProp](-ref-array-prop/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
A Reference Array Property class for ModelCenter | +| [ReferenceArray](-reference-array/index.md) | public class [ReferenceArray](-reference-array/index.md) : [Array](-array/index.md)
A Array type class for ModelCenter | +| [ReferenceVariable](-reference-variable/index.md) | public class [ReferenceVariable](-reference-variable/index.md) : [Variable](-variable/index.md)
A variable type class for ModelCenter | +| [RefProp](-ref-prop/index.md) | public class [RefProp](-ref-prop/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
A Reference Property class for ModelCenter | +| [SaveContext](-save-context/index.md) | public class [SaveContext](-save-context/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
Class for generically saving and loading files in ModelCenter. | +| [ScriptComponent](-script-component/index.md) | public class [ScriptComponent](-script-component/index.md) : [Component](-component/index.md)
This is the wrapper class that handles the native COM calls to a ScriptComponent object. | +| [StringArray](-string-array/index.md) | public class [StringArray](-string-array/index.md) : [Array](-array/index.md)
A array type class for ModelCenter | +| [StringVariable](-string-variable/index.md) | public class [StringVariable](-string-variable/index.md) : [Variable](-variable/index.md)
A variable type class for ModelCenter | +| [TradeStudy](-trade-study/index.md) | public class [TradeStudy](-trade-study/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a TradeStudy object. | +| [TradeStudy2](-trade-study2/index.md) | public class [TradeStudy2](-trade-study2/index.md) : [TradeStudy](-trade-study/index.md)
This is the wrapper class that handles the native COM calls to a TradeStudy2 object. | +| [TradeStudy3](-trade-study3/index.md) | public class [TradeStudy3](-trade-study3/index.md) : [TradeStudy2](-trade-study2/index.md)
Class that wraps an ITradeStudy3PlugIn COM object. | +| [Variable](-variable/index.md) | public class [Variable](-variable/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is a base class for variable types in ModelCenter | +| [VariableDescription](-variable-description/index.md) | public class [VariableDescription](-variable-description/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is the wrapper class that handles the native COM calls to a data item from a Data Collector. | +| [VariableLink](-variable-link/index.md) | public class [VariableLink](-variable-link/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
This is a base class for variable types in ModelCenter | +| [VariableLinks](-variable-links/index.md) | public class [VariableLinks](-variable-links/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)<[E](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)>
A collection of variables | +| [VariableMetaDataProvider](-variable-meta-data-provider/index.md) | public class [VariableMetaDataProvider](-variable-meta-data-provider/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md)
Metadata provider for variable data. | +| [Variables](-variables/index.md) | public class [Variables](-variables/index.md) : [PHXCOMObject](../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)<[E](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html)>
A collection of variables | +| [Variant](-variant/index.md) | public class [Variant](-variant/index.md)
This is a small class used to map win32 VARIANTs received by calls to ModelCenter's COM interface. | diff --git a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/package-list b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/package-list index b191f923ca..86f1def14d 100644 --- a/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/package-list +++ b/2025R1_Test/ModelCenter-API-25-R1/modelcenter-java-api-md/mc_api/package-list @@ -1,1642 +1,1642 @@ -$dokka.format:gfm-v1 -$dokka.linkExtension:md -$dokka.location:com.phoenix_int.ModelCenter.Geometry////PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/index.md -$dokka.location:com.phoenix_int.ModelCenter.Geometry/AWTExceptionHandler///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/index.md -$dokka.location:com.phoenix_int.ModelCenter.Geometry/AWTExceptionHandler/AWTExceptionHandler/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/-a-w-t-exception-handler.md -$dokka.location:com.phoenix_int.ModelCenter.Geometry/AWTExceptionHandler/handle/#java.lang.Throwable/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/handle.md -$dokka.location:com.phoenix_int.ModelCenter.Geometry/AWTExceptionHandler/register/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/register.md -$dokka.location:com.phoenix_int.ModelCenter.Geometry/PHXJOGL///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/index.md -$dokka.location:com.phoenix_int.ModelCenter.Geometry/PHXJOGL/PHXJOGL/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/-p-h-x-j-o-g-l.md -$dokka.location:com.phoenix_int.ModelCenter.Geometry/PHXJOGL/createList/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/create-list.md -$dokka.location:com.phoenix_int.ModelCenter.Geometry/PHXJOGL/getExts/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/get-exts.md -$dokka.location:com.phoenix_int.ModelCenter.Geometry/PHXJOGL/loadScripts/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/load-scripts.md -$dokka.location:com.phoenix_int.ModelCenter.logging////PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/index.md -$dokka.location:com.phoenix_int.ModelCenter.logging/Logger///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/index.md -$dokka.location:com.phoenix_int.ModelCenter.logging/Logger/Logger/#long#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/-logger.md -$dokka.location:com.phoenix_int.ModelCenter.logging/Logger/debug/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/debug.md -$dokka.location:com.phoenix_int.ModelCenter.logging/Logger/error/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/error.md -$dokka.location:com.phoenix_int.ModelCenter.logging/Logger/info/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/info.md -$dokka.location:com.phoenix_int.ModelCenter.logging/Logger/isDebugEnabled/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-debug-enabled.md -$dokka.location:com.phoenix_int.ModelCenter.logging/Logger/isErrorEnabled/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-error-enabled.md -$dokka.location:com.phoenix_int.ModelCenter.logging/Logger/isInfoEnabled/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-info-enabled.md -$dokka.location:com.phoenix_int.ModelCenter.logging/Logger/isWarnEnabled/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-warn-enabled.md -$dokka.location:com.phoenix_int.ModelCenter.logging/Logger/warn/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/warn.md -$dokka.location:com.phoenix_int.ModelCenter.util////PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/index.md -$dokka.location:com.phoenix_int.ModelCenter.util/BeanshellUtil///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-beanshell-util/index.md -$dokka.location:com.phoenix_int.ModelCenter.util/BeanshellUtil/BeanshellUtil/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-beanshell-util/-beanshell-util.md -$dokka.location:com.phoenix_int.ModelCenter.util/BeanshellUtil/runScript/#java.lang.String#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-beanshell-util/run-script.md -$dokka.location:com.phoenix_int.ModelCenter.util/LoggerUpdater///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/index.md -$dokka.location:com.phoenix_int.ModelCenter.util/LoggerUpdater/LoggerUpdater/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/-logger-updater.md -$dokka.location:com.phoenix_int.ModelCenter.util/LoggerUpdater/isResetResistant/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/is-reset-resistant.md -$dokka.location:com.phoenix_int.ModelCenter.util/LoggerUpdater/onLevelChange/#Logger#Level/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-level-change.md -$dokka.location:com.phoenix_int.ModelCenter.util/LoggerUpdater/onReset/#LoggerContext/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-reset.md -$dokka.location:com.phoenix_int.ModelCenter.util/LoggerUpdater/onStart/#LoggerContext/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-start.md -$dokka.location:com.phoenix_int.ModelCenter.util/LoggerUpdater/onStop/#LoggerContext/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-stop.md -$dokka.location:com.phoenix_int.ModelCenter.util/LoggerUpdater/stop/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/stop.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObject///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObject/disableGC/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObject/release/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObject/releaseObjects/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObject/setReferenceDebugMode/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObjectHolder///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/index.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObjectHolder/PHXCOMObjectHolder/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/-p-h-x-c-o-m-object-holder.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObjectHolder/getObject/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/get-object.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObjectHolder/release/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/release.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObjectHolder/setObjectMain/#T/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/set-object-main.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObjectHolder/setObjectOther/#T/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/set-object-other.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXEquationParser///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-equation-parser/index.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXEquationParser/PHXEquationParser/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-equation-parser/-p-h-x-equation-parser.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXEquationParser/parseEquation/#java.lang.String#java.lang.String[]#java.lang.String[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-equation-parser/parse-equation.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXIOConsole///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/index.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXIOConsole/actionPerformed/#java.awt.event.ActionEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/action-performed.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXIOConsole/dispose/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/dispose.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXIOConsole/isShowing/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/is-showing.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXIOConsole/show/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/show.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXJarLocation///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-jar-location/index.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXJarLocation/PHXJarLocation/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-jar-location/-p-h-x-jar-location.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXJarLocation/getClassLocation/#java.lang.Class/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-jar-location/get-class-location.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXMCJarLoader///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-m-c-jar-loader/index.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXMCJarLoader/PHXMCJarLoader/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-m-c-jar-loader/-p-h-x-m-c-jar-loader.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXMCJarLoader/classExists/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-m-c-jar-loader/class-exists.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/index.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/PHXPlugInLauncher/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/-p-h-x-plug-in-launcher.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/classExists/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/class-exists.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/cleanUp/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/clean-up.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/constructModelCenter/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/construct-model-center.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/disableIOConsole/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/disable-i-o-console.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/getDummyFrame/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/get-dummy-frame.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/launchComponentPlugIn/#long#java.lang.String#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-component-plug-in.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/launchDataCollectorPlugIn/#long#java.lang.String#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-data-collector-plug-in.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/launchPlugInMetaData/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-plug-in-meta-data.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/launchTradeStudyPlugIn/#long#java.lang.String#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-trade-study-plug-in.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/index.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/actionPerformed/#java.awt.event.ActionEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/action-performed.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/itemStateChanged/#java.awt.event.ItemEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/item-state-changed.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/showMonitor/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/show-monitor.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/valueChanged/#javax.swing.event.ListSelectionEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/value-changed.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/windowActivated/#java.awt.event.WindowEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-activated.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/windowClosed/#java.awt.event.WindowEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-closed.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/windowClosing/#java.awt.event.WindowEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-closing.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/windowDeactivated/#java.awt.event.WindowEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-deactivated.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/windowDeiconified/#java.awt.event.WindowEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-deiconified.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/windowIconified/#java.awt.event.WindowEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-iconified.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/windowOpened/#java.awt.event.WindowEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-opened.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXURLClassLoader///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/index.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXURLClassLoader/PHXURLClassLoader/#java.net.URL[]#java.lang.ClassLoader#java.net.URLStreamHandlerFactory/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/-p-h-x-u-r-l-class-loader.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXURLClassLoader/PHXURLClassLoader/#java.net.URL[]#java.lang.ClassLoader/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/-p-h-x-u-r-l-class-loader.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXURLClassLoader/PHXURLClassLoader/#java.net.URL[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/-p-h-x-u-r-l-class-loader.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXURLClassLoader/addURL2/#java.net.URL/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/add-u-r-l2.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXURLClassLoader/getResource/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/get-resource.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXURLClassLoader/getResourceAsStream/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/get-resource-as-stream.md -$dokka.location:com.phoenix_int.ModelCenter.util/PHXURLClassLoader/loadClass/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/load-class.md -$dokka.location:com.phoenix_int.ModelCenter.util/ValueHolder///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/index.md -$dokka.location:com.phoenix_int.ModelCenter.util/ValueHolder/ValueHolder/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/-value-holder.md -$dokka.location:com.phoenix_int.ModelCenter.util/ValueHolder/ValueHolder/#T/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/-value-holder.md -$dokka.location:com.phoenix_int.ModelCenter.util/ValueHolder/value/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/value.md -$dokka.location:com.phoenix_int.ModelCenter////PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/index.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/index.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/AddToModel/#long#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/-add-to-model.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/AddToModel/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/-add-to-model.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/addInput/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-input.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/addInput2/#java.lang.String#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-input2.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/addMethod/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-method.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/addOutput/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-output.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/addOutput2/#java.lang.String#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-output2.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/addToModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-to-model.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/addToModel2/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-to-model2.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/addToModel3/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-to-model3.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/clearBusyFlag/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/clear-busy-flag.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/getAutoRun/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-auto-run.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/getComponent/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-component.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/getPrevalidateInputs/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-prevalidate-inputs.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/getProgID/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-prog-i-d.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/getRegID/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-reg-i-d.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/newInstance/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/new-instance.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/setAuthor/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-author.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/setAutoRun/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-auto-run.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/setComponentRequirements/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-component-requirements.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-description.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/setHelpURL/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-help-u-r-l.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/setIcon/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-icon.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/setKeywords/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-keywords.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/setPrevalidateInputs/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-prevalidate-inputs.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/setVersion/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-version.md -$dokka.location:com.phoenix_int.ModelCenter/AddToModel/updateComponent/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/update-component.md -$dokka.location:com.phoenix_int.ModelCenter/Array///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/index.md -$dokka.location:com.phoenix_int.ModelCenter/Array/fromString/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/from-string.md -$dokka.location:com.phoenix_int.ModelCenter/Array/getAutoSize/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/get-auto-size.md -$dokka.location:com.phoenix_int.ModelCenter/Array/getDimensions/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/get-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/Array/getLength/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/get-length.md -$dokka.location:com.phoenix_int.ModelCenter/Array/getLength/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/get-length.md -$dokka.location:com.phoenix_int.ModelCenter/Array/getNumDimensions/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/get-num-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/Array/getSize/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/get-size.md -$dokka.location:com.phoenix_int.ModelCenter/Array/getSize/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/get-size.md -$dokka.location:com.phoenix_int.ModelCenter/Array/setAutoSize/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-auto-size.md -$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/Array/setLength/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-length.md -$dokka.location:com.phoenix_int.ModelCenter/Array/setLength/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-length.md -$dokka.location:com.phoenix_int.ModelCenter/Array/setNumDimensions/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-num-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/Array/setSize/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-size.md -$dokka.location:com.phoenix_int.ModelCenter/Array/setSize/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-size.md -$dokka.location:com.phoenix_int.ModelCenter/Array/toString/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/to-string.md -$dokka.location:com.phoenix_int.ModelCenter/Array/toStringAbsolute/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/to-string-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/index.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/ASSEMBLY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/-a-s-s-e-m-b-l-y.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/FOR_EACH/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/-f-o-r_-e-a-c-h.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/IF/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/-i-f.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/LOOP/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/-l-o-o-p.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/PARALLEL/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/-p-a-r-a-l-l-e-l.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/SEQUENCE/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/-s-e-q-u-e-n-c-e.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/addAssembly/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/add-assembly.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/addAssembly/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/add-assembly.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/addAssembly2/#java.lang.String#int#int#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/add-assembly2.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/addAssembly2/#java.lang.String#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/add-assembly2.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/addVariable/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/add-variable.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/convertToSubmodel/#java.lang.String#com.phoenix_int.ModelCenter.ModelCenter.VersionStatus#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/convert-to-submodel.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/deleteVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/delete-variable.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getAssembly/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-assembly.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getAssembly/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-assembly.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getAssemblyType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-assembly-type.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getComponent/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-component.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getComponent/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-component.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getFullName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-full-name.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getGroup/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-group.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getGroup/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-group.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getIconID/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-icon-i-d.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getIndexInParent/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-index-in-parent.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getMetadata/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-metadata.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-name.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getNumAssemblies/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-assemblies.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getNumComponents/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-components.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getNumGroups/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-groups.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getNumVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-variables.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getParentAssembly/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-parent-assembly.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getPositionX/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-position-x.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getPositionY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-position-y.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getUserData/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-user-data.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getVariable/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-variable.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/getVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-variable.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/rename/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/rename.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/setIconID/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/set-icon-i-d.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/setMetadata/#java.lang.String#com.phoenix_int.ModelCenter.Variable.MetadataType#java.lang.Object#com.phoenix_int.ModelCenter.Variable.MetadataAccess#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/set-metadata.md -$dokka.location:com.phoenix_int.ModelCenter/Assembly/setUserData/#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/set-user-data.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/index.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-description.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-description.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanVariable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/index.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanVariable/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/get-description.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanVariable/getValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanVariable/getValueAbsolute/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanVariable/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/set-description.md -$dokka.location:com.phoenix_int.ModelCenter/BooleanVariable/setValue/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/CachePin///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-cache-pin/index.md -$dokka.location:com.phoenix_int.ModelCenter/CachePin/checkinOnFlush/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-cache-pin/checkin-on-flush.md -$dokka.location:com.phoenix_int.ModelCenter/CachePin/getLocalPath/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-cache-pin/get-local-path.md -$dokka.location:com.phoenix_int.ModelCenter/CachePin/getUrl/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-cache-pin/get-url.md -$dokka.location:com.phoenix_int.ModelCenter/CachePin/isValid/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-cache-pin/is-valid.md -$dokka.location:com.phoenix_int.ModelCenter/CachePin/releasePin/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-cache-pin/release-pin.md -$dokka.location:com.phoenix_int.ModelCenter/CompletedRunData///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/index.md -$dokka.location:com.phoenix_int.ModelCenter/CompletedRunData/CompletedRunData/#int[]#int[]#java.lang.String[]#java.lang.Object[][]#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/-completed-run-data.md -$dokka.location:com.phoenix_int.ModelCenter/CompletedRunData/getEndSequenceNumber/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-end-sequence-number.md -$dokka.location:com.phoenix_int.ModelCenter/CompletedRunData/getErrorIDs/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-error-i-ds.md -$dokka.location:com.phoenix_int.ModelCenter/CompletedRunData/getErrorMessages/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-error-messages.md -$dokka.location:com.phoenix_int.ModelCenter/CompletedRunData/getNextSequenceNumber/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-next-sequence-number.md -$dokka.location:com.phoenix_int.ModelCenter/CompletedRunData/getRunIDs/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-run-i-ds.md -$dokka.location:com.phoenix_int.ModelCenter/CompletedRunData/getVariableValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-variable-values.md -$dokka.location:com.phoenix_int.ModelCenter/Component///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/index.md -$dokka.location:com.phoenix_int.ModelCenter/Component/COMPONENT_TYPE_ASSEMBLY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md -$dokka.location:com.phoenix_int.ModelCenter/Component/COMPONENT_TYPE_COMPONENT/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md -$dokka.location:com.phoenix_int.ModelCenter/Component/COMPONENT_TYPE_EMPTY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md -$dokka.location:com.phoenix_int.ModelCenter/Component/COMPONENT_TYPE_FOR_EACH/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md -$dokka.location:com.phoenix_int.ModelCenter/Component/COMPONENT_TYPE_IF/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md -$dokka.location:com.phoenix_int.ModelCenter/Component/COMPONENT_TYPE_LOOP/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md -$dokka.location:com.phoenix_int.ModelCenter/Component/COMPONENT_TYPE_PARALLEL/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md -$dokka.location:com.phoenix_int.ModelCenter/Component/COMPONENT_TYPE_SCRIPTCOMPONENT/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md -$dokka.location:com.phoenix_int.ModelCenter/Component/COMPONENT_TYPE_SEQUENCE/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md -$dokka.location:com.phoenix_int.ModelCenter/Component/downloadValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/download-values.md -$dokka.location:com.phoenix_int.ModelCenter/Component/getAssociatedFiles/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-associated-files.md -$dokka.location:com.phoenix_int.ModelCenter/Component/getFullName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-full-name.md -$dokka.location:com.phoenix_int.ModelCenter/Component/getGroup/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-group.md -$dokka.location:com.phoenix_int.ModelCenter/Component/getGroup/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-group.md -$dokka.location:com.phoenix_int.ModelCenter/Component/getIndexInParent/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-index-in-parent.md -$dokka.location:com.phoenix_int.ModelCenter/Component/getMetadata/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-metadata.md -$dokka.location:com.phoenix_int.ModelCenter/Component/getName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-name.md -$dokka.location:com.phoenix_int.ModelCenter/Component/getNumGroups/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-num-groups.md -$dokka.location:com.phoenix_int.ModelCenter/Component/getNumVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-num-variables.md -$dokka.location:com.phoenix_int.ModelCenter/Component/getParentAssembly/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-parent-assembly.md -$dokka.location:com.phoenix_int.ModelCenter/Component/getPositionX/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-position-x.md -$dokka.location:com.phoenix_int.ModelCenter/Component/getPositionY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-position-y.md -$dokka.location:com.phoenix_int.ModelCenter/Component/getSource/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-source.md -$dokka.location:com.phoenix_int.ModelCenter/Component/getType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-type.md -$dokka.location:com.phoenix_int.ModelCenter/Component/getUserData/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-user-data.md -$dokka.location:com.phoenix_int.ModelCenter/Component/getVariable/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-variable.md -$dokka.location:com.phoenix_int.ModelCenter/Component/getVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-variable.md -$dokka.location:com.phoenix_int.ModelCenter/Component/invalidate/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/invalidate.md -$dokka.location:com.phoenix_int.ModelCenter/Component/invokeMethod/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/invoke-method.md -$dokka.location:com.phoenix_int.ModelCenter/Component/reconnect/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/reconnect.md -$dokka.location:com.phoenix_int.ModelCenter/Component/rename/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/rename.md -$dokka.location:com.phoenix_int.ModelCenter/Component/run/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/run.md -$dokka.location:com.phoenix_int.ModelCenter/Component/setAssociatedFiles/#java.lang.Object[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/set-associated-files.md -$dokka.location:com.phoenix_int.ModelCenter/Component/setMetadata/#java.lang.String#com.phoenix_int.ModelCenter.Variable.MetadataType#java.lang.Object#com.phoenix_int.ModelCenter.Variable.MetadataAccess#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/set-metadata.md -$dokka.location:com.phoenix_int.ModelCenter/Component/setUserData/#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/set-user-data.md -$dokka.location:com.phoenix_int.ModelCenter/Component/show/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/show.md -$dokka.location:com.phoenix_int.ModelCenter/CustomDesignPoint///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/index.md -$dokka.location:com.phoenix_int.ModelCenter/CustomDesignPoint/addVariable/#java.lang.String#java.lang.String#boolean#boolean#boolean#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/add-variable.md -$dokka.location:com.phoenix_int.ModelCenter/CustomDesignPoint/getID2/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/get-i-d2.md -$dokka.location:com.phoenix_int.ModelCenter/CustomDesignPoint/runFailed/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/run-failed.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/index.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/DHVariable/#long#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/-d-h-variable.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/DHVariable/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/-d-h-variable.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getEnumAlias/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-alias.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getEnumAliases/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-aliases.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getEnumValue/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-value.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getEquation/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-equation.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getFormat/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-format.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getMetaData/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-meta-data.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-name.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getNumEnumAlias/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-num-enum-alias.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getNumEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-num-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-type.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getUnits/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-units.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/isDesignVar/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/is-design-var.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/isInput/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/is-input.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/isNumeric/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/is-numeric.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/removeMetadata/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/remove-metadata.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setDesignVar/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-design-var.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setEnumAliases/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-enum-aliases.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setEquation/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-equation.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setFormat/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-format.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setInput/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-input.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setLowerBound/#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setMetaData/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-meta-data.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setName/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-name.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setNumeric/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-numeric.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setType/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-type.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setUnits/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-units.md -$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setUpperBound/#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/index.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/DataCollector/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/-data-collector.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/addCustom/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/add-custom.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/createEmptyRuns/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/create-empty-runs.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/enableCarpetPlotTab/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-carpet-plot-tab.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/enableCarpetPlotTab/#long#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-carpet-plot-tab.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/enableGraphTab/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-graph-tab.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/enableMainEffectsTab/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-main-effects-tab.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/endRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/end-runs.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/exportToCSV/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/export-to-c-s-v.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/fromString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/from-string.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getDataExplorer/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-data-explorer.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getErrorID/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-error-i-d.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getErrorMessage/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-error-message.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getNumFailedRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-num-failed-runs.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getNumRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-num-runs.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getNumVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-num-variables.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getValue/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getValue/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getVariableDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-variable-description.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getVariableDescription/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-variable-description.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/hide/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/hide.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/isValid/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/is-valid.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/isValid/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/is-valid.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/isVisible/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/is-visible.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/newCustomDesignPoint/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/new-custom-design-point.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/newInstance/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/new-instance.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/save/#java.lang.String#java.lang.String#java.lang.String#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/save.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/selectX/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/select-x.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/selectY/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/select-y.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/setCustomRun/#long#com.phoenix_int.ModelCenter.CustomDesignPoint/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/set-custom-run.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/setNumExpectedRuns/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/set-num-expected-runs.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/show/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/show.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/startRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/start-runs.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/storeCurrentDesignPoint/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/store-current-design-point.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/storeCustomDesignPoint/#com.phoenix_int.ModelCenter.CustomDesignPoint/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/store-custom-design-point.md -$dokka.location:com.phoenix_int.ModelCenter/DataCollector/toString/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/to-string.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer.PHXDEKeepalive///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/-p-h-x-d-e-keepalive/index.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/index.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/addPage/#java.lang.String#long#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/add-page.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/addRunsToComparisonList/#long[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/add-runs-to-comparison-list.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/addToComparisonList/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/add-to-comparison-list.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/fromXML/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/from-x-m-l.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/fromXML/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/from-x-m-l.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/fromXMLFile/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/from-x-m-l-file.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/fromXMLFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/from-x-m-l-file.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getAssociatedModelFile/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-associated-model-file.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getAssociatedModelFileUUID/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-associated-model-file-u-u-i-d.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getAuthor/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-author.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getCreationDate/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-creation-date.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getDaXFormat/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-da-x-format.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getDaXType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-da-x-type.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getDataHistory/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-data-history.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-description.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getDisplayName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-display-name.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getFileUri/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-file-uri.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getHWND/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-h-w-n-d.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getKeepalive/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-keepalive.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getModelCenter/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-model-center.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getNumPages/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-num-pages.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getPageType/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-page-type.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getSelectedPage/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-selected-page.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getTradeStudySetup/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-trade-study-setup.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getTradeStudyType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-trade-study-type.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/hide/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/hide.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/ignoreDefaultPlotSetup/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/ignore-default-plot-setup.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/invokeInsertPageGUI/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/invoke-insert-page-g-u-i.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/invokeMenuItem/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/invoke-menu-item.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/isMenuItemChecked/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/is-menu-item-checked.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/isMenuItemEnabled/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/is-menu-item-enabled.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/isVisible/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/is-visible.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/movePage/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/move-page.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/multiDelete/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/multi-delete.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/multiPageCopy/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/multi-page-copy.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/multiPageCut/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/multi-page-cut.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/newInstance/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/new-instance.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/pageCopy/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/page-copy.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/pageCut/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/page-cut.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/pagePaste/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/page-paste.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/removeFromComparisonList/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/remove-from-comparison-list.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/removePage/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/remove-page.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/selectPage/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/select-page.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setAssociatedModelFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-associated-model-file.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setAssociatedModelFileUUID/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-associated-model-file-u-u-i-d.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setAuthor/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-author.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setCreationDate/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-creation-date.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-description.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setDisplayName/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-display-name.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setFileUri/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-file-uri.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setGeomViewerRunID/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-geom-viewer-run-i-d.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setTradeStudySetup/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-trade-study-setup.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setTradeStudyType/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-trade-study-type.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setupPlotsPost/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/setup-plots-post.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setupPlotsPre/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/setup-plots-pre.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/show/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/show.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/showGeomTooltip/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/show-geom-tooltip.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/showGeomViewer/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/show-geom-viewer.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/toXML/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/to-x-m-l.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/toXML/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/to-x-m-l.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/toXMLFile/#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/to-x-m-l-file.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/toXMLFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/to-x-m-l-file.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/updateComparisonViewHint/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/update-comparison-view-hint.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/updateGeomViewerHint/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/update-geom-viewer-hint.md -$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/updateThumbHint/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/update-thumb-hint.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/index.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/DataHistory/#long#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/-data-history.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/DataHistory/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/-data-history.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/addVariable/#com.phoenix_int.ModelCenter.DHVariable/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/add-variable.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/addVariableStructs/#com.phoenix_int.ModelCenter.DataHistoryVariableStruct[]#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/add-variable-structs.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/createVariable/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/create-variable.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/deleteRun/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/delete-run.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/deleteVariable/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/delete-variable.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/deleteVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/delete-variable.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/endRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/end-runs.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/fromXML/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/from-x-m-l.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/fromXMLFile/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/from-x-m-l-file.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getCenterLinkJobConnector/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-job-connector.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getCenterLinkQueue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-queue.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getCenterLinkRunMatrixID/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-run-matrix-i-d.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getCenterLinkServer/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-server.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getCompletedRunData/#int#int#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-completed-run-data.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getDataExplorer/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-data-explorer.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getDataHistoryToModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-data-history-to-model.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getErrorID/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-error-i-d.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getErrorMessage/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-error-message.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getFormattedValue/#int#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-formatted-value.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getFormattedValue/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-formatted-value.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getHighlightedRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-highlighted-runs.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getNumCustomVars/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-custom-vars.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getNumDesignVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-design-variables.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getNumExpectedRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-expected-runs.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getNumFailedRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-failed-runs.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getNumNonEmptyRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-non-empty-runs.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getNumRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-runs.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getNumVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-variables.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getRunName/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-run-name.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getSettingRun/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-setting-run.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getSuggestedCountFrom/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-count-from.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getSuggestedDependentVars/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-dependent-vars.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getSuggestedIndependantVar/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-independant-var.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getSuggestedIndependentVar/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-independent-var.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getUniqueID/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-unique-i-d.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getValue/#int#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getValue/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getVariable/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-variable.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-variable.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getVariableValues/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-variable-values.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getVariableValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-variable-values.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/highlight/#long#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/highlight.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/insertRun/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/insert-run.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/isHighlighted/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/is-highlighted.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/isModified/#int#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/is-modified.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/isModified/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/is-modified.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/isRunning/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/is-running.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/isValid/#int#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/is-valid.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/isValid/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/is-valid.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/newInstance/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/new-instance.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setDataHistoryToModel/#com.phoenix_int.ModelCenter.IDataHistoryToModel/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-data-history-to-model.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setError/#long#long#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-error.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setFormattedResult/#int#long#java.lang.String#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-formatted-result.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setFormattedResult/#java.lang.String#long#java.lang.String#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-formatted-result.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setHighlightedRuns/#long[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-highlighted-runs.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setNumExpectedRuns/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-num-expected-runs.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setResult/#int#long#java.lang.Object#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-result.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setResult/#java.lang.String#long#java.lang.Object#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-result.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setRunName/#long#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-run-name.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setRunValues/#long#java.lang.Object[]#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-run-values.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setSettingRun/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-setting-run.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setSuggestedCountFrom/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-count-from.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setSuggestedDependentVars/#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-dependent-vars.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setSuggestedIndependantVar/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-independant-var.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setSuggestedIndependentVar/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-independent-var.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setVariableValues/#int#long#java.lang.Object[]#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-variable-values.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setVariableValues/#java.lang.String#long#java.lang.Object[]#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-variable-values.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/startRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/start-runs.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/toCSV/#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/to-c-s-v.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/toCSVFile/#java.lang.String#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/to-c-s-v-file.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/toXML/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/to-x-m-l.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/toXML/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/to-x-m-l.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/toXMLFile/#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/to-x-m-l-file.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistory/toXMLFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/to-x-m-l-file.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/index.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/DataHistoryVariableMetadataStruct/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/-data-history-variable-metadata-struct.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/customMetadata/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/custom-metadata.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/enumAliases/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/enum-aliases.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/enumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/equation/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/equation.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/fileName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/file-name.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/format/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/format.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/geomScript/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/geom-script.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/getCustomMetadataNames/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/get-custom-metadata-names.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/isBinary/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-binary.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/isDesignVar/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-design-var.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/isInput/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-input.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/isNumeric/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-numeric.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/lowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/name/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/name.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/type/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/type.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/units/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/units.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/upperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableStruct///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/index.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableStruct/DataHistoryVariableStruct/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/-data-history-variable-struct.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableStruct/index/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/--index--.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableStruct/isModified/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/is-modified.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableStruct/isValid/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/is-valid.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableStruct/metadata/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/metadata.md -$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableStruct/varValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/var-value.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/index.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/addItem/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/add-item.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/addUnlinkedItem/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/add-unlinked-item.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getAutoDelete/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-auto-delete.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getColWidth/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-col-width.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getDisplayFullNames/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-display-full-names.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getDisplayUnits/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-display-units.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getHeight/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-height.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getLink/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-link.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getName/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-name.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getTitle/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-title.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getWidth/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-width.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getX/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-x.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-y.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/isRenamed/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/is-renamed.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/isValid/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/is-valid.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/removeItem/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/remove-item.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/removeLink/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/remove-link.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/setAutoDelete/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-auto-delete.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/setColWidth/#long#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-col-width.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/setDisplayFullNames/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-display-full-names.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/setDisplayUnits/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-display-units.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/setLink/#long#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-link.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/setLocation/#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-location.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/setName/#long#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-name.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/setSize/#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-size.md -$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/setTitle/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-title.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/index.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/clearLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/clear-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/clearUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/clear-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/fromFormattedString/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/from-formatted-string.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-description.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getEnumAliases/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-enum-aliases.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getFormat/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-format.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getUnits/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-units.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/hasLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/has-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/hasUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/has-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-description.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setEnumAliases/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-enum-aliases.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setFormat/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-format.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setLowerBound/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setUnits/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-units.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setUpperBound/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/toFormattedString/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/to-formatted-string.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/toFormattedStringAbsolute/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/to-formatted-string-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/index.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/clearLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/clear-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/clearUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/clear-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/fromFormattedString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/from-formatted-string.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-description.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/getEnumAliases/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-enum-aliases.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/getEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/getFormat/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-format.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/getLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/getUnits/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-units.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/getUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/getValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/getValueAbsolute/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/hasLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/has-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/hasUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/has-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-description.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/setEnumAliases/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-enum-aliases.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/setEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/setFormat/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-format.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/setLowerBound/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/setUnits/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-units.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/setUpperBound/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/setValue/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/toFormattedString/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/to-formatted-string.md -$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/toFormattedStringAbsolute/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/to-formatted-string-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/Feature///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-feature/index.md -$dokka.location:com.phoenix_int.ModelCenter/Feature/checkin/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-feature/checkin.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/index.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/getDescription/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-description.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/getIsBinary/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-is-binary.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/getSaveWithModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-save-with-model.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-description.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/setIsBinary/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-is-binary.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/setSaveWithModel/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-save-with-model.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/FileSystemInfo///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-system-info/index.md -$dokka.location:com.phoenix_int.ModelCenter/FileSystemInfo/getBaseName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-base-name.md -$dokka.location:com.phoenix_int.ModelCenter/FileSystemInfo/getExists/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-exists.md -$dokka.location:com.phoenix_int.ModelCenter/FileSystemInfo/getIsValid/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-is-valid.md -$dokka.location:com.phoenix_int.ModelCenter/FileSystemInfo/getIsWritable/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-is-writable.md -$dokka.location:com.phoenix_int.ModelCenter/FileSystemInfo/getUrl/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-url.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/index.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable/fromFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/from-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-description.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable/getDirectTransfer/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-direct-transfer.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable/getFileExtension/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable/getIsBinary/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-is-binary.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable/getSaveWithModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-save-with-model.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable/readFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/read-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-description.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable/setDirectTransfer/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-direct-transfer.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable/setFileExtension/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable/setIsBinary/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-is-binary.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable/setSaveWithModel/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-save-with-model.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable/toFile/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/to-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable/toFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/to-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable/toFileAbsolute/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/to-file-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable/toFileAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/to-file-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable/writeFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/write-file.md -$dokka.location:com.phoenix_int.ModelCenter/FileVariable/writeFileAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/write-file-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/Format///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/index.md -$dokka.location:com.phoenix_int.ModelCenter/Format/doubleToEditableString/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/double-to-editable-string.md -$dokka.location:com.phoenix_int.ModelCenter/Format/doubleToString/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/double-to-string.md -$dokka.location:com.phoenix_int.ModelCenter/Format/getFormat/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/get-format.md -$dokka.location:com.phoenix_int.ModelCenter/Format/longToEditableString/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/long-to-editable-string.md -$dokka.location:com.phoenix_int.ModelCenter/Format/longToString/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/long-to-string.md -$dokka.location:com.phoenix_int.ModelCenter/Format/setFormat/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/set-format.md -$dokka.location:com.phoenix_int.ModelCenter/Format/stringToDouble/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/string-to-double.md -$dokka.location:com.phoenix_int.ModelCenter/Format/stringToLong/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/string-to-long.md -$dokka.location:com.phoenix_int.ModelCenter/Format/stringToString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/string-to-string.md -$dokka.location:com.phoenix_int.ModelCenter/Format2///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/index.md -$dokka.location:com.phoenix_int.ModelCenter/Format2/Format2/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/-format2.md -$dokka.location:com.phoenix_int.ModelCenter/Format2/Format2/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/-format2.md -$dokka.location:com.phoenix_int.ModelCenter/Format2/_setFormat/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/_set-format.md -$dokka.location:com.phoenix_int.ModelCenter/Format2/doubleToEditableString/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/double-to-editable-string.md -$dokka.location:com.phoenix_int.ModelCenter/Format2/doubleToString/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/double-to-string.md -$dokka.location:com.phoenix_int.ModelCenter/Format2/longToEditableString/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/long-to-editable-string.md -$dokka.location:com.phoenix_int.ModelCenter/Format2/longToString/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/long-to-string.md -$dokka.location:com.phoenix_int.ModelCenter/Format2/stringToDouble/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/string-to-double.md -$dokka.location:com.phoenix_int.ModelCenter/Format2/stringToLong/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/string-to-long.md -$dokka.location:com.phoenix_int.ModelCenter/Format2/stringToString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/string-to-string.md -$dokka.location:com.phoenix_int.ModelCenter/GeometryVariable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/index.md -$dokka.location:com.phoenix_int.ModelCenter/GeometryVariable/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/get-description.md -$dokka.location:com.phoenix_int.ModelCenter/GeometryVariable/getValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/GeometryVariable/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/set-description.md -$dokka.location:com.phoenix_int.ModelCenter/GeometryVariable/setValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/index.md -$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters/getCount/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/get-count.md -$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters/getValue/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters/getValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters/remove/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/remove.md -$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters/remove/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/remove.md -$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters/setExportToRemoteComponents/#int#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/set-export-to-remote-components.md -$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters/setExportToRemoteComponents/#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/set-export-to-remote-components.md -$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters/setValue/#int#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters/setValue/#java.lang.String#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/Group///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/index.md -$dokka.location:com.phoenix_int.ModelCenter/Group/getFullName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/get-full-name.md -$dokka.location:com.phoenix_int.ModelCenter/Group/getGroup/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/get-group.md -$dokka.location:com.phoenix_int.ModelCenter/Group/getGroup/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/get-group.md -$dokka.location:com.phoenix_int.ModelCenter/Group/getIconID/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/get-icon-i-d.md -$dokka.location:com.phoenix_int.ModelCenter/Group/getName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/get-name.md -$dokka.location:com.phoenix_int.ModelCenter/Group/getNumGroups/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/get-num-groups.md -$dokka.location:com.phoenix_int.ModelCenter/Group/getNumVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/get-num-variables.md -$dokka.location:com.phoenix_int.ModelCenter/Group/getVariable/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/get-variable.md -$dokka.location:com.phoenix_int.ModelCenter/Group/getVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/get-variable.md -$dokka.location:com.phoenix_int.ModelCenter/Group/setIconID/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/set-icon-i-d.md -$dokka.location:com.phoenix_int.ModelCenter/IComponentPlugIn///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/index.md -$dokka.location:com.phoenix_int.ModelCenter/IComponentPlugIn/construct/#com.phoenix_int.ModelCenter.ModelCenter#com.phoenix_int.ModelCenter.AddToModel/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/construct.md -$dokka.location:com.phoenix_int.ModelCenter/IComponentPlugIn/fromString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/from-string.md -$dokka.location:com.phoenix_int.ModelCenter/IComponentPlugIn/onEnd/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/on-end.md -$dokka.location:com.phoenix_int.ModelCenter/IComponentPlugIn/run/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/run.md -$dokka.location:com.phoenix_int.ModelCenter/IComponentPlugIn/show/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/show.md -$dokka.location:com.phoenix_int.ModelCenter/IDataCollectorPlugIn///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/index.md -$dokka.location:com.phoenix_int.ModelCenter/IDataCollectorPlugIn/construct/#com.phoenix_int.ModelCenter.ModelCenter#com.phoenix_int.ModelCenter.AddToModel#com.phoenix_int.ModelCenter.DataCollector/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/construct.md -$dokka.location:com.phoenix_int.ModelCenter/IDataCollectorPlugIn/fromString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/from-string.md -$dokka.location:com.phoenix_int.ModelCenter/IDataCollectorPlugIn/show/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/show.md -$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/index.md -$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/construct/#long#boolean#javax.swing.JFrame#int#com.phoenix_int.ModelCenter.DataHistory#com.phoenix_int.ModelCenter.ModelCenter#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/construct.md -$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/dataChanged/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/data-changed.md -$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/exportImage/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/export-image.md -$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/fromString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/from-string.md -$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/getPageTitle/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/get-page-title.md -$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/getRequiredLicense/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/get-required-license.md -$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/getThumbnail/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/get-thumbnail.md -$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/invokeMenuItem/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/invoke-menu-item.md -$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/onEnd/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/on-end.md -$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/progressMeterStop/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/progress-meter-stop.md -$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/variablesChanged/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/variables-changed.md -$dokka.location:com.phoenix_int.ModelCenter/IDataHistoryToModel///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/index.md -$dokka.location:com.phoenix_int.ModelCenter/IDataHistoryToModel/canRerunRuns/#com.phoenix_int.ModelCenter.DataHistory#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/can-rerun-runs.md -$dokka.location:com.phoenix_int.ModelCenter/IDataHistoryToModel/canSaveToModel/#com.phoenix_int.ModelCenter.DataHistory#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/can-save-to-model.md -$dokka.location:com.phoenix_int.ModelCenter/IDataHistoryToModel/closeDataHistory/#com.phoenix_int.ModelCenter.DataHistory/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/close-data-history.md -$dokka.location:com.phoenix_int.ModelCenter/IDataHistoryToModel/rerunRuns/#com.phoenix_int.ModelCenter.DataHistory#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/rerun-runs.md -$dokka.location:com.phoenix_int.ModelCenter/IDataHistoryToModel/saveToModel/#com.phoenix_int.ModelCenter.DataHistory#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/save-to-model.md -$dokka.location:com.phoenix_int.ModelCenter/IHolder///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-holder/index.md -$dokka.location:com.phoenix_int.ModelCenter/IHolder/getFullName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-holder/get-full-name.md -$dokka.location:com.phoenix_int.ModelCenter/IHolder/getName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-holder/get-name.md -$dokka.location:com.phoenix_int.ModelCenter/ILoginCallback///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/index.md -$dokka.location:com.phoenix_int.ModelCenter/ILoginCallback/loginSucceeded/#java.lang.String#java.lang.String#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/login-succeeded.md -$dokka.location:com.phoenix_int.ModelCenter/ILoginCallback/requestAuthCredentials/#java.lang.String#boolean#com.phoenix_int.ModelCenter.util.ValueHolder#com.phoenix_int.ModelCenter.util.ValueHolder#com.phoenix_int.ModelCenter.util.ValueHolder/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/request-auth-credentials.md -$dokka.location:com.phoenix_int.ModelCenter/ILoginCallback/verifySslWarning/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/verify-ssl-warning.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/index.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/HTMLViewerWaitForClose/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/-h-t-m-l-viewer-wait-for-close.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/MessageBox/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/-message-box.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/addIcon/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/add-icon.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/addNewMacro/#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/add-new-macro.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/autoLink/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/auto-link.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/breakLink/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/break-link.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/checkout/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/checkout.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/checkout2/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/checkout2.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/closeHTMLViewer/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/close-h-t-m-l-viewer.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/closeModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/close-model.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createAndInitComponent/#java.lang.String#java.lang.String#java.lang.String#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-and-init-component.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createAssembly/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-assembly.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createAssembly/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-assembly.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createAssemblyVariable/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-assembly-variable.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createComponent/#java.lang.String#java.lang.String#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-component.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createComponent/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-component.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createDataCollector/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-collector.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createDataExplorer/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-explorer.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createDataHistoryVariable/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-history-variable.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createDataMonitor/#java.lang.String#java.lang.String#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-monitor.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createJobManager/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-job-manager.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createJobManager/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-job-manager.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createJobManager/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-job-manager.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createLink/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-link.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createPlugInFrame/#java.lang.String#java.lang.String#java.lang.String#long#java.awt.Container#boolean#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-plug-in-frame.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createPlugInFrame/#java.lang.String#java.lang.String#java.lang.String#long#java.awt.Container#boolean#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-plug-in-frame.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createPlugInFrame/#java.lang.String#java.lang.String#java.lang.String#long#java.awt.Container#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-plug-in-frame.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createPlugInFrame/#java.lang.String#java.lang.String#java.lang.String#long#java.awt.Container/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-plug-in-frame.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createTradeStudy/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-trade-study.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/destroyPlugInFrame/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/destroy-plug-in-frame.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/dumpComDebug/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/dump-com-debug.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getActiveJobManager/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-active-job-manager.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getAppName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-app-name.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getAssembly/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-assembly.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getAssemblyStyle/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-assembly-style.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getComponent/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-component.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getDataCollector/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-collector.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getDataCollectorForDataExplorer/#com.phoenix_int.ModelCenter.DataExplorer/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-collector-for-data-explorer.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getDataExplorer/#com.phoenix_int.ModelCenter.Variant/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-explorer.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getDataMonitor/#java.lang.String#com.phoenix_int.ModelCenter.Variant/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-monitor.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getFileSystemInfo/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-file-system-info.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getFormatter/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-formatter.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getFrame/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-frame.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getGlobalParameters/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-global-parameters.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getHaltStatus/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-halt-status.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getIsInteractive/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-is-interactive.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getLastErrorMessage/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-last-error-message.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getLicensingPath/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-licensing-path.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getLinks/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-links.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getLogger/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-logger.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getMacroScript/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-macro-script.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getMacroScriptLanguage/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-macro-script-language.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getModelCenterPath/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model-center-path.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getModelDirectory/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model-directory.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getModelFileName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model-file-name.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getPreference/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-preference.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getProcessID/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-process-i-d.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getRunOnlyMode/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-run-only-mode.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getScreenUpdating/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-screen-updating.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getTradeStudyFilters/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-trade-study-filters.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-variable.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getVariableMetaData/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-variable-meta-data.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getVersion/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-version.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/guiCloseAllMultiplexers/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/gui-close-all-multiplexers.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/guiLoadFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/gui-load-file.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/guiSaveModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/gui-save-model.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/halt/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/halt.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/hidePlugInFrame/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/hide-plug-in-frame.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/internalLicensing/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/internal-licensing.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/invokeHelp/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/invoke-help.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/isOkToClose/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/is-ok-to-close.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/launchDataCollectorPlugIn/#java.lang.String#com.phoenix_int.ModelCenter.DataExplorer/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-data-collector-plug-in.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/launchHTMLViewer/#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-h-t-m-l-viewer.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/launchMacroEditor/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-macro-editor.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/launchTradeStudy/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-trade-study.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/loadFile/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/load-file.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/loadFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/load-file.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/loadModel/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/load-model.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/loadModel/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/load-model.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/moveComponent/#java.lang.String#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/move-component.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/newInstance/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/new-instance.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/newModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/new-model.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/newModel/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/new-model.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/parallelInstance/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/parallel-instance.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/release/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/release.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/removeComponent/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/remove-component.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/removeDataMonitor/#java.lang.String#com.phoenix_int.ModelCenter.Variant/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/remove-data-monitor.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/run/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/runAntFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run-ant-file.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/runMacro/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run-macro.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/runMacro2/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run-macro2.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/saveModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-model.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/saveModelAs/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-model-as.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/saveTradeStudy/#java.lang.String#int#com.phoenix_int.ModelCenter.DataExplorer/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-trade-study.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/saveVersionedModel/#com.phoenix_int.ModelCenter.ModelCenter.VersionStatus#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-versioned-model.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/saveVersionedModelAs/#java.lang.String#com.phoenix_int.ModelCenter.ModelCenter.VersionStatus#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-versioned-model-as.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setAssemblyStyle/#java.lang.String#com.phoenix_int.ModelCenter.ModelCenter.AssemblyStyle#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-assembly-style.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setAssemblyStyle/#java.lang.String#com.phoenix_int.ModelCenter.ModelCenter.AssemblyStyle/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-assembly-style.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setIconPlugInFrame/#long#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-icon-plug-in-frame.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setLoginCallback/#com.phoenix_int.ModelCenter.ILoginCallback/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-login-callback.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setMacroScript/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-macro-script.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setMacroScriptLanguage/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-macro-script-language.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setPassword/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-password.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setPreference/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-preference.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setRunOnlyMode/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-run-only-mode.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setScheduler/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-scheduler.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setScreenUpdating/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-screen-updating.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setUserName/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-user-name.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setValue/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/showFileBrowseDialog/#java.lang.String#java.lang.String[]#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-file-browse-dialog.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/showFileBrowseDialog/#java.lang.String#java.lang.String[]#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-file-browse-dialog.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/showFileSaveDialog/#java.lang.String#com.phoenix_int.ModelCenter.util.ValueHolder#java.lang.String#java.lang.String[]#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-file-save-dialog.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/showPlugInFrame/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-plug-in-frame.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/startGUIMode/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/start-g-u-i-mode.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/tradeStudyEnd/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/trade-study-end.md -$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/tradeStudyStart/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/trade-study-start.md -$dokka.location:com.phoenix_int.ModelCenter/IPlugInMetaData///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/index.md -$dokka.location:com.phoenix_int.ModelCenter/IPlugInMetaData/getAuthor/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-author.md -$dokka.location:com.phoenix_int.ModelCenter/IPlugInMetaData/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-description.md -$dokka.location:com.phoenix_int.ModelCenter/IPlugInMetaData/getHelpURL/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-help-u-r-l.md -$dokka.location:com.phoenix_int.ModelCenter/IPlugInMetaData/getIconLocation/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-icon-location.md -$dokka.location:com.phoenix_int.ModelCenter/IPlugInMetaData/getKeywords/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-keywords.md -$dokka.location:com.phoenix_int.ModelCenter/IPlugInMetaData/getVersion/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-version.md -$dokka.location:com.phoenix_int.ModelCenter/IRunDataAction///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/index.md -$dokka.location:com.phoenix_int.ModelCenter/IRunDataAction/getComparisonInfoHTMLString/#long[]#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/get-comparison-info-h-t-m-l-string.md -$dokka.location:com.phoenix_int.ModelCenter/IRunDataAction/getRunInfoHTMLString/#long#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/get-run-info-h-t-m-l-string.md -$dokka.location:com.phoenix_int.ModelCenter/IRunDataAction/passHTMLEvent/#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/pass-h-t-m-l-event.md -$dokka.location:com.phoenix_int.ModelCenter/IRunDataAction/updateHighlight/#long#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/update-highlight.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobInfo///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/index.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobInfo/getNumRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-num-runs.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobInfo/getNumVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-num-variables.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobInfo/getVariableDisplayName/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-variable-display-name.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobInfo/getVariableEquation/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-variable-equation.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobInfo/isDesignVariable/#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/is-design-variable.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobInfo/isInput/#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/is-input.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/index.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/addVariable/#java.lang.String#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/add-variable.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/canNewJob/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/can-new-job.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/clear/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/clear.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/getDataHistory/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-data-history.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/getMetaDataProvider/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-meta-data-provider.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/getNumThreads/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-num-threads.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/getRunInParallel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-run-in-parallel.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/getSupportsParallelExecution/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-supports-parallel-execution.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/getValidateAll/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-validate-all.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/newJob/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/new-job.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/runJobAsync/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/run-job-async.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/setDataHistory/#com.phoenix_int.ModelCenter.DataHistory/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-data-history.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/setInput/#int#java.lang.Object#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-input.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/setNumThreads/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-num-threads.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/setRunInParallel/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-run-in-parallel.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/setRunInputs/#int#java.lang.Object[]#java.lang.Object[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-run-inputs.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/setValidateAll/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-validate-all.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/setVariableInputs/#java.lang.Object#java.lang.Object[]#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-variable-inputs.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobResult///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/index.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobResult/cancelAsync/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/cancel-async.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobResult/getDataHistory/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/get-data-history.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobResult/isCanceled/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/is-canceled.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobResult/isRunning/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/is-running.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobResult/waitForCompletion/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/wait-for-completion.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyCallback///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/index.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyCallback/dataCollectorCreated/#com.phoenix_int.ModelCenter.TradeStudy2#com.phoenix_int.ModelCenter.DataCollector/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/data-collector-created.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyCallback/runEnded/#com.phoenix_int.ModelCenter.TradeStudy2/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/run-ended.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyCallback/runStarting/#com.phoenix_int.ModelCenter.TradeStudy2/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/run-starting.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyCallback/tradeStudyClosed/#com.phoenix_int.ModelCenter.TradeStudy2/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/trade-study-closed.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/index.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn/construct/#com.phoenix_int.ModelCenter.ModelCenter#com.phoenix_int.ModelCenter.AddToModel/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/construct.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn/fromString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/from-string.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn/show/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/show.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn2///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/index.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn2/addAnalyzerVariable/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/add-analyzer-variable.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn2/clearAnalyzerVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/clear-analyzer-variables.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn2/getSaveAllAnalyzerVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/get-save-all-analyzer-variables.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn2/getTradeStudyCallback/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/get-trade-study-callback.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn2/onEnd/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/on-end.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn2/setSaveAllAnalyzerVariables/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/set-save-all-analyzer-variables.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn2/setTradeStudyCallback/#com.phoenix_int.ModelCenter.ITradeStudyCallback/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/set-trade-study-callback.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn3///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in3/index.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn3/getJobManager/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in3/get-job-manager.md -$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn3/setJobManager/#com.phoenix_int.ModelCenter.ITradeStudy3JobManager/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in3/set-job-manager.md -$dokka.location:com.phoenix_int.ModelCenter/IVariableHolder///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/index.md -$dokka.location:com.phoenix_int.ModelCenter/IVariableHolder/getGroup/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-group.md -$dokka.location:com.phoenix_int.ModelCenter/IVariableHolder/getGroup/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-group.md -$dokka.location:com.phoenix_int.ModelCenter/IVariableHolder/getNumGroups/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-num-groups.md -$dokka.location:com.phoenix_int.ModelCenter/IVariableHolder/getNumVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-num-variables.md -$dokka.location:com.phoenix_int.ModelCenter/IVariableHolder/getVariable/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-variable.md -$dokka.location:com.phoenix_int.ModelCenter/IVariableHolder/getVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-variable.md -$dokka.location:com.phoenix_int.ModelCenter/IVariableMetaDataProvider///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-meta-data-provider/index.md -$dokka.location:com.phoenix_int.ModelCenter/IVariableMetaDataProvider/getAllVariableMetaData/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-meta-data-provider/get-all-variable-meta-data.md -$dokka.location:com.phoenix_int.ModelCenter/IVariableMetaDataProvider/getVariableMetaData/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-meta-data-provider/get-variable-meta-data.md -$dokka.location:com.phoenix_int.ModelCenter/IfComponent///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/index.md -$dokka.location:com.phoenix_int.ModelCenter/IfComponent/getBranchCondition/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/get-branch-condition.md -$dokka.location:com.phoenix_int.ModelCenter/IfComponent/getBranchName/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/get-branch-name.md -$dokka.location:com.phoenix_int.ModelCenter/IfComponent/getExclusive/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/get-exclusive.md -$dokka.location:com.phoenix_int.ModelCenter/IfComponent/getNumBranches/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/get-num-branches.md -$dokka.location:com.phoenix_int.ModelCenter/IfComponent/getRunLastBranchByDefault/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/get-run-last-branch-by-default.md -$dokka.location:com.phoenix_int.ModelCenter/IfComponent/renameBranch/#int#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/rename-branch.md -$dokka.location:com.phoenix_int.ModelCenter/IfComponent/setBranchCondition/#int#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/set-branch-condition.md -$dokka.location:com.phoenix_int.ModelCenter/IfComponent/setExclusive/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/set-exclusive.md -$dokka.location:com.phoenix_int.ModelCenter/IfComponent/setRunLastBranchByDefault/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/set-run-last-branch-by-default.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/index.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/clearLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/clear-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/clearUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/clear-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/fromFormattedString/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/from-formatted-string.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-description.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getEnumAliases/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-enum-aliases.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getFormat/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-format.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getUnits/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-units.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/hasLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/has-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/hasUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/has-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-description.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setEnumAliases/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-enum-aliases.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setFormat/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-format.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setLowerBound/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setUnits/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-units.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setUpperBound/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/toFormattedString/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/to-formatted-string.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/toFormattedStringAbsolute/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/to-formatted-string-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/index.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/clearLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/clear-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/clearUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/clear-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/fromFormattedString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/from-formatted-string.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-description.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/getEnumAliases/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-enum-aliases.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/getEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/getFormat/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-format.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/getLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/getUnits/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-units.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/getUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/getValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/getValueAbsolute/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/hasLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/has-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/hasUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/has-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-description.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/setEnumAliases/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-enum-aliases.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/setEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/setFormat/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-format.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/setLowerBound/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/setUnits/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-units.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/setUpperBound/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/setValue/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/toFormattedString/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/to-formatted-string.md -$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/toFormattedStringAbsolute/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/to-formatted-string-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/JavaObjectRepository///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/index.md -$dokka.location:com.phoenix_int.ModelCenter/JavaObjectRepository/JavaObjectRepository/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/-java-object-repository.md -$dokka.location:com.phoenix_int.ModelCenter/JavaObjectRepository/get/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/get.md -$dokka.location:com.phoenix_int.ModelCenter/JavaObjectRepository/getRunDataAction/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/get-run-data-action.md -$dokka.location:com.phoenix_int.ModelCenter/JavaObjectRepository/put/#java.lang.String#java.lang.Object#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/put.md -$dokka.location:com.phoenix_int.ModelCenter/JavaObjectRepository/release/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/release.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/index.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/addInput/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/add-input.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/addOutput/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/add-output.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/addRerun/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/add-rerun.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/clearCache/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/clear-cache.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/enableCache/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/enable-cache.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/getInput/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-input.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/getInputLabel/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-input-label.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/getNumInputs/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-inputs.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/getNumOutputs/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-outputs.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/getNumRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-runs.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/getNumThreads/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-threads.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/getOutput/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-output.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/getOutputLabel/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-output-label.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/getRunInParallel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-run-in-parallel.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/getRunIndex/#java.lang.String[]#java.lang.String[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-run-index.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/getValidateAll/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-validate-all.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/halt/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/halt.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/resume/#com.phoenix_int.ModelCenter.DataHistory/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/resume.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/setCustomMetadata/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-custom-metadata.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/setInput/#long#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-input.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/setNumRuns/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-num-runs.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/setNumThreads/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-num-threads.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/setRunInParallel/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-run-in-parallel.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/setValidateAll/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-validate-all.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/submit/#com.phoenix_int.ModelCenter.DataCollector#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/submit/#com.phoenix_int.ModelCenter.DataCollector#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/submit/#com.phoenix_int.ModelCenter.DataCollector/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/submit/#com.phoenix_int.ModelCenter.DataExplorer#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/submit/#com.phoenix_int.ModelCenter.DataExplorer#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/submit/#com.phoenix_int.ModelCenter.DataExplorer/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/submit/#com.phoenix_int.ModelCenter.DataHistory#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/submit/#com.phoenix_int.ModelCenter.DataHistory#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/submit/#com.phoenix_int.ModelCenter.DataHistory/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md -$dokka.location:com.phoenix_int.ModelCenter/JobManager/waitForJobCompletion/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/wait-for-job-completion.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyle.AutoNSquared///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-auto-n-squared/index.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyle.Classic///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-classic/index.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyle.Collapsed///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-collapsed/index.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyle.Expanded///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-expanded/index.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyle.NSquared///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-n-squared/index.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyle///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/index.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyle/valueOf/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/value-of.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyle/values/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/values.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyleInfo///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/index.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyleInfo/height/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/height.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyleInfo/style/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/style.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyleInfo/width/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/width.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.VersionStatus.DoNotVersion///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/-do-not-version/index.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.VersionStatus.DoVersioning///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/-do-versioning/index.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.VersionStatus.DoVersioningIfPossible///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/-do-versioning-if-possible/index.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.VersionStatus///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/index.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.VersionStatus/valueOf/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/value-of.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.VersionStatus/values/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/values.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/index.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/ASSEMBLY_TYPE_ASSEMBLY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-a-s-s-e-m-b-l-y.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/ASSEMBLY_TYPE_FOR_EACH/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-f-o-r_-e-a-c-h.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/ASSEMBLY_TYPE_IF/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-i-f.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/ASSEMBLY_TYPE_PARALLEL/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-p-a-r-a-l-l-e-l.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/ASSEMBLY_TYPE_SEQUENCE/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-s-e-q-u-e-n-c-e.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/CONN_ERR_ERROR/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-c-o-n-n_-e-r-r_-e-r-r-o-r.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/CONN_ERR_IGNORE/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-c-o-n-n_-e-r-r_-i-g-n-o-r-e.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/CONN_ERR_USEDIALOG/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-c-o-n-n_-e-r-r_-u-s-e-d-i-a-l-o-g.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/HTMLViewerWaitForClose/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-h-t-m-l-viewer-wait-for-close.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/MODEL_TYPE_DATA/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-m-o-d-e-l_-t-y-p-e_-d-a-t-a.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/MODEL_TYPE_PROCESS/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-m-o-d-e-l_-t-y-p-e_-p-r-o-c-e-s-s.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/MessageBox/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-message-box.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/ModelCenter/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-model-center.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/ModelCenter/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-model-center.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/ModelCenter/#long#javax.swing.JFrame#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-model-center.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/ModelCenter/#long#javax.swing.JFrame/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-model-center.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/addIcon/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/add-icon.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/addNewMacro/#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/add-new-macro.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/allowBringWindowToFront/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/allow-bring-window-to-front.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/autoLink/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/auto-link.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/breakLink/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/break-link.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/checkout/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/checkout.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/checkout2/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/checkout2.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/close/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/close.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/closeHTMLViewer/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/close-h-t-m-l-viewer.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/closeModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/close-model.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createAndInitComponent/#java.lang.String#java.lang.String#java.lang.String#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-and-init-component.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createAssembly/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-assembly.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createAssembly/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-assembly.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createAssemblyVariable/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-assembly-variable.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createComponent/#java.lang.String#java.lang.String#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-component.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createComponent/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-component.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createDataCollector/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-collector.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createDataExplorer/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-explorer.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createDataHistoryVariable/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-history-variable.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createDataMonitor/#java.lang.String#java.lang.String#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-monitor.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createJobManager/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-job-manager.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createJobManager/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-job-manager.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createJobManager/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-job-manager.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createLink/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-link.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createPlugInFrame/#java.lang.String#java.lang.String#java.lang.String#long#java.awt.Container#boolean#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-plug-in-frame.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createPlugInFrame/#java.lang.String#java.lang.String#java.lang.String#long#java.awt.Container#boolean#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-plug-in-frame.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createPlugInFrame/#java.lang.String#java.lang.String#java.lang.String#long#java.awt.Container#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-plug-in-frame.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createPlugInFrame/#java.lang.String#java.lang.String#java.lang.String#long#java.awt.Container/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-plug-in-frame.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createTradeStudy/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-trade-study.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/destroyPlugInFrame/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/destroy-plug-in-frame.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/dumpComDebug/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/dump-com-debug.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getActiveJobManager/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-active-job-manager.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getAppName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-app-name.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getAssembly/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-assembly.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getAssemblyStyle/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-assembly-style.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getComponent/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-component.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getDataCollector/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-collector.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getDataCollectorForDataExplorer/#com.phoenix_int.ModelCenter.DataExplorer/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-collector-for-data-explorer.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getDataExplorer/#com.phoenix_int.ModelCenter.Variant/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-explorer.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getDataMonitor/#java.lang.String#com.phoenix_int.ModelCenter.Variant/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-monitor.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getFileSystemInfo/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-file-system-info.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getFormatter/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-formatter.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getFrame/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-frame.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getGlobalParameters/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-global-parameters.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getHaltStatus/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-halt-status.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getIsInteractive/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-is-interactive.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getLastErrorMessage/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-last-error-message.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getLicensingPath/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-licensing-path.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getLinks/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-links.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getLogger/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-logger.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getMacroScript/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-macro-script.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getMacroScriptLanguage/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-macro-script-language.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getMacroTimeout/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-macro-timeout.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getModelCenterPath/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model-center-path.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getModelDirectory/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model-directory.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getModelFileName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model-file-name.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getPreference/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-preference.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getProcessID/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-process-i-d.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getRunOnlyMode/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-run-only-mode.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getScreenUpdating/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-screen-updating.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getTradeStudyFilters/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-trade-study-filters.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-variable.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getVariableMetaData/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-variable-meta-data.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getVersion/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-version.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getXMLExtension/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-x-m-l-extension.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/guiCloseAllMultiplexers/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/gui-close-all-multiplexers.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/guiLoadFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/gui-load-file.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/guiSaveModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/gui-save-model.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/halt/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/halt.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/hidePlugInFrame/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/hide-plug-in-frame.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/internalLicensing/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/internal-licensing.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/invokeHelp/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/invoke-help.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/isOkToClose/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/is-ok-to-close.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/launchDataCollectorPlugIn/#java.lang.String#com.phoenix_int.ModelCenter.DataExplorer/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-data-collector-plug-in.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/launchHTMLViewer/#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-h-t-m-l-viewer.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/launchMacroEditor/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-macro-editor.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/launchTradeStudy/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-trade-study.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/loadFile/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/load-file.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/loadFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/load-file.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/loadModel/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/load-model.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/loadModel/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/load-model.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/moveComponent/#java.lang.String#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/move-component.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/newInstance/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/new-instance.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/newModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/new-model.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/newModel/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/new-model.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/parallelInstance/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/parallel-instance.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/removeComponent/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/remove-component.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/removeDataMonitor/#java.lang.String#com.phoenix_int.ModelCenter.Variant/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/remove-data-monitor.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/run/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/run.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/runAntFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/run-ant-file.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/runMacro/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/run-macro.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/runMacro2/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/run-macro2.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/saveModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/save-model.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/saveModelAs/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/save-model-as.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/saveTradeStudy/#java.lang.String#int#com.phoenix_int.ModelCenter.DataExplorer/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/save-trade-study.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/saveVersionedModel/#com.phoenix_int.ModelCenter.ModelCenter.VersionStatus#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/save-versioned-model.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/saveVersionedModelAs/#java.lang.String#com.phoenix_int.ModelCenter.ModelCenter.VersionStatus#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/save-versioned-model-as.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setAssemblyStyle/#java.lang.String#com.phoenix_int.ModelCenter.ModelCenter.AssemblyStyle#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-assembly-style.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setAssemblyStyle/#java.lang.String#com.phoenix_int.ModelCenter.ModelCenter.AssemblyStyle/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-assembly-style.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setIconPlugInFrame/#long#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-icon-plug-in-frame.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setLoginCallback/#com.phoenix_int.ModelCenter.ILoginCallback/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-login-callback.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setMacroScript/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-macro-script.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setMacroScriptLanguage/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-macro-script-language.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setMacroTimeout/#java.lang.String#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-macro-timeout.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setPassword/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-password.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setPreference/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-preference.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setRunOnlyMode/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-run-only-mode.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setScheduler/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-scheduler.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setScreenUpdating/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-screen-updating.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setUserName/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-user-name.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setValue/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setXMLExtension/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-x-m-l-extension.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/showFileBrowseDialog/#java.lang.String#java.lang.String[]#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/show-file-browse-dialog.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/showFileBrowseDialog/#java.lang.String#java.lang.String[]#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/show-file-browse-dialog.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/showFileSaveDialog/#java.lang.String#com.phoenix_int.ModelCenter.util.ValueHolder#java.lang.String#java.lang.String[]#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/show-file-save-dialog.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/showPlugInFrame/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/show-plug-in-frame.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/startGUIMode/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/start-g-u-i-mode.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/tradeStudyEnd/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/trade-study-end.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/tradeStudyStart/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/trade-study-start.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenterException///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center-exception/index.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenterException/ModelCenterException/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center-exception/-model-center-exception.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenterException/ModelCenterException/#java.lang.String#java.lang.Throwable/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center-exception/-model-center-exception.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenterException/ModelCenterException/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center-exception/-model-center-exception.md -$dokka.location:com.phoenix_int.ModelCenter/ModelCenterException/ModelCenterException/#java.lang.Throwable/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center-exception/-model-center-exception.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/index.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/callMethod/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/call-method.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/deleteAllMembers/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/delete-all-members.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/deleteMember/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/delete-member.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/fromFile/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/from-file.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/fromXML/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/from-x-m-l.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getBooleanArrayMemberValue/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-array-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getBooleanArrayMemberValue/#java.lang.String#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-array-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getBooleanArrayMemberValueAbsolute/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-array-member-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getBooleanArrayMemberValueAbsolute/#java.lang.String#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-array-member-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getBooleanMemberValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getBooleanMemberValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-member-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getClassURL/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-class-u-r-l.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-description.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getDoubleArrayMemberValue/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-array-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getDoubleArrayMemberValue/#java.lang.String#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-array-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getDoubleArrayMemberValueAbsolute/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-array-member-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getDoubleArrayMemberValueAbsolute/#java.lang.String#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-array-member-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getDoubleMemberValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getDoubleMemberValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-member-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getFileExtension/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getFileName/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-file-name.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getIndexStr/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-index-str.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getIndexStr/#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-index-str.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getIntArrayMemberValue/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-array-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getIntArrayMemberValue/#java.lang.String#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-array-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getIntArrayMemberValueAbsolute/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-array-member-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getIntArrayMemberValueAbsolute/#java.lang.String#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-array-member-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getIntMemberValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getIntMemberValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-member-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getIsBinary/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-is-binary.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-description.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberDimensions/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberEnumAliases/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-enum-aliases.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberIndex/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-index.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberLength/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-length.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberList/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-list.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberLowerBound/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberNumDimensions/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-num-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberProperty/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-property.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberType/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-type.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberUnits/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-units.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberUpperBound/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberValueAbsoluteAsString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-value-absolute-as-string.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberValueAsString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-value-as-string.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMethodList/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-method-list.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getStringArrayMemberValue/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-array-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getStringArrayMemberValue/#java.lang.String#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-array-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getStringArrayMemberValueAbsolute/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-array-member-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getStringArrayMemberValueAbsolute/#java.lang.String#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-array-member-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getStringMemberValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getStringMemberValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-member-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/hasMember/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/has-member.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/hasMemberLowerBound/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/has-member-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/hasMemberUpperBound/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/has-member-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/isNonStrictType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/is-non-strict-type.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/isNumericMember/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/is-numeric-member.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/reinitialize/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/reinitialize.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setBooleanArrayMemberValue/#java.lang.String#int#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-boolean-array-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setBooleanArrayMemberValue/#java.lang.String#int[]#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-boolean-array-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setBooleanMemberValue/#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-boolean-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-description.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setDoubleArrayMemberValue/#java.lang.String#int#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-double-array-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setDoubleArrayMemberValue/#java.lang.String#int[]#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-double-array-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setDoubleMemberValue/#java.lang.String#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-double-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setFileExtension/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-file-extension.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setFileName/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-file-name.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setIntArrayMemberValue/#java.lang.String#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-int-array-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setIntArrayMemberValue/#java.lang.String#int[]#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-int-array-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setIntMemberValue/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-int-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setIsBinary/#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-is-binary.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDescription/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-description.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberEnumAliases/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-enum-aliases.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberEnumValues/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberFromString/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-from-string.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberLength/#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-length.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberLowerBound/#java.lang.String#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-lower-bound.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberProperty/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-property.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberUnits/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-units.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberUpperBound/#java.lang.String#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-upper-bound.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberValueFromString/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-value-from-string.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setStringArrayMemberValue/#java.lang.String#int#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-string-array-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setStringArrayMemberValue/#java.lang.String#int[]#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-string-array-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setStringMemberValue/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-string-member-value.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/toFile/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/to-file.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/toFileAbsolute/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/to-file-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/toXML/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/to-x-m-l.md -$dokka.location:com.phoenix_int.ModelCenter/PHXJavaComObjectStored///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-p-h-x-java-com-object-stored/index.md -$dokka.location:com.phoenix_int.ModelCenter/PHXJavaComObjectStored/releaseCOMObjects/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-p-h-x-java-com-object-stored/release-c-o-m-objects.md -$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/index.md -$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-description.md -$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/getEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/getIsInput/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-is-input.md -$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/getName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-name.md -$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/getTitle/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-title.md -$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/getType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-type.md -$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-description.md -$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/setEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/setIsInput/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-is-input.md -$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/setTitle/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-title.md -$dokka.location:com.phoenix_int.ModelCenter/RefProp///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/index.md -$dokka.location:com.phoenix_int.ModelCenter/RefProp/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-description.md -$dokka.location:com.phoenix_int.ModelCenter/RefProp/getEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/RefProp/getIsInput/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-is-input.md -$dokka.location:com.phoenix_int.ModelCenter/RefProp/getName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-name.md -$dokka.location:com.phoenix_int.ModelCenter/RefProp/getTitle/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-title.md -$dokka.location:com.phoenix_int.ModelCenter/RefProp/getType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-type.md -$dokka.location:com.phoenix_int.ModelCenter/RefProp/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-description.md -$dokka.location:com.phoenix_int.ModelCenter/RefProp/setEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/RefProp/setIsInput/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-is-input.md -$dokka.location:com.phoenix_int.ModelCenter/RefProp/setTitle/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-title.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/index.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/createRefProp/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/create-ref-prop.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/getNumReferencedVariables/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-num-referenced-variables.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/getRefPropValue/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-ref-prop-value.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/getRefPropValueAbsolute/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-ref-prop-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/getReference/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-reference.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/getReferencedVariable/#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-referenced-variable.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/getReferencedVariable/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-referenced-variable.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/getValue/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/getValueAbsolute/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/setRefPropValue/#java.lang.String#int#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/set-ref-prop-value.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/setReference/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/set-reference.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/setValue/#double#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/index.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/createRefProp/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/create-ref-prop.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/getNumReferencedVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-num-referenced-variables.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/getRefPropValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-ref-prop-value.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/getRefPropValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-ref-prop-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/getReference/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-reference.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/getReferencedVariable/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-referenced-variable.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/getReferencedVariable/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-referenced-variable.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/getValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/setRefPropValue/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/set-ref-prop-value.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/setReference/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/set-reference.md -$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/setValue/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/SaveContext///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-save-context/index.md -$dokka.location:com.phoenix_int.ModelCenter/SaveContext/close/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-save-context/close.md -$dokka.location:com.phoenix_int.ModelCenter/SaveContext/getSaveLocation/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-save-context/get-save-location.md -$dokka.location:com.phoenix_int.ModelCenter/SaveContext/restoreFile/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-save-context/restore-file.md -$dokka.location:com.phoenix_int.ModelCenter/SaveContext/restoreFileStream/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-save-context/restore-file-stream.md -$dokka.location:com.phoenix_int.ModelCenter/SaveContext/saveFile/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-save-context/save-file.md -$dokka.location:com.phoenix_int.ModelCenter/SaveContext/saveFileStream/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-save-context/save-file-stream.md -$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/index.md -$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/addVariable/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/add-variable.md -$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/getForwardSchedule/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/get-forward-schedule.md -$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/getLanguage/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/get-language.md -$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/getPrevalidate/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/get-prevalidate.md -$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/getSourceScript/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/get-source-script.md -$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/getTimeout/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/get-timeout.md -$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/removeVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/remove-variable.md -$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/setForwardSchedule/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/set-forward-schedule.md -$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/setLanguage/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/set-language.md -$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/setPrevalidate/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/set-prevalidate.md -$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/setSourceFromFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/set-source-from-file.md -$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/setSourceFromString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/set-source-from-string.md -$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/setTimeout/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/set-timeout.md -$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/setVariables/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/set-variables.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/index.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-description.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getEnumAliases/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-enum-aliases.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-description.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/setEnumAliases/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-enum-aliases.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/setEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringVariable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/index.md -$dokka.location:com.phoenix_int.ModelCenter/StringVariable/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-description.md -$dokka.location:com.phoenix_int.ModelCenter/StringVariable/getEnumAliases/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-enum-aliases.md -$dokka.location:com.phoenix_int.ModelCenter/StringVariable/getEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/StringVariable/getValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/StringVariable/getValueAbsolute/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-value-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/StringVariable/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-description.md -$dokka.location:com.phoenix_int.ModelCenter/StringVariable/setEnumAliases/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-enum-aliases.md -$dokka.location:com.phoenix_int.ModelCenter/StringVariable/setEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-enum-values.md -$dokka.location:com.phoenix_int.ModelCenter/StringVariable/setValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-value.md -$dokka.location:com.phoenix_int.ModelCenter/TradeStudy///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study/index.md -$dokka.location:com.phoenix_int.ModelCenter/TradeStudy/fromString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study/from-string.md -$dokka.location:com.phoenix_int.ModelCenter/TradeStudy/show/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study/show.md -$dokka.location:com.phoenix_int.ModelCenter/TradeStudy/toString/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study/to-string.md -$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/index.md -$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/addAnalyzerVariable/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/add-analyzer-variable.md -$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/clearAnalyzerVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/clear-analyzer-variables.md -$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/fromString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/from-string.md -$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/getSaveAllAnalyzerVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/get-save-all-analyzer-variables.md -$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/getTradeStudyCallback/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/get-trade-study-callback.md -$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/onEnd/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/on-end.md -$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/setSaveAllAnalyzerVariables/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/set-save-all-analyzer-variables.md -$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/setTradeStudyCallback/#com.phoenix_int.ModelCenter.ITradeStudyCallback/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/set-trade-study-callback.md -$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/show/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/show.md -$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/toString/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/to-string.md -$dokka.location:com.phoenix_int.ModelCenter/TradeStudy3///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study3/index.md -$dokka.location:com.phoenix_int.ModelCenter/TradeStudy3/getJobManager/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study3/get-job-manager.md -$dokka.location:com.phoenix_int.ModelCenter/TradeStudy3/setJobManager/#com.phoenix_int.ModelCenter.ITradeStudy3JobManager/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study3/set-job-manager.md -$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataAccess.Private///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/-private/index.md -$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataAccess.Public///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/-public/index.md -$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataAccess.ReadOnly///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/-read-only/index.md -$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataAccess///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/index.md -$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataAccess/value/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/value.md -$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataAccess/valueOf/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/value-of.md -$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataAccess/values/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/values.md -$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataType.Boolean///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-boolean/index.md -$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataType.Double///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-double/index.md -$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataType.Long///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-long/index.md -$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataType.String///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-string/index.md -$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataType.Xml///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-xml/index.md -$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataType///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/index.md -$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataType/value/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/value.md -$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataType/valueOf/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/value-of.md -$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataType/values/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/values.md -$dokka.location:com.phoenix_int.ModelCenter/Variable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/index.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/dependentLinks/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/dependent-links.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/fromString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/from-string.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/getDirectDependents/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-direct-dependents.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/getDirectDependents/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-direct-dependents.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/getDirectPrecedents/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-direct-precedents.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/getDirectPrecedents/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-direct-precedents.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/getFullName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-full-name.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/getHasChanged/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-has-changed.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/getHide/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-hide.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/getMetadata/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-metadata.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/getName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-name.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/getOwningComponent/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-owning-component.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/getType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-type.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/invalidate/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/invalidate.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/isInput/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/is-input.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/isInputToComponent/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/is-input-to-component.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/isInputToModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/is-input-to-model.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/isValid/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/is-valid.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/precedentLinks/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/precedent-links.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/setHasChanged/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/set-has-changed.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/setHide/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/set-hide.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/setMetadata/#java.lang.String#com.phoenix_int.ModelCenter.Variable.MetadataType#java.lang.Object#com.phoenix_int.ModelCenter.Variable.MetadataAccess#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/set-metadata.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/toString/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/to-string.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/toStringAbsolute/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/to-string-absolute.md -$dokka.location:com.phoenix_int.ModelCenter/Variable/validate/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/validate.md -$dokka.location:com.phoenix_int.ModelCenter/VariableDescription///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/index.md -$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/INPUT/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/-i-n-p-u-t.md -$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/OUTPUT/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/-o-u-t-p-u-t.md -$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/getEquation/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-equation.md -$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/getFullName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-full-name.md -$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/getName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-name.md -$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/getState/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-state.md -$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/getType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-type.md -$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/getUnits/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-units.md -$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/isCustom/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/is-custom.md -$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/isNumeric/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/is-numeric.md -$dokka.location:com.phoenix_int.ModelCenter/VariableLink///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-link/index.md -$dokka.location:com.phoenix_int.ModelCenter/VariableLink/breakLink/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-link/break-link.md -$dokka.location:com.phoenix_int.ModelCenter/VariableLink/getLHS/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-link/get-l-h-s.md -$dokka.location:com.phoenix_int.ModelCenter/VariableLink/getRHS/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-link/get-r-h-s.md -$dokka.location:com.phoenix_int.ModelCenter/VariableLink/resumeLink/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-link/resume-link.md -$dokka.location:com.phoenix_int.ModelCenter/VariableLink/suspendLink/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-link/suspend-link.md -$dokka.location:com.phoenix_int.ModelCenter/VariableLinks///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-links/index.md -$dokka.location:com.phoenix_int.ModelCenter/VariableLinks/getCount/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-links/get-count.md -$dokka.location:com.phoenix_int.ModelCenter/VariableLinks/getItem/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-links/get-item.md -$dokka.location:com.phoenix_int.ModelCenter/VariableLinks/getItem/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-links/get-item.md -$dokka.location:com.phoenix_int.ModelCenter/VariableLinks/hasNext/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-links/has-next.md -$dokka.location:com.phoenix_int.ModelCenter/VariableLinks/next/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-links/next.md -$dokka.location:com.phoenix_int.ModelCenter/VariableLinks/remove/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-links/remove.md -$dokka.location:com.phoenix_int.ModelCenter/VariableLinks/resetIterator/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-links/reset-iterator.md -$dokka.location:com.phoenix_int.ModelCenter/VariableMetaDataProvider///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-meta-data-provider/index.md -$dokka.location:com.phoenix_int.ModelCenter/VariableMetaDataProvider/getAllVariableMetaData/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-meta-data-provider/get-all-variable-meta-data.md -$dokka.location:com.phoenix_int.ModelCenter/VariableMetaDataProvider/getVariableMetaData/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-meta-data-provider/get-variable-meta-data.md -$dokka.location:com.phoenix_int.ModelCenter/Variables///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variables/index.md -$dokka.location:com.phoenix_int.ModelCenter/Variables/getCount/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variables/get-count.md -$dokka.location:com.phoenix_int.ModelCenter/Variables/getItem/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variables/get-item.md -$dokka.location:com.phoenix_int.ModelCenter/Variables/getItem/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variables/get-item.md -$dokka.location:com.phoenix_int.ModelCenter/Variables/hasNext/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variables/has-next.md -$dokka.location:com.phoenix_int.ModelCenter/Variables/next/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variables/next.md -$dokka.location:com.phoenix_int.ModelCenter/Variables/remove/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variables/remove.md -$dokka.location:com.phoenix_int.ModelCenter/Variables/resetIterator/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variables/reset-iterator.md -$dokka.location:com.phoenix_int.ModelCenter/Variant///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/index.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/BOOLEAN/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-b-o-o-l-e-a-n.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/BOOLEAN_ARRAY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-b-o-o-l-e-a-n_-a-r-r-a-y.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/DISPATCH/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-d-i-s-p-a-t-c-h.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/DOUBLE/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-d-o-u-b-l-e.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/DOUBLE_ARRAY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-d-o-u-b-l-e_-a-r-r-a-y.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/INT/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-i-n-t.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/INT_ARRAY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-i-n-t_-a-r-r-a-y.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/LONG/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-l-o-n-g.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/LONG_ARRAY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-l-o-n-g_-a-r-r-a-y.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/REFERENCE/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-r-e-f-e-r-e-n-c-e.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/STRING/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-s-t-r-i-n-g.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/STRING_ARRAY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-s-t-r-i-n-g_-a-r-r-a-y.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/UNKNOWN/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-u-n-k-n-o-w-n.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/Variant/#int#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-variant.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/booleanArrayValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/boolean-array-value.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/booleanValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/boolean-value.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/doubleArrayValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/double-array-value.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/doubleValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/double-value.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/getType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/get-type.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/getValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/get-value.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/intArrayValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/int-array-value.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/intValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/int-value.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/longArrayValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/long-array-value.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/longValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/long-value.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/stringArrayValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/string-array-value.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/stringValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/string-value.md -$dokka.location:com.phoenix_int.ModelCenter/Variant/toString/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/to-string.md -com.phoenix_int.ModelCenter -com.phoenix_int.ModelCenter.Geometry -com.phoenix_int.ModelCenter.logging -com.phoenix_int.ModelCenter.util - +$dokka.format:gfm-v1 +$dokka.linkExtension:md +$dokka.location:com.phoenix_int.ModelCenter.Geometry////PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/index.md +$dokka.location:com.phoenix_int.ModelCenter.Geometry/AWTExceptionHandler///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/index.md +$dokka.location:com.phoenix_int.ModelCenter.Geometry/AWTExceptionHandler/AWTExceptionHandler/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/-a-w-t-exception-handler.md +$dokka.location:com.phoenix_int.ModelCenter.Geometry/AWTExceptionHandler/handle/#java.lang.Throwable/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/handle.md +$dokka.location:com.phoenix_int.ModelCenter.Geometry/AWTExceptionHandler/register/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/-a-w-t-exception-handler/register.md +$dokka.location:com.phoenix_int.ModelCenter.Geometry/PHXJOGL///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/index.md +$dokka.location:com.phoenix_int.ModelCenter.Geometry/PHXJOGL/PHXJOGL/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/-p-h-x-j-o-g-l.md +$dokka.location:com.phoenix_int.ModelCenter.Geometry/PHXJOGL/createList/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/create-list.md +$dokka.location:com.phoenix_int.ModelCenter.Geometry/PHXJOGL/getExts/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/get-exts.md +$dokka.location:com.phoenix_int.ModelCenter.Geometry/PHXJOGL/loadScripts/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.Geometry/-p-h-x-j-o-g-l/load-scripts.md +$dokka.location:com.phoenix_int.ModelCenter.logging////PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/index.md +$dokka.location:com.phoenix_int.ModelCenter.logging/Logger///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/index.md +$dokka.location:com.phoenix_int.ModelCenter.logging/Logger/Logger/#long#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/-logger.md +$dokka.location:com.phoenix_int.ModelCenter.logging/Logger/debug/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/debug.md +$dokka.location:com.phoenix_int.ModelCenter.logging/Logger/error/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/error.md +$dokka.location:com.phoenix_int.ModelCenter.logging/Logger/info/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/info.md +$dokka.location:com.phoenix_int.ModelCenter.logging/Logger/isDebugEnabled/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-debug-enabled.md +$dokka.location:com.phoenix_int.ModelCenter.logging/Logger/isErrorEnabled/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-error-enabled.md +$dokka.location:com.phoenix_int.ModelCenter.logging/Logger/isInfoEnabled/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-info-enabled.md +$dokka.location:com.phoenix_int.ModelCenter.logging/Logger/isWarnEnabled/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/is-warn-enabled.md +$dokka.location:com.phoenix_int.ModelCenter.logging/Logger/warn/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.logging/-logger/warn.md +$dokka.location:com.phoenix_int.ModelCenter.util////PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/index.md +$dokka.location:com.phoenix_int.ModelCenter.util/BeanshellUtil///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-beanshell-util/index.md +$dokka.location:com.phoenix_int.ModelCenter.util/BeanshellUtil/BeanshellUtil/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-beanshell-util/-beanshell-util.md +$dokka.location:com.phoenix_int.ModelCenter.util/BeanshellUtil/runScript/#java.lang.String#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-beanshell-util/run-script.md +$dokka.location:com.phoenix_int.ModelCenter.util/LoggerUpdater///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/index.md +$dokka.location:com.phoenix_int.ModelCenter.util/LoggerUpdater/LoggerUpdater/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/-logger-updater.md +$dokka.location:com.phoenix_int.ModelCenter.util/LoggerUpdater/isResetResistant/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/is-reset-resistant.md +$dokka.location:com.phoenix_int.ModelCenter.util/LoggerUpdater/onLevelChange/#Logger#Level/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-level-change.md +$dokka.location:com.phoenix_int.ModelCenter.util/LoggerUpdater/onReset/#LoggerContext/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-reset.md +$dokka.location:com.phoenix_int.ModelCenter.util/LoggerUpdater/onStart/#LoggerContext/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-start.md +$dokka.location:com.phoenix_int.ModelCenter.util/LoggerUpdater/onStop/#LoggerContext/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/on-stop.md +$dokka.location:com.phoenix_int.ModelCenter.util/LoggerUpdater/stop/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-logger-updater/stop.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObject///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObject/disableGC/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObject/release/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObject/releaseObjects/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObject/setReferenceDebugMode/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObjectHolder///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/index.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObjectHolder/PHXCOMObjectHolder/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/-p-h-x-c-o-m-object-holder.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObjectHolder/getObject/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/get-object.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObjectHolder/release/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/release.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObjectHolder/setObjectMain/#T/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/set-object-main.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXCOMObjectHolder/setObjectOther/#T/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object-holder/set-object-other.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXEquationParser///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-equation-parser/index.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXEquationParser/PHXEquationParser/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-equation-parser/-p-h-x-equation-parser.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXEquationParser/parseEquation/#java.lang.String#java.lang.String[]#java.lang.String[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-equation-parser/parse-equation.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXIOConsole///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/index.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXIOConsole/actionPerformed/#java.awt.event.ActionEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/action-performed.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXIOConsole/dispose/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/dispose.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXIOConsole/isShowing/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/is-showing.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXIOConsole/show/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-i-o-console/show.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXJarLocation///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-jar-location/index.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXJarLocation/PHXJarLocation/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-jar-location/-p-h-x-jar-location.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXJarLocation/getClassLocation/#java.lang.Class/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-jar-location/get-class-location.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXMCJarLoader///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-m-c-jar-loader/index.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXMCJarLoader/PHXMCJarLoader/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-m-c-jar-loader/-p-h-x-m-c-jar-loader.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXMCJarLoader/classExists/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-m-c-jar-loader/class-exists.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/index.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/PHXPlugInLauncher/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/-p-h-x-plug-in-launcher.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/classExists/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/class-exists.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/cleanUp/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/clean-up.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/constructModelCenter/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/construct-model-center.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/disableIOConsole/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/disable-i-o-console.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/getDummyFrame/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/get-dummy-frame.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/launchComponentPlugIn/#long#java.lang.String#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-component-plug-in.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/launchDataCollectorPlugIn/#long#java.lang.String#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-data-collector-plug-in.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/launchPlugInMetaData/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-plug-in-meta-data.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXPlugInLauncher/launchTradeStudyPlugIn/#long#java.lang.String#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-plug-in-launcher/launch-trade-study-plug-in.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/index.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/actionPerformed/#java.awt.event.ActionEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/action-performed.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/itemStateChanged/#java.awt.event.ItemEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/item-state-changed.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/showMonitor/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/show-monitor.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/valueChanged/#javax.swing.event.ListSelectionEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/value-changed.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/windowActivated/#java.awt.event.WindowEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-activated.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/windowClosed/#java.awt.event.WindowEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-closed.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/windowClosing/#java.awt.event.WindowEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-closing.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/windowDeactivated/#java.awt.event.WindowEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-deactivated.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/windowDeiconified/#java.awt.event.WindowEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-deiconified.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/windowIconified/#java.awt.event.WindowEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-iconified.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXReferenceMonitor/windowOpened/#java.awt.event.WindowEvent/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-reference-monitor/window-opened.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXURLClassLoader///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/index.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXURLClassLoader/PHXURLClassLoader/#java.net.URL[]#java.lang.ClassLoader#java.net.URLStreamHandlerFactory/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/-p-h-x-u-r-l-class-loader.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXURLClassLoader/PHXURLClassLoader/#java.net.URL[]#java.lang.ClassLoader/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/-p-h-x-u-r-l-class-loader.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXURLClassLoader/PHXURLClassLoader/#java.net.URL[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/-p-h-x-u-r-l-class-loader.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXURLClassLoader/addURL2/#java.net.URL/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/add-u-r-l2.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXURLClassLoader/getResource/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/get-resource.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXURLClassLoader/getResourceAsStream/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/get-resource-as-stream.md +$dokka.location:com.phoenix_int.ModelCenter.util/PHXURLClassLoader/loadClass/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-p-h-x-u-r-l-class-loader/load-class.md +$dokka.location:com.phoenix_int.ModelCenter.util/ValueHolder///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/index.md +$dokka.location:com.phoenix_int.ModelCenter.util/ValueHolder/ValueHolder/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/-value-holder.md +$dokka.location:com.phoenix_int.ModelCenter.util/ValueHolder/ValueHolder/#T/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/-value-holder.md +$dokka.location:com.phoenix_int.ModelCenter.util/ValueHolder/value/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter.util/-value-holder/value.md +$dokka.location:com.phoenix_int.ModelCenter////PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/index.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/index.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/AddToModel/#long#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/-add-to-model.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/AddToModel/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/-add-to-model.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/addInput/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-input.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/addInput2/#java.lang.String#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-input2.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/addMethod/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-method.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/addOutput/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-output.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/addOutput2/#java.lang.String#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-output2.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/addToModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-to-model.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/addToModel2/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-to-model2.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/addToModel3/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/add-to-model3.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/clearBusyFlag/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/clear-busy-flag.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/getAutoRun/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-auto-run.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/getComponent/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-component.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/getPrevalidateInputs/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-prevalidate-inputs.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/getProgID/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-prog-i-d.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/getRegID/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/get-reg-i-d.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/newInstance/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/new-instance.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/setAuthor/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-author.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/setAutoRun/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-auto-run.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/setComponentRequirements/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-component-requirements.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-description.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/setHelpURL/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-help-u-r-l.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/setIcon/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-icon.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/setKeywords/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-keywords.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/setPrevalidateInputs/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-prevalidate-inputs.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/setVersion/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/set-version.md +$dokka.location:com.phoenix_int.ModelCenter/AddToModel/updateComponent/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-add-to-model/update-component.md +$dokka.location:com.phoenix_int.ModelCenter/Array///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/index.md +$dokka.location:com.phoenix_int.ModelCenter/Array/fromString/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/from-string.md +$dokka.location:com.phoenix_int.ModelCenter/Array/getAutoSize/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/get-auto-size.md +$dokka.location:com.phoenix_int.ModelCenter/Array/getDimensions/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/get-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/Array/getLength/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/get-length.md +$dokka.location:com.phoenix_int.ModelCenter/Array/getLength/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/get-length.md +$dokka.location:com.phoenix_int.ModelCenter/Array/getNumDimensions/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/get-num-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/Array/getSize/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/get-size.md +$dokka.location:com.phoenix_int.ModelCenter/Array/getSize/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/get-size.md +$dokka.location:com.phoenix_int.ModelCenter/Array/setAutoSize/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-auto-size.md +$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/Array/setDimensions/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/Array/setLength/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-length.md +$dokka.location:com.phoenix_int.ModelCenter/Array/setLength/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-length.md +$dokka.location:com.phoenix_int.ModelCenter/Array/setNumDimensions/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-num-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/Array/setSize/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-size.md +$dokka.location:com.phoenix_int.ModelCenter/Array/setSize/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/set-size.md +$dokka.location:com.phoenix_int.ModelCenter/Array/toString/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/to-string.md +$dokka.location:com.phoenix_int.ModelCenter/Array/toStringAbsolute/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-array/to-string-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/index.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/ASSEMBLY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/-a-s-s-e-m-b-l-y.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/FOR_EACH/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/-f-o-r_-e-a-c-h.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/IF/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/-i-f.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/LOOP/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/-l-o-o-p.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/PARALLEL/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/-p-a-r-a-l-l-e-l.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/SEQUENCE/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/-s-e-q-u-e-n-c-e.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/addAssembly/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/add-assembly.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/addAssembly/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/add-assembly.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/addAssembly2/#java.lang.String#int#int#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/add-assembly2.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/addAssembly2/#java.lang.String#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/add-assembly2.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/addVariable/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/add-variable.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/convertToSubmodel/#java.lang.String#com.phoenix_int.ModelCenter.ModelCenter.VersionStatus#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/convert-to-submodel.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/deleteVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/delete-variable.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getAssembly/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-assembly.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getAssembly/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-assembly.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getAssemblyType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-assembly-type.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getComponent/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-component.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getComponent/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-component.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getFullName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-full-name.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getGroup/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-group.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getGroup/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-group.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getIconID/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-icon-i-d.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getIndexInParent/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-index-in-parent.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getMetadata/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-metadata.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-name.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getNumAssemblies/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-assemblies.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getNumComponents/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-components.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getNumGroups/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-groups.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getNumVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-num-variables.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getParentAssembly/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-parent-assembly.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getPositionX/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-position-x.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getPositionY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-position-y.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getUserData/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-user-data.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getVariable/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-variable.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/getVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/get-variable.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/rename/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/rename.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/setIconID/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/set-icon-i-d.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/setMetadata/#java.lang.String#com.phoenix_int.ModelCenter.Variable.MetadataType#java.lang.Object#com.phoenix_int.ModelCenter.Variable.MetadataAccess#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/set-metadata.md +$dokka.location:com.phoenix_int.ModelCenter/Assembly/setUserData/#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-assembly/set-user-data.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/index.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-description.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValue/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/getValueAbsolute/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-description.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanArray/setValue/#boolean#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanVariable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/index.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanVariable/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/get-description.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanVariable/getValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanVariable/getValueAbsolute/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanVariable/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/set-description.md +$dokka.location:com.phoenix_int.ModelCenter/BooleanVariable/setValue/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-boolean-variable/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/CachePin///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-cache-pin/index.md +$dokka.location:com.phoenix_int.ModelCenter/CachePin/checkinOnFlush/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-cache-pin/checkin-on-flush.md +$dokka.location:com.phoenix_int.ModelCenter/CachePin/getLocalPath/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-cache-pin/get-local-path.md +$dokka.location:com.phoenix_int.ModelCenter/CachePin/getUrl/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-cache-pin/get-url.md +$dokka.location:com.phoenix_int.ModelCenter/CachePin/isValid/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-cache-pin/is-valid.md +$dokka.location:com.phoenix_int.ModelCenter/CachePin/releasePin/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-cache-pin/release-pin.md +$dokka.location:com.phoenix_int.ModelCenter/CompletedRunData///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/index.md +$dokka.location:com.phoenix_int.ModelCenter/CompletedRunData/CompletedRunData/#int[]#int[]#java.lang.String[]#java.lang.Object[][]#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/-completed-run-data.md +$dokka.location:com.phoenix_int.ModelCenter/CompletedRunData/getEndSequenceNumber/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-end-sequence-number.md +$dokka.location:com.phoenix_int.ModelCenter/CompletedRunData/getErrorIDs/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-error-i-ds.md +$dokka.location:com.phoenix_int.ModelCenter/CompletedRunData/getErrorMessages/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-error-messages.md +$dokka.location:com.phoenix_int.ModelCenter/CompletedRunData/getNextSequenceNumber/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-next-sequence-number.md +$dokka.location:com.phoenix_int.ModelCenter/CompletedRunData/getRunIDs/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-run-i-ds.md +$dokka.location:com.phoenix_int.ModelCenter/CompletedRunData/getVariableValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-completed-run-data/get-variable-values.md +$dokka.location:com.phoenix_int.ModelCenter/Component///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/index.md +$dokka.location:com.phoenix_int.ModelCenter/Component/COMPONENT_TYPE_ASSEMBLY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-a-s-s-e-m-b-l-y.md +$dokka.location:com.phoenix_int.ModelCenter/Component/COMPONENT_TYPE_COMPONENT/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-c-o-m-p-o-n-e-n-t.md +$dokka.location:com.phoenix_int.ModelCenter/Component/COMPONENT_TYPE_EMPTY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-e-m-p-t-y.md +$dokka.location:com.phoenix_int.ModelCenter/Component/COMPONENT_TYPE_FOR_EACH/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-f-o-r_-e-a-c-h.md +$dokka.location:com.phoenix_int.ModelCenter/Component/COMPONENT_TYPE_IF/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-i-f.md +$dokka.location:com.phoenix_int.ModelCenter/Component/COMPONENT_TYPE_LOOP/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-l-o-o-p.md +$dokka.location:com.phoenix_int.ModelCenter/Component/COMPONENT_TYPE_PARALLEL/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-p-a-r-a-l-l-e-l.md +$dokka.location:com.phoenix_int.ModelCenter/Component/COMPONENT_TYPE_SCRIPTCOMPONENT/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-c-r-i-p-t-c-o-m-p-o-n-e-n-t.md +$dokka.location:com.phoenix_int.ModelCenter/Component/COMPONENT_TYPE_SEQUENCE/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/-c-o-m-p-o-n-e-n-t_-t-y-p-e_-s-e-q-u-e-n-c-e.md +$dokka.location:com.phoenix_int.ModelCenter/Component/downloadValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/download-values.md +$dokka.location:com.phoenix_int.ModelCenter/Component/getAssociatedFiles/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-associated-files.md +$dokka.location:com.phoenix_int.ModelCenter/Component/getFullName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-full-name.md +$dokka.location:com.phoenix_int.ModelCenter/Component/getGroup/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-group.md +$dokka.location:com.phoenix_int.ModelCenter/Component/getGroup/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-group.md +$dokka.location:com.phoenix_int.ModelCenter/Component/getIndexInParent/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-index-in-parent.md +$dokka.location:com.phoenix_int.ModelCenter/Component/getMetadata/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-metadata.md +$dokka.location:com.phoenix_int.ModelCenter/Component/getName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-name.md +$dokka.location:com.phoenix_int.ModelCenter/Component/getNumGroups/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-num-groups.md +$dokka.location:com.phoenix_int.ModelCenter/Component/getNumVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-num-variables.md +$dokka.location:com.phoenix_int.ModelCenter/Component/getParentAssembly/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-parent-assembly.md +$dokka.location:com.phoenix_int.ModelCenter/Component/getPositionX/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-position-x.md +$dokka.location:com.phoenix_int.ModelCenter/Component/getPositionY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-position-y.md +$dokka.location:com.phoenix_int.ModelCenter/Component/getSource/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-source.md +$dokka.location:com.phoenix_int.ModelCenter/Component/getType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-type.md +$dokka.location:com.phoenix_int.ModelCenter/Component/getUserData/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-user-data.md +$dokka.location:com.phoenix_int.ModelCenter/Component/getVariable/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-variable.md +$dokka.location:com.phoenix_int.ModelCenter/Component/getVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/get-variable.md +$dokka.location:com.phoenix_int.ModelCenter/Component/invalidate/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/invalidate.md +$dokka.location:com.phoenix_int.ModelCenter/Component/invokeMethod/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/invoke-method.md +$dokka.location:com.phoenix_int.ModelCenter/Component/reconnect/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/reconnect.md +$dokka.location:com.phoenix_int.ModelCenter/Component/rename/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/rename.md +$dokka.location:com.phoenix_int.ModelCenter/Component/run/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/run.md +$dokka.location:com.phoenix_int.ModelCenter/Component/setAssociatedFiles/#java.lang.Object[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/set-associated-files.md +$dokka.location:com.phoenix_int.ModelCenter/Component/setMetadata/#java.lang.String#com.phoenix_int.ModelCenter.Variable.MetadataType#java.lang.Object#com.phoenix_int.ModelCenter.Variable.MetadataAccess#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/set-metadata.md +$dokka.location:com.phoenix_int.ModelCenter/Component/setUserData/#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/set-user-data.md +$dokka.location:com.phoenix_int.ModelCenter/Component/show/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-component/show.md +$dokka.location:com.phoenix_int.ModelCenter/CustomDesignPoint///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/index.md +$dokka.location:com.phoenix_int.ModelCenter/CustomDesignPoint/addVariable/#java.lang.String#java.lang.String#boolean#boolean#boolean#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/add-variable.md +$dokka.location:com.phoenix_int.ModelCenter/CustomDesignPoint/getID2/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/get-i-d2.md +$dokka.location:com.phoenix_int.ModelCenter/CustomDesignPoint/runFailed/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-custom-design-point/run-failed.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/index.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/DHVariable/#long#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/-d-h-variable.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/DHVariable/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/-d-h-variable.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getEnumAlias/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-alias.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getEnumAliases/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-aliases.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getEnumValue/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-value.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getEquation/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-equation.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getFormat/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-format.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getMetaData/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-meta-data.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-name.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getNumEnumAlias/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-num-enum-alias.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getNumEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-num-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-type.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getUnits/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-units.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/getUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/get-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/isDesignVar/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/is-design-var.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/isInput/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/is-input.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/isNumeric/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/is-numeric.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/removeMetadata/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/remove-metadata.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setDesignVar/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-design-var.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setEnumAliases/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-enum-aliases.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setEquation/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-equation.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setFormat/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-format.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setInput/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-input.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setLowerBound/#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setMetaData/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-meta-data.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setName/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-name.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setNumeric/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-numeric.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setType/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-type.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setUnits/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-units.md +$dokka.location:com.phoenix_int.ModelCenter/DHVariable/setUpperBound/#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-d-h-variable/set-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/index.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/DataCollector/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/-data-collector.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/addCustom/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/add-custom.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/createEmptyRuns/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/create-empty-runs.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/enableCarpetPlotTab/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-carpet-plot-tab.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/enableCarpetPlotTab/#long#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-carpet-plot-tab.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/enableGraphTab/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-graph-tab.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/enableMainEffectsTab/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/enable-main-effects-tab.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/endRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/end-runs.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/exportToCSV/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/export-to-c-s-v.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/fromString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/from-string.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getDataExplorer/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-data-explorer.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getErrorID/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-error-i-d.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getErrorMessage/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-error-message.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getNumFailedRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-num-failed-runs.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getNumRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-num-runs.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getNumVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-num-variables.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getValue/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getValue/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getVariableDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-variable-description.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/getVariableDescription/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/get-variable-description.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/hide/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/hide.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/isValid/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/is-valid.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/isValid/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/is-valid.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/isVisible/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/is-visible.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/newCustomDesignPoint/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/new-custom-design-point.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/newInstance/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/new-instance.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/save/#java.lang.String#java.lang.String#java.lang.String#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/save.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/selectX/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/select-x.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/selectY/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/select-y.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/setCustomRun/#long#com.phoenix_int.ModelCenter.CustomDesignPoint/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/set-custom-run.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/setNumExpectedRuns/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/set-num-expected-runs.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/show/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/show.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/startRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/start-runs.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/storeCurrentDesignPoint/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/store-current-design-point.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/storeCustomDesignPoint/#com.phoenix_int.ModelCenter.CustomDesignPoint/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/store-custom-design-point.md +$dokka.location:com.phoenix_int.ModelCenter/DataCollector/toString/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-collector/to-string.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer.PHXDEKeepalive///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/-p-h-x-d-e-keepalive/index.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/index.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/addPage/#java.lang.String#long#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/add-page.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/addRunsToComparisonList/#long[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/add-runs-to-comparison-list.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/addToComparisonList/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/add-to-comparison-list.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/fromXML/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/from-x-m-l.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/fromXML/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/from-x-m-l.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/fromXMLFile/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/from-x-m-l-file.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/fromXMLFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/from-x-m-l-file.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getAssociatedModelFile/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-associated-model-file.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getAssociatedModelFileUUID/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-associated-model-file-u-u-i-d.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getAuthor/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-author.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getCreationDate/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-creation-date.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getDaXFormat/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-da-x-format.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getDaXType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-da-x-type.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getDataHistory/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-data-history.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-description.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getDisplayName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-display-name.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getFileUri/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-file-uri.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getHWND/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-h-w-n-d.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getKeepalive/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-keepalive.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getModelCenter/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-model-center.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getNumPages/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-num-pages.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getPageType/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-page-type.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getSelectedPage/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-selected-page.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getTradeStudySetup/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-trade-study-setup.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/getTradeStudyType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/get-trade-study-type.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/hide/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/hide.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/ignoreDefaultPlotSetup/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/ignore-default-plot-setup.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/invokeInsertPageGUI/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/invoke-insert-page-g-u-i.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/invokeMenuItem/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/invoke-menu-item.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/isMenuItemChecked/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/is-menu-item-checked.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/isMenuItemEnabled/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/is-menu-item-enabled.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/isVisible/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/is-visible.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/movePage/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/move-page.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/multiDelete/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/multi-delete.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/multiPageCopy/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/multi-page-copy.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/multiPageCut/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/multi-page-cut.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/newInstance/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/new-instance.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/pageCopy/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/page-copy.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/pageCut/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/page-cut.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/pagePaste/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/page-paste.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/removeFromComparisonList/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/remove-from-comparison-list.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/removePage/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/remove-page.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/selectPage/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/select-page.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setAssociatedModelFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-associated-model-file.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setAssociatedModelFileUUID/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-associated-model-file-u-u-i-d.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setAuthor/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-author.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setCreationDate/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-creation-date.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-description.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setDisplayName/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-display-name.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setFileUri/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-file-uri.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setGeomViewerRunID/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-geom-viewer-run-i-d.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setTradeStudySetup/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-trade-study-setup.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setTradeStudyType/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/set-trade-study-type.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setupPlotsPost/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/setup-plots-post.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/setupPlotsPre/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/setup-plots-pre.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/show/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/show.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/showGeomTooltip/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/show-geom-tooltip.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/showGeomViewer/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/show-geom-viewer.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/toXML/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/to-x-m-l.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/toXML/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/to-x-m-l.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/toXMLFile/#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/to-x-m-l-file.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/toXMLFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/to-x-m-l-file.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/updateComparisonViewHint/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/update-comparison-view-hint.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/updateGeomViewerHint/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/update-geom-viewer-hint.md +$dokka.location:com.phoenix_int.ModelCenter/DataExplorer/updateThumbHint/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-explorer/update-thumb-hint.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/index.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/DataHistory/#long#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/-data-history.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/DataHistory/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/-data-history.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/addVariable/#com.phoenix_int.ModelCenter.DHVariable/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/add-variable.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/addVariableStructs/#com.phoenix_int.ModelCenter.DataHistoryVariableStruct[]#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/add-variable-structs.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/createVariable/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/create-variable.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/deleteRun/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/delete-run.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/deleteVariable/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/delete-variable.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/deleteVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/delete-variable.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/endRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/end-runs.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/fromXML/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/from-x-m-l.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/fromXMLFile/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/from-x-m-l-file.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getCenterLinkJobConnector/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-job-connector.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getCenterLinkQueue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-queue.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getCenterLinkRunMatrixID/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-run-matrix-i-d.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getCenterLinkServer/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-center-link-server.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getCompletedRunData/#int#int#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-completed-run-data.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getDataExplorer/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-data-explorer.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getDataHistoryToModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-data-history-to-model.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getErrorID/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-error-i-d.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getErrorMessage/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-error-message.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getFormattedValue/#int#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-formatted-value.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getFormattedValue/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-formatted-value.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getHighlightedRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-highlighted-runs.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getNumCustomVars/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-custom-vars.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getNumDesignVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-design-variables.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getNumExpectedRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-expected-runs.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getNumFailedRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-failed-runs.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getNumNonEmptyRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-non-empty-runs.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getNumRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-runs.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getNumVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-num-variables.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getRunName/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-run-name.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getSettingRun/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-setting-run.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getSuggestedCountFrom/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-count-from.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getSuggestedDependentVars/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-dependent-vars.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getSuggestedIndependantVar/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-independant-var.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getSuggestedIndependentVar/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-suggested-independent-var.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getUniqueID/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-unique-i-d.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getValue/#int#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getValue/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getVariable/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-variable.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-variable.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getVariableValues/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-variable-values.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/getVariableValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/get-variable-values.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/highlight/#long#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/highlight.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/insertRun/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/insert-run.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/isHighlighted/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/is-highlighted.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/isModified/#int#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/is-modified.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/isModified/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/is-modified.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/isRunning/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/is-running.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/isValid/#int#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/is-valid.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/isValid/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/is-valid.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/newInstance/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/new-instance.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setDataHistoryToModel/#com.phoenix_int.ModelCenter.IDataHistoryToModel/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-data-history-to-model.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setError/#long#long#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-error.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setFormattedResult/#int#long#java.lang.String#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-formatted-result.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setFormattedResult/#java.lang.String#long#java.lang.String#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-formatted-result.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setHighlightedRuns/#long[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-highlighted-runs.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setNumExpectedRuns/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-num-expected-runs.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setResult/#int#long#java.lang.Object#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-result.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setResult/#java.lang.String#long#java.lang.Object#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-result.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setRunName/#long#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-run-name.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setRunValues/#long#java.lang.Object[]#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-run-values.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setSettingRun/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-setting-run.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setSuggestedCountFrom/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-count-from.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setSuggestedDependentVars/#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-dependent-vars.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setSuggestedIndependantVar/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-independant-var.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setSuggestedIndependentVar/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-suggested-independent-var.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setVariableValues/#int#long#java.lang.Object[]#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-variable-values.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/setVariableValues/#java.lang.String#long#java.lang.Object[]#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/set-variable-values.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/startRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/start-runs.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/toCSV/#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/to-c-s-v.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/toCSVFile/#java.lang.String#boolean#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/to-c-s-v-file.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/toXML/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/to-x-m-l.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/toXML/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/to-x-m-l.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/toXMLFile/#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/to-x-m-l-file.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistory/toXMLFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history/to-x-m-l-file.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/index.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/DataHistoryVariableMetadataStruct/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/-data-history-variable-metadata-struct.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/customMetadata/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/custom-metadata.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/enumAliases/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/enum-aliases.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/enumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/equation/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/equation.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/fileName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/file-name.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/format/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/format.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/geomScript/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/geom-script.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/getCustomMetadataNames/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/get-custom-metadata-names.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/isBinary/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-binary.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/isDesignVar/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-design-var.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/isInput/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-input.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/isNumeric/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/is-numeric.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/lowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/name/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/name.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/type/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/type.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/units/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/units.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableMetadataStruct/upperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-metadata-struct/upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableStruct///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/index.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableStruct/DataHistoryVariableStruct/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/-data-history-variable-struct.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableStruct/index/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/--index--.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableStruct/isModified/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/is-modified.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableStruct/isValid/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/is-valid.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableStruct/metadata/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/metadata.md +$dokka.location:com.phoenix_int.ModelCenter/DataHistoryVariableStruct/varValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-history-variable-struct/var-value.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/index.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/addItem/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/add-item.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/addUnlinkedItem/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/add-unlinked-item.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getAutoDelete/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-auto-delete.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getColWidth/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-col-width.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getDisplayFullNames/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-display-full-names.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getDisplayUnits/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-display-units.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getHeight/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-height.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getLink/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-link.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getName/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-name.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getTitle/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-title.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getWidth/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-width.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getX/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-x.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/getY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/get-y.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/isRenamed/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/is-renamed.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/isValid/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/is-valid.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/removeItem/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/remove-item.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/removeLink/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/remove-link.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/setAutoDelete/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-auto-delete.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/setColWidth/#long#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-col-width.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/setDisplayFullNames/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-display-full-names.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/setDisplayUnits/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-display-units.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/setLink/#long#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-link.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/setLocation/#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-location.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/setName/#long#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-name.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/setSize/#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-size.md +$dokka.location:com.phoenix_int.ModelCenter/DataMonitor/setTitle/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-data-monitor/set-title.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/index.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/clearLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/clear-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/clearUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/clear-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/fromFormattedString/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/from-formatted-string.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-description.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getEnumAliases/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-enum-aliases.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getFormat/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-format.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getUnits/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-units.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValue/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/getValueAbsolute/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/hasLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/has-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/hasUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/has-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-description.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setEnumAliases/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-enum-aliases.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setFormat/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-format.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setLowerBound/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setUnits/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-units.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setUpperBound/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/setValue/#double#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/toFormattedString/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/to-formatted-string.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleArray/toFormattedStringAbsolute/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-array/to-formatted-string-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/index.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/clearLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/clear-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/clearUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/clear-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/fromFormattedString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/from-formatted-string.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-description.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/getEnumAliases/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-enum-aliases.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/getEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/getFormat/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-format.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/getLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/getUnits/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-units.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/getUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/getValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/getValueAbsolute/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/hasLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/has-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/hasUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/has-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-description.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/setEnumAliases/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-enum-aliases.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/setEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/setFormat/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-format.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/setLowerBound/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/setUnits/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-units.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/setUpperBound/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/setValue/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/toFormattedString/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/to-formatted-string.md +$dokka.location:com.phoenix_int.ModelCenter/DoubleVariable/toFormattedStringAbsolute/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-double-variable/to-formatted-string-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/Feature///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-feature/index.md +$dokka.location:com.phoenix_int.ModelCenter/Feature/checkin/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-feature/checkin.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/index.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/fromFile/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/from-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/getDescription/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-description.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/getFileExtension/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/getIsBinary/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-is-binary.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/getSaveWithModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/get-save-with-model.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-description.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/setFileExtension/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/setIsBinary/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-is-binary.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/setSaveWithModel/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/set-save-with-model.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFile/#java.lang.String#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/FileArray/toFileAbsolute/#java.lang.String#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-array/to-file-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/FileSystemInfo///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-system-info/index.md +$dokka.location:com.phoenix_int.ModelCenter/FileSystemInfo/getBaseName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-base-name.md +$dokka.location:com.phoenix_int.ModelCenter/FileSystemInfo/getExists/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-exists.md +$dokka.location:com.phoenix_int.ModelCenter/FileSystemInfo/getIsValid/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-is-valid.md +$dokka.location:com.phoenix_int.ModelCenter/FileSystemInfo/getIsWritable/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-is-writable.md +$dokka.location:com.phoenix_int.ModelCenter/FileSystemInfo/getUrl/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-system-info/get-url.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/index.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable/fromFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/from-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-description.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable/getDirectTransfer/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-direct-transfer.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable/getFileExtension/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable/getIsBinary/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-is-binary.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable/getSaveWithModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/get-save-with-model.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable/readFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/read-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-description.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable/setDirectTransfer/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-direct-transfer.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable/setFileExtension/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable/setIsBinary/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-is-binary.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable/setSaveWithModel/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/set-save-with-model.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable/toFile/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/to-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable/toFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/to-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable/toFileAbsolute/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/to-file-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable/toFileAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/to-file-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable/writeFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/write-file.md +$dokka.location:com.phoenix_int.ModelCenter/FileVariable/writeFileAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-file-variable/write-file-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/Format///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/index.md +$dokka.location:com.phoenix_int.ModelCenter/Format/doubleToEditableString/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/double-to-editable-string.md +$dokka.location:com.phoenix_int.ModelCenter/Format/doubleToString/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/double-to-string.md +$dokka.location:com.phoenix_int.ModelCenter/Format/getFormat/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/get-format.md +$dokka.location:com.phoenix_int.ModelCenter/Format/longToEditableString/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/long-to-editable-string.md +$dokka.location:com.phoenix_int.ModelCenter/Format/longToString/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/long-to-string.md +$dokka.location:com.phoenix_int.ModelCenter/Format/setFormat/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/set-format.md +$dokka.location:com.phoenix_int.ModelCenter/Format/stringToDouble/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/string-to-double.md +$dokka.location:com.phoenix_int.ModelCenter/Format/stringToLong/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/string-to-long.md +$dokka.location:com.phoenix_int.ModelCenter/Format/stringToString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format/string-to-string.md +$dokka.location:com.phoenix_int.ModelCenter/Format2///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/index.md +$dokka.location:com.phoenix_int.ModelCenter/Format2/Format2/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/-format2.md +$dokka.location:com.phoenix_int.ModelCenter/Format2/Format2/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/-format2.md +$dokka.location:com.phoenix_int.ModelCenter/Format2/_setFormat/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/_set-format.md +$dokka.location:com.phoenix_int.ModelCenter/Format2/doubleToEditableString/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/double-to-editable-string.md +$dokka.location:com.phoenix_int.ModelCenter/Format2/doubleToString/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/double-to-string.md +$dokka.location:com.phoenix_int.ModelCenter/Format2/longToEditableString/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/long-to-editable-string.md +$dokka.location:com.phoenix_int.ModelCenter/Format2/longToString/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/long-to-string.md +$dokka.location:com.phoenix_int.ModelCenter/Format2/stringToDouble/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/string-to-double.md +$dokka.location:com.phoenix_int.ModelCenter/Format2/stringToLong/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/string-to-long.md +$dokka.location:com.phoenix_int.ModelCenter/Format2/stringToString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-format2/string-to-string.md +$dokka.location:com.phoenix_int.ModelCenter/GeometryVariable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/index.md +$dokka.location:com.phoenix_int.ModelCenter/GeometryVariable/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/get-description.md +$dokka.location:com.phoenix_int.ModelCenter/GeometryVariable/getValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/GeometryVariable/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/set-description.md +$dokka.location:com.phoenix_int.ModelCenter/GeometryVariable/setValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-geometry-variable/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/index.md +$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters/getCount/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/get-count.md +$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters/getValue/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters/getValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters/remove/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/remove.md +$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters/remove/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/remove.md +$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters/setExportToRemoteComponents/#int#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/set-export-to-remote-components.md +$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters/setExportToRemoteComponents/#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/set-export-to-remote-components.md +$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters/setValue/#int#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/GlobalParameters/setValue/#java.lang.String#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-global-parameters/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/Group///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/index.md +$dokka.location:com.phoenix_int.ModelCenter/Group/getFullName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/get-full-name.md +$dokka.location:com.phoenix_int.ModelCenter/Group/getGroup/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/get-group.md +$dokka.location:com.phoenix_int.ModelCenter/Group/getGroup/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/get-group.md +$dokka.location:com.phoenix_int.ModelCenter/Group/getIconID/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/get-icon-i-d.md +$dokka.location:com.phoenix_int.ModelCenter/Group/getName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/get-name.md +$dokka.location:com.phoenix_int.ModelCenter/Group/getNumGroups/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/get-num-groups.md +$dokka.location:com.phoenix_int.ModelCenter/Group/getNumVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/get-num-variables.md +$dokka.location:com.phoenix_int.ModelCenter/Group/getVariable/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/get-variable.md +$dokka.location:com.phoenix_int.ModelCenter/Group/getVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/get-variable.md +$dokka.location:com.phoenix_int.ModelCenter/Group/setIconID/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-group/set-icon-i-d.md +$dokka.location:com.phoenix_int.ModelCenter/IComponentPlugIn///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/index.md +$dokka.location:com.phoenix_int.ModelCenter/IComponentPlugIn/construct/#com.phoenix_int.ModelCenter.ModelCenter#com.phoenix_int.ModelCenter.AddToModel/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/construct.md +$dokka.location:com.phoenix_int.ModelCenter/IComponentPlugIn/fromString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/from-string.md +$dokka.location:com.phoenix_int.ModelCenter/IComponentPlugIn/onEnd/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/on-end.md +$dokka.location:com.phoenix_int.ModelCenter/IComponentPlugIn/run/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/run.md +$dokka.location:com.phoenix_int.ModelCenter/IComponentPlugIn/show/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-component-plug-in/show.md +$dokka.location:com.phoenix_int.ModelCenter/IDataCollectorPlugIn///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/index.md +$dokka.location:com.phoenix_int.ModelCenter/IDataCollectorPlugIn/construct/#com.phoenix_int.ModelCenter.ModelCenter#com.phoenix_int.ModelCenter.AddToModel#com.phoenix_int.ModelCenter.DataCollector/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/construct.md +$dokka.location:com.phoenix_int.ModelCenter/IDataCollectorPlugIn/fromString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/from-string.md +$dokka.location:com.phoenix_int.ModelCenter/IDataCollectorPlugIn/show/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-collector-plug-in/show.md +$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/index.md +$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/construct/#long#boolean#javax.swing.JFrame#int#com.phoenix_int.ModelCenter.DataHistory#com.phoenix_int.ModelCenter.ModelCenter#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/construct.md +$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/dataChanged/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/data-changed.md +$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/exportImage/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/export-image.md +$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/fromString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/from-string.md +$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/getPageTitle/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/get-page-title.md +$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/getRequiredLicense/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/get-required-license.md +$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/getThumbnail/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/get-thumbnail.md +$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/invokeMenuItem/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/invoke-menu-item.md +$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/onEnd/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/on-end.md +$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/progressMeterStop/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/progress-meter-stop.md +$dokka.location:com.phoenix_int.ModelCenter/IDataExplorerPlugIn/variablesChanged/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-explorer-plug-in/variables-changed.md +$dokka.location:com.phoenix_int.ModelCenter/IDataHistoryToModel///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/index.md +$dokka.location:com.phoenix_int.ModelCenter/IDataHistoryToModel/canRerunRuns/#com.phoenix_int.ModelCenter.DataHistory#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/can-rerun-runs.md +$dokka.location:com.phoenix_int.ModelCenter/IDataHistoryToModel/canSaveToModel/#com.phoenix_int.ModelCenter.DataHistory#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/can-save-to-model.md +$dokka.location:com.phoenix_int.ModelCenter/IDataHistoryToModel/closeDataHistory/#com.phoenix_int.ModelCenter.DataHistory/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/close-data-history.md +$dokka.location:com.phoenix_int.ModelCenter/IDataHistoryToModel/rerunRuns/#com.phoenix_int.ModelCenter.DataHistory#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/rerun-runs.md +$dokka.location:com.phoenix_int.ModelCenter/IDataHistoryToModel/saveToModel/#com.phoenix_int.ModelCenter.DataHistory#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-data-history-to-model/save-to-model.md +$dokka.location:com.phoenix_int.ModelCenter/IHolder///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-holder/index.md +$dokka.location:com.phoenix_int.ModelCenter/IHolder/getFullName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-holder/get-full-name.md +$dokka.location:com.phoenix_int.ModelCenter/IHolder/getName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-holder/get-name.md +$dokka.location:com.phoenix_int.ModelCenter/ILoginCallback///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/index.md +$dokka.location:com.phoenix_int.ModelCenter/ILoginCallback/loginSucceeded/#java.lang.String#java.lang.String#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/login-succeeded.md +$dokka.location:com.phoenix_int.ModelCenter/ILoginCallback/requestAuthCredentials/#java.lang.String#boolean#com.phoenix_int.ModelCenter.util.ValueHolder#com.phoenix_int.ModelCenter.util.ValueHolder#com.phoenix_int.ModelCenter.util.ValueHolder/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/request-auth-credentials.md +$dokka.location:com.phoenix_int.ModelCenter/ILoginCallback/verifySslWarning/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-login-callback/verify-ssl-warning.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/index.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/HTMLViewerWaitForClose/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/-h-t-m-l-viewer-wait-for-close.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/MessageBox/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/-message-box.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/addIcon/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/add-icon.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/addNewMacro/#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/add-new-macro.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/autoLink/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/auto-link.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/breakLink/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/break-link.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/checkout/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/checkout.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/checkout2/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/checkout2.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/closeHTMLViewer/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/close-h-t-m-l-viewer.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/closeModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/close-model.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createAndInitComponent/#java.lang.String#java.lang.String#java.lang.String#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-and-init-component.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createAssembly/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-assembly.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createAssembly/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-assembly.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createAssemblyVariable/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-assembly-variable.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createComponent/#java.lang.String#java.lang.String#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-component.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createComponent/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-component.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createDataCollector/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-collector.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createDataExplorer/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-explorer.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createDataHistoryVariable/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-history-variable.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createDataMonitor/#java.lang.String#java.lang.String#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-data-monitor.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createJobManager/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-job-manager.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createJobManager/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-job-manager.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createJobManager/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-job-manager.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createLink/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-link.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createPlugInFrame/#java.lang.String#java.lang.String#java.lang.String#long#java.awt.Container#boolean#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-plug-in-frame.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createPlugInFrame/#java.lang.String#java.lang.String#java.lang.String#long#java.awt.Container#boolean#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-plug-in-frame.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createPlugInFrame/#java.lang.String#java.lang.String#java.lang.String#long#java.awt.Container#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-plug-in-frame.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createPlugInFrame/#java.lang.String#java.lang.String#java.lang.String#long#java.awt.Container/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-plug-in-frame.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/createTradeStudy/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/create-trade-study.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/destroyPlugInFrame/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/destroy-plug-in-frame.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/dumpComDebug/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/dump-com-debug.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getActiveJobManager/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-active-job-manager.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getAppName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-app-name.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getAssembly/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-assembly.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getAssemblyStyle/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-assembly-style.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getComponent/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-component.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getDataCollector/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-collector.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getDataCollectorForDataExplorer/#com.phoenix_int.ModelCenter.DataExplorer/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-collector-for-data-explorer.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getDataExplorer/#com.phoenix_int.ModelCenter.Variant/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-explorer.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getDataMonitor/#java.lang.String#com.phoenix_int.ModelCenter.Variant/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-data-monitor.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getFileSystemInfo/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-file-system-info.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getFormatter/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-formatter.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getFrame/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-frame.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getGlobalParameters/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-global-parameters.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getHaltStatus/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-halt-status.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getIsInteractive/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-is-interactive.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getLastErrorMessage/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-last-error-message.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getLicensingPath/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-licensing-path.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getLinks/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-links.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getLogger/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-logger.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getMacroScript/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-macro-script.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getMacroScriptLanguage/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-macro-script-language.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getModelCenterPath/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model-center-path.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getModelDirectory/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model-directory.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getModelFileName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-model-file-name.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getPreference/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-preference.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getProcessID/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-process-i-d.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getRunOnlyMode/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-run-only-mode.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getScreenUpdating/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-screen-updating.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getTradeStudyFilters/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-trade-study-filters.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-variable.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getVariableMetaData/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-variable-meta-data.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/getVersion/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/get-version.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/guiCloseAllMultiplexers/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/gui-close-all-multiplexers.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/guiLoadFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/gui-load-file.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/guiSaveModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/gui-save-model.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/halt/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/halt.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/hidePlugInFrame/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/hide-plug-in-frame.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/internalLicensing/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/internal-licensing.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/invokeHelp/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/invoke-help.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/isOkToClose/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/is-ok-to-close.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/launchDataCollectorPlugIn/#java.lang.String#com.phoenix_int.ModelCenter.DataExplorer/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-data-collector-plug-in.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/launchHTMLViewer/#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-h-t-m-l-viewer.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/launchMacroEditor/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-macro-editor.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/launchTradeStudy/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/launch-trade-study.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/loadFile/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/load-file.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/loadFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/load-file.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/loadModel/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/load-model.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/loadModel/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/load-model.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/moveComponent/#java.lang.String#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/move-component.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/newInstance/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/new-instance.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/newModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/new-model.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/newModel/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/new-model.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/parallelInstance/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/parallel-instance.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/release/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/release.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/removeComponent/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/remove-component.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/removeDataMonitor/#java.lang.String#com.phoenix_int.ModelCenter.Variant/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/remove-data-monitor.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/run/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/runAntFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run-ant-file.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/runMacro/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run-macro.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/runMacro2/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/run-macro2.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/saveModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-model.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/saveModelAs/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-model-as.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/saveTradeStudy/#java.lang.String#int#com.phoenix_int.ModelCenter.DataExplorer/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-trade-study.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/saveVersionedModel/#com.phoenix_int.ModelCenter.ModelCenter.VersionStatus#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-versioned-model.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/saveVersionedModelAs/#java.lang.String#com.phoenix_int.ModelCenter.ModelCenter.VersionStatus#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/save-versioned-model-as.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setAssemblyStyle/#java.lang.String#com.phoenix_int.ModelCenter.ModelCenter.AssemblyStyle#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-assembly-style.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setAssemblyStyle/#java.lang.String#com.phoenix_int.ModelCenter.ModelCenter.AssemblyStyle/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-assembly-style.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setIconPlugInFrame/#long#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-icon-plug-in-frame.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setLoginCallback/#com.phoenix_int.ModelCenter.ILoginCallback/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-login-callback.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setMacroScript/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-macro-script.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setMacroScriptLanguage/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-macro-script-language.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setPassword/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-password.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setPreference/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-preference.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setRunOnlyMode/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-run-only-mode.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setScheduler/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-scheduler.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setScreenUpdating/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-screen-updating.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setUserName/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-user-name.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/setValue/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/showFileBrowseDialog/#java.lang.String#java.lang.String[]#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-file-browse-dialog.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/showFileBrowseDialog/#java.lang.String#java.lang.String[]#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-file-browse-dialog.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/showFileSaveDialog/#java.lang.String#com.phoenix_int.ModelCenter.util.ValueHolder#java.lang.String#java.lang.String[]#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-file-save-dialog.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/showPlugInFrame/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/show-plug-in-frame.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/startGUIMode/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/start-g-u-i-mode.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/tradeStudyEnd/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/trade-study-end.md +$dokka.location:com.phoenix_int.ModelCenter/IModelCenter/tradeStudyStart/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-model-center/trade-study-start.md +$dokka.location:com.phoenix_int.ModelCenter/IPlugInMetaData///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/index.md +$dokka.location:com.phoenix_int.ModelCenter/IPlugInMetaData/getAuthor/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-author.md +$dokka.location:com.phoenix_int.ModelCenter/IPlugInMetaData/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-description.md +$dokka.location:com.phoenix_int.ModelCenter/IPlugInMetaData/getHelpURL/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-help-u-r-l.md +$dokka.location:com.phoenix_int.ModelCenter/IPlugInMetaData/getIconLocation/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-icon-location.md +$dokka.location:com.phoenix_int.ModelCenter/IPlugInMetaData/getKeywords/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-keywords.md +$dokka.location:com.phoenix_int.ModelCenter/IPlugInMetaData/getVersion/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-plug-in-meta-data/get-version.md +$dokka.location:com.phoenix_int.ModelCenter/IRunDataAction///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/index.md +$dokka.location:com.phoenix_int.ModelCenter/IRunDataAction/getComparisonInfoHTMLString/#long[]#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/get-comparison-info-h-t-m-l-string.md +$dokka.location:com.phoenix_int.ModelCenter/IRunDataAction/getRunInfoHTMLString/#long#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/get-run-info-h-t-m-l-string.md +$dokka.location:com.phoenix_int.ModelCenter/IRunDataAction/passHTMLEvent/#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/pass-h-t-m-l-event.md +$dokka.location:com.phoenix_int.ModelCenter/IRunDataAction/updateHighlight/#long#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-run-data-action/update-highlight.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobInfo///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/index.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobInfo/getNumRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-num-runs.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobInfo/getNumVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-num-variables.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobInfo/getVariableDisplayName/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-variable-display-name.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobInfo/getVariableEquation/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/get-variable-equation.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobInfo/isDesignVariable/#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/is-design-variable.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobInfo/isInput/#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-info/is-input.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/index.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/addVariable/#java.lang.String#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/add-variable.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/canNewJob/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/can-new-job.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/clear/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/clear.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/getDataHistory/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-data-history.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/getMetaDataProvider/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-meta-data-provider.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/getNumThreads/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-num-threads.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/getRunInParallel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-run-in-parallel.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/getSupportsParallelExecution/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-supports-parallel-execution.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/getValidateAll/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/get-validate-all.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/newJob/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/new-job.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/runJobAsync/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/run-job-async.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/setDataHistory/#com.phoenix_int.ModelCenter.DataHistory/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-data-history.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/setInput/#int#java.lang.Object#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-input.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/setNumThreads/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-num-threads.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/setRunInParallel/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-run-in-parallel.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/setRunInputs/#int#java.lang.Object[]#java.lang.Object[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-run-inputs.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/setValidateAll/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-validate-all.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobManager/setVariableInputs/#java.lang.Object#java.lang.Object[]#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-manager/set-variable-inputs.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobResult///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/index.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobResult/cancelAsync/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/cancel-async.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobResult/getDataHistory/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/get-data-history.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobResult/isCanceled/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/is-canceled.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobResult/isRunning/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/is-running.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudy3JobResult/waitForCompletion/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study3-job-result/wait-for-completion.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyCallback///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/index.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyCallback/dataCollectorCreated/#com.phoenix_int.ModelCenter.TradeStudy2#com.phoenix_int.ModelCenter.DataCollector/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/data-collector-created.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyCallback/runEnded/#com.phoenix_int.ModelCenter.TradeStudy2/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/run-ended.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyCallback/runStarting/#com.phoenix_int.ModelCenter.TradeStudy2/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/run-starting.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyCallback/tradeStudyClosed/#com.phoenix_int.ModelCenter.TradeStudy2/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-callback/trade-study-closed.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/index.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn/construct/#com.phoenix_int.ModelCenter.ModelCenter#com.phoenix_int.ModelCenter.AddToModel/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/construct.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn/fromString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/from-string.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn/show/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in/show.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn2///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/index.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn2/addAnalyzerVariable/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/add-analyzer-variable.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn2/clearAnalyzerVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/clear-analyzer-variables.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn2/getSaveAllAnalyzerVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/get-save-all-analyzer-variables.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn2/getTradeStudyCallback/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/get-trade-study-callback.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn2/onEnd/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/on-end.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn2/setSaveAllAnalyzerVariables/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/set-save-all-analyzer-variables.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn2/setTradeStudyCallback/#com.phoenix_int.ModelCenter.ITradeStudyCallback/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in2/set-trade-study-callback.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn3///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in3/index.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn3/getJobManager/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in3/get-job-manager.md +$dokka.location:com.phoenix_int.ModelCenter/ITradeStudyPlugIn3/setJobManager/#com.phoenix_int.ModelCenter.ITradeStudy3JobManager/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-trade-study-plug-in3/set-job-manager.md +$dokka.location:com.phoenix_int.ModelCenter/IVariableHolder///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/index.md +$dokka.location:com.phoenix_int.ModelCenter/IVariableHolder/getGroup/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-group.md +$dokka.location:com.phoenix_int.ModelCenter/IVariableHolder/getGroup/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-group.md +$dokka.location:com.phoenix_int.ModelCenter/IVariableHolder/getNumGroups/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-num-groups.md +$dokka.location:com.phoenix_int.ModelCenter/IVariableHolder/getNumVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-num-variables.md +$dokka.location:com.phoenix_int.ModelCenter/IVariableHolder/getVariable/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-variable.md +$dokka.location:com.phoenix_int.ModelCenter/IVariableHolder/getVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-holder/get-variable.md +$dokka.location:com.phoenix_int.ModelCenter/IVariableMetaDataProvider///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-meta-data-provider/index.md +$dokka.location:com.phoenix_int.ModelCenter/IVariableMetaDataProvider/getAllVariableMetaData/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-meta-data-provider/get-all-variable-meta-data.md +$dokka.location:com.phoenix_int.ModelCenter/IVariableMetaDataProvider/getVariableMetaData/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-i-variable-meta-data-provider/get-variable-meta-data.md +$dokka.location:com.phoenix_int.ModelCenter/IfComponent///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/index.md +$dokka.location:com.phoenix_int.ModelCenter/IfComponent/getBranchCondition/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/get-branch-condition.md +$dokka.location:com.phoenix_int.ModelCenter/IfComponent/getBranchName/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/get-branch-name.md +$dokka.location:com.phoenix_int.ModelCenter/IfComponent/getExclusive/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/get-exclusive.md +$dokka.location:com.phoenix_int.ModelCenter/IfComponent/getNumBranches/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/get-num-branches.md +$dokka.location:com.phoenix_int.ModelCenter/IfComponent/getRunLastBranchByDefault/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/get-run-last-branch-by-default.md +$dokka.location:com.phoenix_int.ModelCenter/IfComponent/renameBranch/#int#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/rename-branch.md +$dokka.location:com.phoenix_int.ModelCenter/IfComponent/setBranchCondition/#int#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/set-branch-condition.md +$dokka.location:com.phoenix_int.ModelCenter/IfComponent/setExclusive/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/set-exclusive.md +$dokka.location:com.phoenix_int.ModelCenter/IfComponent/setRunLastBranchByDefault/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-if-component/set-run-last-branch-by-default.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/index.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/clearLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/clear-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/clearUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/clear-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/fromFormattedString/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/from-formatted-string.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-description.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getEnumAliases/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-enum-aliases.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getFormat/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-format.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getUnits/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-units.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValue/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/getValueAbsolute/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/hasLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/has-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/hasUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/has-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-description.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setEnumAliases/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-enum-aliases.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setFormat/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-format.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setLowerBound/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setUnits/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-units.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setUpperBound/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/setValue/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/toFormattedString/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/to-formatted-string.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerArray/toFormattedStringAbsolute/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-array/to-formatted-string-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/index.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/clearLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/clear-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/clearUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/clear-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/fromFormattedString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/from-formatted-string.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-description.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/getEnumAliases/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-enum-aliases.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/getEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/getFormat/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-format.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/getLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/getUnits/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-units.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/getUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/getValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/getValueAbsolute/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/hasLowerBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/has-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/hasUpperBound/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/has-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-description.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/setEnumAliases/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-enum-aliases.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/setEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/setFormat/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-format.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/setLowerBound/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/setUnits/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-units.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/setUpperBound/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/setValue/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/toFormattedString/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/to-formatted-string.md +$dokka.location:com.phoenix_int.ModelCenter/IntegerVariable/toFormattedStringAbsolute/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-integer-variable/to-formatted-string-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/JavaObjectRepository///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/index.md +$dokka.location:com.phoenix_int.ModelCenter/JavaObjectRepository/JavaObjectRepository/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/-java-object-repository.md +$dokka.location:com.phoenix_int.ModelCenter/JavaObjectRepository/get/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/get.md +$dokka.location:com.phoenix_int.ModelCenter/JavaObjectRepository/getRunDataAction/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/get-run-data-action.md +$dokka.location:com.phoenix_int.ModelCenter/JavaObjectRepository/put/#java.lang.String#java.lang.Object#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/put.md +$dokka.location:com.phoenix_int.ModelCenter/JavaObjectRepository/release/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-java-object-repository/release.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/index.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/addInput/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/add-input.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/addOutput/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/add-output.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/addRerun/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/add-rerun.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/clearCache/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/clear-cache.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/enableCache/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/enable-cache.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/getInput/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-input.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/getInputLabel/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-input-label.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/getNumInputs/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-inputs.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/getNumOutputs/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-outputs.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/getNumRuns/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-runs.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/getNumThreads/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-num-threads.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/getOutput/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-output.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/getOutputLabel/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-output-label.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/getRunInParallel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-run-in-parallel.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/getRunIndex/#java.lang.String[]#java.lang.String[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-run-index.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/getValidateAll/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/get-validate-all.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/halt/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/halt.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/resume/#com.phoenix_int.ModelCenter.DataHistory/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/resume.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/setCustomMetadata/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-custom-metadata.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/setInput/#long#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-input.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/setNumRuns/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-num-runs.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/setNumThreads/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-num-threads.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/setRunInParallel/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-run-in-parallel.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/setValidateAll/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/set-validate-all.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/submit/#com.phoenix_int.ModelCenter.DataCollector#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/submit/#com.phoenix_int.ModelCenter.DataCollector#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/submit/#com.phoenix_int.ModelCenter.DataCollector/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/submit/#com.phoenix_int.ModelCenter.DataExplorer#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/submit/#com.phoenix_int.ModelCenter.DataExplorer#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/submit/#com.phoenix_int.ModelCenter.DataExplorer/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/submit/#com.phoenix_int.ModelCenter.DataHistory#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/submit/#com.phoenix_int.ModelCenter.DataHistory#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/submit/#com.phoenix_int.ModelCenter.DataHistory/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/submit.md +$dokka.location:com.phoenix_int.ModelCenter/JobManager/waitForJobCompletion/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-job-manager/wait-for-job-completion.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyle.AutoNSquared///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-auto-n-squared/index.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyle.Classic///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-classic/index.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyle.Collapsed///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-collapsed/index.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyle.Expanded///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-expanded/index.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyle.NSquared///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/-n-squared/index.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyle///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/index.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyle/valueOf/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/value-of.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyle/values/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style/values.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyleInfo///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/index.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyleInfo/height/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/height.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyleInfo/style/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/style.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.AssemblyStyleInfo/width/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-assembly-style-info/width.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.VersionStatus.DoNotVersion///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/-do-not-version/index.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.VersionStatus.DoVersioning///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/-do-versioning/index.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.VersionStatus.DoVersioningIfPossible///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/-do-versioning-if-possible/index.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.VersionStatus///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/index.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.VersionStatus/valueOf/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/value-of.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter.VersionStatus/values/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-version-status/values.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/index.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/ASSEMBLY_TYPE_ASSEMBLY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-a-s-s-e-m-b-l-y.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/ASSEMBLY_TYPE_FOR_EACH/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-f-o-r_-e-a-c-h.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/ASSEMBLY_TYPE_IF/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-i-f.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/ASSEMBLY_TYPE_PARALLEL/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-p-a-r-a-l-l-e-l.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/ASSEMBLY_TYPE_SEQUENCE/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-a-s-s-e-m-b-l-y_-t-y-p-e_-s-e-q-u-e-n-c-e.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/CONN_ERR_ERROR/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-c-o-n-n_-e-r-r_-e-r-r-o-r.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/CONN_ERR_IGNORE/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-c-o-n-n_-e-r-r_-i-g-n-o-r-e.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/CONN_ERR_USEDIALOG/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-c-o-n-n_-e-r-r_-u-s-e-d-i-a-l-o-g.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/HTMLViewerWaitForClose/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-h-t-m-l-viewer-wait-for-close.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/MODEL_TYPE_DATA/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-m-o-d-e-l_-t-y-p-e_-d-a-t-a.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/MODEL_TYPE_PROCESS/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-m-o-d-e-l_-t-y-p-e_-p-r-o-c-e-s-s.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/MessageBox/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-message-box.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/ModelCenter/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-model-center.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/ModelCenter/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-model-center.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/ModelCenter/#long#javax.swing.JFrame#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-model-center.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/ModelCenter/#long#javax.swing.JFrame/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/-model-center.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/addIcon/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/add-icon.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/addNewMacro/#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/add-new-macro.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/allowBringWindowToFront/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/allow-bring-window-to-front.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/autoLink/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/auto-link.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/breakLink/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/break-link.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/checkout/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/checkout.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/checkout2/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/checkout2.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/close/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/close.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/closeHTMLViewer/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/close-h-t-m-l-viewer.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/closeModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/close-model.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createAndInitComponent/#java.lang.String#java.lang.String#java.lang.String#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-and-init-component.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createAssembly/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-assembly.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createAssembly/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-assembly.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createAssemblyVariable/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-assembly-variable.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createComponent/#java.lang.String#java.lang.String#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-component.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createComponent/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-component.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createDataCollector/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-collector.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createDataExplorer/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-explorer.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createDataHistoryVariable/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-history-variable.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createDataMonitor/#java.lang.String#java.lang.String#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-data-monitor.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createJobManager/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-job-manager.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createJobManager/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-job-manager.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createJobManager/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-job-manager.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createLink/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-link.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createPlugInFrame/#java.lang.String#java.lang.String#java.lang.String#long#java.awt.Container#boolean#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-plug-in-frame.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createPlugInFrame/#java.lang.String#java.lang.String#java.lang.String#long#java.awt.Container#boolean#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-plug-in-frame.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createPlugInFrame/#java.lang.String#java.lang.String#java.lang.String#long#java.awt.Container#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-plug-in-frame.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createPlugInFrame/#java.lang.String#java.lang.String#java.lang.String#long#java.awt.Container/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-plug-in-frame.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/createTradeStudy/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/create-trade-study.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/destroyPlugInFrame/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/destroy-plug-in-frame.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/dumpComDebug/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/dump-com-debug.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getActiveJobManager/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-active-job-manager.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getAppName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-app-name.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getAssembly/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-assembly.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getAssemblyStyle/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-assembly-style.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getComponent/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-component.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getDataCollector/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-collector.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getDataCollectorForDataExplorer/#com.phoenix_int.ModelCenter.DataExplorer/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-collector-for-data-explorer.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getDataExplorer/#com.phoenix_int.ModelCenter.Variant/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-explorer.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getDataMonitor/#java.lang.String#com.phoenix_int.ModelCenter.Variant/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-data-monitor.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getFileSystemInfo/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-file-system-info.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getFormatter/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-formatter.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getFrame/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-frame.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getGlobalParameters/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-global-parameters.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getHaltStatus/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-halt-status.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getIsInteractive/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-is-interactive.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getLastErrorMessage/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-last-error-message.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getLicensingPath/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-licensing-path.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getLinks/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-links.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getLogger/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-logger.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getMacroScript/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-macro-script.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getMacroScriptLanguage/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-macro-script-language.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getMacroTimeout/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-macro-timeout.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getModelCenterPath/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model-center-path.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getModelDirectory/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model-directory.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getModelFileName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-model-file-name.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getPreference/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-preference.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getProcessID/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-process-i-d.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getRunOnlyMode/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-run-only-mode.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getScreenUpdating/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-screen-updating.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getTradeStudyFilters/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-trade-study-filters.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-variable.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getVariableMetaData/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-variable-meta-data.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getVersion/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-version.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/getXMLExtension/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/get-x-m-l-extension.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/guiCloseAllMultiplexers/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/gui-close-all-multiplexers.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/guiLoadFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/gui-load-file.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/guiSaveModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/gui-save-model.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/halt/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/halt.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/hidePlugInFrame/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/hide-plug-in-frame.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/internalLicensing/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/internal-licensing.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/invokeHelp/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/invoke-help.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/isOkToClose/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/is-ok-to-close.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/launchDataCollectorPlugIn/#java.lang.String#com.phoenix_int.ModelCenter.DataExplorer/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-data-collector-plug-in.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/launchHTMLViewer/#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-h-t-m-l-viewer.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/launchMacroEditor/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-macro-editor.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/launchTradeStudy/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/launch-trade-study.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/loadFile/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/load-file.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/loadFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/load-file.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/loadModel/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/load-model.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/loadModel/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/load-model.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/moveComponent/#java.lang.String#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/move-component.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/newInstance/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/new-instance.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/newModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/new-model.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/newModel/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/new-model.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/parallelInstance/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/parallel-instance.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/removeComponent/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/remove-component.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/removeDataMonitor/#java.lang.String#com.phoenix_int.ModelCenter.Variant/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/remove-data-monitor.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/run/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/run.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/runAntFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/run-ant-file.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/runMacro/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/run-macro.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/runMacro2/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/run-macro2.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/saveModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/save-model.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/saveModelAs/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/save-model-as.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/saveTradeStudy/#java.lang.String#int#com.phoenix_int.ModelCenter.DataExplorer/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/save-trade-study.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/saveVersionedModel/#com.phoenix_int.ModelCenter.ModelCenter.VersionStatus#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/save-versioned-model.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/saveVersionedModelAs/#java.lang.String#com.phoenix_int.ModelCenter.ModelCenter.VersionStatus#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/save-versioned-model-as.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setAssemblyStyle/#java.lang.String#com.phoenix_int.ModelCenter.ModelCenter.AssemblyStyle#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-assembly-style.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setAssemblyStyle/#java.lang.String#com.phoenix_int.ModelCenter.ModelCenter.AssemblyStyle/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-assembly-style.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setIconPlugInFrame/#long#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-icon-plug-in-frame.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setLoginCallback/#com.phoenix_int.ModelCenter.ILoginCallback/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-login-callback.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setMacroScript/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-macro-script.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setMacroScriptLanguage/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-macro-script-language.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setMacroTimeout/#java.lang.String#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-macro-timeout.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setPassword/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-password.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setPreference/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-preference.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setRunOnlyMode/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-run-only-mode.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setScheduler/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-scheduler.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setScreenUpdating/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-screen-updating.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setUserName/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-user-name.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setValue/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/setXMLExtension/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/set-x-m-l-extension.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/showFileBrowseDialog/#java.lang.String#java.lang.String[]#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/show-file-browse-dialog.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/showFileBrowseDialog/#java.lang.String#java.lang.String[]#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/show-file-browse-dialog.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/showFileSaveDialog/#java.lang.String#com.phoenix_int.ModelCenter.util.ValueHolder#java.lang.String#java.lang.String[]#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/show-file-save-dialog.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/showPlugInFrame/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/show-plug-in-frame.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/startGUIMode/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/start-g-u-i-mode.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/tradeStudyEnd/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/trade-study-end.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenter/tradeStudyStart/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center/trade-study-start.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenterException///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center-exception/index.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenterException/ModelCenterException/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center-exception/-model-center-exception.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenterException/ModelCenterException/#java.lang.String#java.lang.Throwable/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center-exception/-model-center-exception.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenterException/ModelCenterException/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center-exception/-model-center-exception.md +$dokka.location:com.phoenix_int.ModelCenter/ModelCenterException/ModelCenterException/#java.lang.Throwable/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-model-center-exception/-model-center-exception.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/index.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/callMethod/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/call-method.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/deleteAllMembers/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/delete-all-members.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/deleteMember/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/delete-member.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/fromFile/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/from-file.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/fromXML/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/from-x-m-l.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getBooleanArrayMemberValue/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-array-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getBooleanArrayMemberValue/#java.lang.String#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-array-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getBooleanArrayMemberValueAbsolute/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-array-member-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getBooleanArrayMemberValueAbsolute/#java.lang.String#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-array-member-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getBooleanMemberValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getBooleanMemberValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-boolean-member-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getClassURL/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-class-u-r-l.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-description.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getDoubleArrayMemberValue/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-array-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getDoubleArrayMemberValue/#java.lang.String#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-array-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getDoubleArrayMemberValueAbsolute/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-array-member-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getDoubleArrayMemberValueAbsolute/#java.lang.String#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-array-member-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getDoubleMemberValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getDoubleMemberValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-double-member-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getFileExtension/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getFileName/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-file-name.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getIndexStr/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-index-str.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getIndexStr/#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-index-str.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getIntArrayMemberValue/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-array-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getIntArrayMemberValue/#java.lang.String#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-array-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getIntArrayMemberValueAbsolute/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-array-member-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getIntArrayMemberValueAbsolute/#java.lang.String#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-array-member-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getIntMemberValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getIntMemberValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-int-member-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getIsBinary/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-is-binary.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-description.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberDimensions/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberEnumAliases/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-enum-aliases.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberIndex/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-index.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberLength/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-length.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberList/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-list.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberLowerBound/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberNumDimensions/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-num-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberProperty/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-property.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberType/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-type.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberUnits/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-units.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberUpperBound/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberValueAbsoluteAsString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-value-absolute-as-string.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMemberValueAsString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-member-value-as-string.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getMethodList/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-method-list.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getStringArrayMemberValue/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-array-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getStringArrayMemberValue/#java.lang.String#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-array-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getStringArrayMemberValueAbsolute/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-array-member-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getStringArrayMemberValueAbsolute/#java.lang.String#int[]/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-array-member-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getStringMemberValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/getStringMemberValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/get-string-member-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/hasMember/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/has-member.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/hasMemberLowerBound/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/has-member-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/hasMemberUpperBound/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/has-member-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/isNonStrictType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/is-non-strict-type.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/isNumericMember/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/is-numeric-member.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/reinitialize/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/reinitialize.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setBooleanArrayMemberValue/#java.lang.String#int#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-boolean-array-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setBooleanArrayMemberValue/#java.lang.String#int[]#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-boolean-array-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setBooleanMemberValue/#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-boolean-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-description.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setDoubleArrayMemberValue/#java.lang.String#int#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-double-array-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setDoubleArrayMemberValue/#java.lang.String#int[]#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-double-array-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setDoubleMemberValue/#java.lang.String#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-double-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setFileExtension/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-file-extension.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setFileName/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-file-name.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setIntArrayMemberValue/#java.lang.String#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-int-array-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setIntArrayMemberValue/#java.lang.String#int[]#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-int-array-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setIntMemberValue/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-int-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setIsBinary/#java.lang.String#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-is-binary.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDescription/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-description.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberDimensions/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-dimensions.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberEnumAliases/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-enum-aliases.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberEnumValues/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberFromString/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-from-string.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberLength/#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-length.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberLowerBound/#java.lang.String#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-lower-bound.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberProperty/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-property.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberUnits/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-units.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberUpperBound/#java.lang.String#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-upper-bound.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setMemberValueFromString/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-member-value-from-string.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setStringArrayMemberValue/#java.lang.String#int#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-string-array-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setStringArrayMemberValue/#java.lang.String#int[]#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-string-array-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/setStringMemberValue/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/set-string-member-value.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/toFile/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/to-file.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/toFileAbsolute/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/to-file-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/ObjectVariable/toXML/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-object-variable/to-x-m-l.md +$dokka.location:com.phoenix_int.ModelCenter/PHXJavaComObjectStored///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-p-h-x-java-com-object-stored/index.md +$dokka.location:com.phoenix_int.ModelCenter/PHXJavaComObjectStored/releaseCOMObjects/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-p-h-x-java-com-object-stored/release-c-o-m-objects.md +$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/index.md +$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-description.md +$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/getEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/getIsInput/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-is-input.md +$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/getName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-name.md +$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/getTitle/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-title.md +$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/getType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/get-type.md +$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-description.md +$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/setEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/setIsInput/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-is-input.md +$dokka.location:com.phoenix_int.ModelCenter/RefArrayProp/setTitle/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-array-prop/set-title.md +$dokka.location:com.phoenix_int.ModelCenter/RefProp///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/index.md +$dokka.location:com.phoenix_int.ModelCenter/RefProp/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-description.md +$dokka.location:com.phoenix_int.ModelCenter/RefProp/getEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/RefProp/getIsInput/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-is-input.md +$dokka.location:com.phoenix_int.ModelCenter/RefProp/getName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-name.md +$dokka.location:com.phoenix_int.ModelCenter/RefProp/getTitle/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-title.md +$dokka.location:com.phoenix_int.ModelCenter/RefProp/getType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/get-type.md +$dokka.location:com.phoenix_int.ModelCenter/RefProp/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-description.md +$dokka.location:com.phoenix_int.ModelCenter/RefProp/setEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/RefProp/setIsInput/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-is-input.md +$dokka.location:com.phoenix_int.ModelCenter/RefProp/setTitle/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-ref-prop/set-title.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/index.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/createRefProp/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/create-ref-prop.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/getNumReferencedVariables/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-num-referenced-variables.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/getRefPropValue/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-ref-prop-value.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/getRefPropValueAbsolute/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-ref-prop-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/getReference/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-reference.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/getReferencedVariable/#int#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-referenced-variable.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/getReferencedVariable/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-referenced-variable.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/getValue/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/getValueAbsolute/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/setRefPropValue/#java.lang.String#int#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/set-ref-prop-value.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/setReference/#java.lang.String#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/set-reference.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceArray/setValue/#double#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/index.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/createRefProp/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/create-ref-prop.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/getNumReferencedVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-num-referenced-variables.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/getRefPropValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-ref-prop-value.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/getRefPropValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-ref-prop-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/getReference/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-reference.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/getReferencedVariable/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-referenced-variable.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/getReferencedVariable/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-referenced-variable.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/getValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/setRefPropValue/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/set-ref-prop-value.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/setReference/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/set-reference.md +$dokka.location:com.phoenix_int.ModelCenter/ReferenceVariable/setValue/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-reference-variable/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/SaveContext///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-save-context/index.md +$dokka.location:com.phoenix_int.ModelCenter/SaveContext/close/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-save-context/close.md +$dokka.location:com.phoenix_int.ModelCenter/SaveContext/getSaveLocation/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-save-context/get-save-location.md +$dokka.location:com.phoenix_int.ModelCenter/SaveContext/restoreFile/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-save-context/restore-file.md +$dokka.location:com.phoenix_int.ModelCenter/SaveContext/restoreFileStream/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-save-context/restore-file-stream.md +$dokka.location:com.phoenix_int.ModelCenter/SaveContext/saveFile/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-save-context/save-file.md +$dokka.location:com.phoenix_int.ModelCenter/SaveContext/saveFileStream/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-save-context/save-file-stream.md +$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/index.md +$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/addVariable/#java.lang.String#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/add-variable.md +$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/getForwardSchedule/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/get-forward-schedule.md +$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/getLanguage/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/get-language.md +$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/getPrevalidate/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/get-prevalidate.md +$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/getSourceScript/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/get-source-script.md +$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/getTimeout/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/get-timeout.md +$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/removeVariable/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/remove-variable.md +$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/setForwardSchedule/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/set-forward-schedule.md +$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/setLanguage/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/set-language.md +$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/setPrevalidate/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/set-prevalidate.md +$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/setSourceFromFile/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/set-source-from-file.md +$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/setSourceFromString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/set-source-from-string.md +$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/setTimeout/#double/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/set-timeout.md +$dokka.location:com.phoenix_int.ModelCenter/ScriptComponent/setVariables/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-script-component/set-variables.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/index.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-description.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getEnumAliases/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-enum-aliases.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValue/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/getValueAbsolute/#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-description.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/setEnumAliases/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-enum-aliases.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/setEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringArray/setValue/#java.lang.String#long/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-array/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringVariable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/index.md +$dokka.location:com.phoenix_int.ModelCenter/StringVariable/getDescription/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-description.md +$dokka.location:com.phoenix_int.ModelCenter/StringVariable/getEnumAliases/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-enum-aliases.md +$dokka.location:com.phoenix_int.ModelCenter/StringVariable/getEnumValues/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/StringVariable/getValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/StringVariable/getValueAbsolute/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/get-value-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/StringVariable/setDescription/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-description.md +$dokka.location:com.phoenix_int.ModelCenter/StringVariable/setEnumAliases/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-enum-aliases.md +$dokka.location:com.phoenix_int.ModelCenter/StringVariable/setEnumValues/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-enum-values.md +$dokka.location:com.phoenix_int.ModelCenter/StringVariable/setValue/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-string-variable/set-value.md +$dokka.location:com.phoenix_int.ModelCenter/TradeStudy///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study/index.md +$dokka.location:com.phoenix_int.ModelCenter/TradeStudy/fromString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study/from-string.md +$dokka.location:com.phoenix_int.ModelCenter/TradeStudy/show/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study/show.md +$dokka.location:com.phoenix_int.ModelCenter/TradeStudy/toString/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study/to-string.md +$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/index.md +$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/addAnalyzerVariable/#java.lang.String#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/add-analyzer-variable.md +$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/clearAnalyzerVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/clear-analyzer-variables.md +$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/fromString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/from-string.md +$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/getSaveAllAnalyzerVariables/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/get-save-all-analyzer-variables.md +$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/getTradeStudyCallback/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/get-trade-study-callback.md +$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/onEnd/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/on-end.md +$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/setSaveAllAnalyzerVariables/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/set-save-all-analyzer-variables.md +$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/setTradeStudyCallback/#com.phoenix_int.ModelCenter.ITradeStudyCallback/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/set-trade-study-callback.md +$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/show/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/show.md +$dokka.location:com.phoenix_int.ModelCenter/TradeStudy2/toString/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study2/to-string.md +$dokka.location:com.phoenix_int.ModelCenter/TradeStudy3///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study3/index.md +$dokka.location:com.phoenix_int.ModelCenter/TradeStudy3/getJobManager/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study3/get-job-manager.md +$dokka.location:com.phoenix_int.ModelCenter/TradeStudy3/setJobManager/#com.phoenix_int.ModelCenter.ITradeStudy3JobManager/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-trade-study3/set-job-manager.md +$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataAccess.Private///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/-private/index.md +$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataAccess.Public///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/-public/index.md +$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataAccess.ReadOnly///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/-read-only/index.md +$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataAccess///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/index.md +$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataAccess/value/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/value.md +$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataAccess/valueOf/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/value-of.md +$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataAccess/values/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-access/values.md +$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataType.Boolean///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-boolean/index.md +$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataType.Double///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-double/index.md +$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataType.Long///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-long/index.md +$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataType.String///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-string/index.md +$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataType.Xml///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/-xml/index.md +$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataType///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/index.md +$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataType/value/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/value.md +$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataType/valueOf/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/value-of.md +$dokka.location:com.phoenix_int.ModelCenter/Variable.MetadataType/values/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/-metadata-type/values.md +$dokka.location:com.phoenix_int.ModelCenter/Variable///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/index.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/dependentLinks/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/dependent-links.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/fromString/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/from-string.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/getDirectDependents/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-direct-dependents.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/getDirectDependents/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-direct-dependents.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/getDirectPrecedents/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-direct-precedents.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/getDirectPrecedents/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-direct-precedents.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/getFullName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-full-name.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/getHasChanged/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-has-changed.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/getHide/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-hide.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/getMetadata/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-metadata.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/getName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-name.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/getOwningComponent/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-owning-component.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/getType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/get-type.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/invalidate/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/invalidate.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/isInput/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/is-input.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/isInputToComponent/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/is-input-to-component.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/isInputToModel/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/is-input-to-model.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/isValid/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/is-valid.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/precedentLinks/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/precedent-links.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/setHasChanged/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/set-has-changed.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/setHide/#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/set-hide.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/setMetadata/#java.lang.String#com.phoenix_int.ModelCenter.Variable.MetadataType#java.lang.Object#com.phoenix_int.ModelCenter.Variable.MetadataAccess#boolean/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/set-metadata.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/toString/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/to-string.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/toStringAbsolute/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/to-string-absolute.md +$dokka.location:com.phoenix_int.ModelCenter/Variable/validate/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable/validate.md +$dokka.location:com.phoenix_int.ModelCenter/VariableDescription///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/index.md +$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/INPUT/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/-i-n-p-u-t.md +$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/OUTPUT/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/-o-u-t-p-u-t.md +$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/getEquation/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-equation.md +$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/getFullName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-full-name.md +$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/getName/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-name.md +$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/getState/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-state.md +$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/getType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-type.md +$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/getUnits/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/get-units.md +$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/isCustom/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/is-custom.md +$dokka.location:com.phoenix_int.ModelCenter/VariableDescription/isNumeric/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-description/is-numeric.md +$dokka.location:com.phoenix_int.ModelCenter/VariableLink///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-link/index.md +$dokka.location:com.phoenix_int.ModelCenter/VariableLink/breakLink/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-link/break-link.md +$dokka.location:com.phoenix_int.ModelCenter/VariableLink/getLHS/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-link/get-l-h-s.md +$dokka.location:com.phoenix_int.ModelCenter/VariableLink/getRHS/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-link/get-r-h-s.md +$dokka.location:com.phoenix_int.ModelCenter/VariableLink/resumeLink/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-link/resume-link.md +$dokka.location:com.phoenix_int.ModelCenter/VariableLink/suspendLink/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-link/suspend-link.md +$dokka.location:com.phoenix_int.ModelCenter/VariableLinks///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-links/index.md +$dokka.location:com.phoenix_int.ModelCenter/VariableLinks/getCount/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-links/get-count.md +$dokka.location:com.phoenix_int.ModelCenter/VariableLinks/getItem/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-links/get-item.md +$dokka.location:com.phoenix_int.ModelCenter/VariableLinks/getItem/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-links/get-item.md +$dokka.location:com.phoenix_int.ModelCenter/VariableLinks/hasNext/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-links/has-next.md +$dokka.location:com.phoenix_int.ModelCenter/VariableLinks/next/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-links/next.md +$dokka.location:com.phoenix_int.ModelCenter/VariableLinks/remove/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-links/remove.md +$dokka.location:com.phoenix_int.ModelCenter/VariableLinks/resetIterator/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-links/reset-iterator.md +$dokka.location:com.phoenix_int.ModelCenter/VariableMetaDataProvider///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-meta-data-provider/index.md +$dokka.location:com.phoenix_int.ModelCenter/VariableMetaDataProvider/getAllVariableMetaData/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-meta-data-provider/get-all-variable-meta-data.md +$dokka.location:com.phoenix_int.ModelCenter/VariableMetaDataProvider/getVariableMetaData/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variable-meta-data-provider/get-variable-meta-data.md +$dokka.location:com.phoenix_int.ModelCenter/Variables///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variables/index.md +$dokka.location:com.phoenix_int.ModelCenter/Variables/getCount/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variables/get-count.md +$dokka.location:com.phoenix_int.ModelCenter/Variables/getItem/#int/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variables/get-item.md +$dokka.location:com.phoenix_int.ModelCenter/Variables/getItem/#java.lang.String/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variables/get-item.md +$dokka.location:com.phoenix_int.ModelCenter/Variables/hasNext/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variables/has-next.md +$dokka.location:com.phoenix_int.ModelCenter/Variables/next/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variables/next.md +$dokka.location:com.phoenix_int.ModelCenter/Variables/remove/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variables/remove.md +$dokka.location:com.phoenix_int.ModelCenter/Variables/resetIterator/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variables/reset-iterator.md +$dokka.location:com.phoenix_int.ModelCenter/Variant///PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/index.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/BOOLEAN/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-b-o-o-l-e-a-n.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/BOOLEAN_ARRAY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-b-o-o-l-e-a-n_-a-r-r-a-y.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/DISPATCH/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-d-i-s-p-a-t-c-h.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/DOUBLE/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-d-o-u-b-l-e.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/DOUBLE_ARRAY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-d-o-u-b-l-e_-a-r-r-a-y.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/INT/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-i-n-t.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/INT_ARRAY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-i-n-t_-a-r-r-a-y.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/LONG/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-l-o-n-g.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/LONG_ARRAY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-l-o-n-g_-a-r-r-a-y.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/REFERENCE/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-r-e-f-e-r-e-n-c-e.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/STRING/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-s-t-r-i-n-g.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/STRING_ARRAY/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-s-t-r-i-n-g_-a-r-r-a-y.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/UNKNOWN/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-u-n-k-n-o-w-n.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/Variant/#int#java.lang.Object/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/-variant.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/booleanArrayValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/boolean-array-value.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/booleanValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/boolean-value.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/doubleArrayValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/double-array-value.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/doubleValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/double-value.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/getType/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/get-type.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/getValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/get-value.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/intArrayValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/int-array-value.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/intValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/int-value.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/longArrayValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/long-array-value.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/longValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/long-value.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/stringArrayValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/string-array-value.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/stringValue/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/string-value.md +$dokka.location:com.phoenix_int.ModelCenter/Variant/toString/#/PointingToDeclaration/mc_api/com.phoenix_int.ModelCenter/-variant/to-string.md +com.phoenix_int.ModelCenter +com.phoenix_int.ModelCenter.Geometry +com.phoenix_int.ModelCenter.logging +com.phoenix_int.ModelCenter.util +